@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface ObjectFieldLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
ObjectFieldLocalServiceUtil
Modifier and Type | Method and Description |
---|---|
ObjectField |
addCustomObjectField(java.lang.String externalReferenceCode,
long userId,
long listTypeDefinitionId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
boolean localized,
java.lang.String name,
boolean required,
boolean state,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
ObjectField |
addObjectField(ObjectField objectField)
Adds the object field to the database.
|
ObjectField |
addOrUpdateCustomObjectField(java.lang.String externalReferenceCode,
long objectFieldId,
long userId,
long listTypeDefinitionId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
boolean localized,
java.lang.String name,
boolean required,
boolean state,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
ObjectField |
addOrUpdateSystemObjectField(long userId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbColumnName,
java.lang.String dbTableName,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
boolean required,
boolean state) |
ObjectField |
addSystemObjectField(long userId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbColumnName,
java.lang.String dbTableName,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
java.lang.String name,
boolean required,
boolean state) |
ObjectField |
createObjectField(long objectFieldId)
Creates a new object field with the primary key.
|
com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
ObjectField |
deleteObjectField(long objectFieldId)
Deletes the object field with the primary key from the database.
|
ObjectField |
deleteObjectField(ObjectField objectField)
Deletes the object field from the database.
|
void |
deleteObjectFieldByObjectDefinitionId(java.lang.Long objectDefinitionId) |
com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
ObjectField |
deleteRelationshipTypeObjectField(long objectFieldId) |
<T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end)
Performs a dynamic query on the database and returns a range of the matching rows.
|
<T> java.util.List<T> |
dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Performs a dynamic query on the database and returns an ordered range of the matching rows.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection)
Returns the number of rows matching the dynamic query.
|
ObjectField |
fetchObjectField(long objectFieldId) |
ObjectField |
fetchObjectField(long objectDefinitionId,
java.lang.String name) |
ObjectField |
fetchObjectField(java.lang.String externalReferenceCode,
long objectDefinitionId) |
ObjectField |
fetchObjectFieldByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object field with the matching UUID and company.
|
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
java.util.List<ObjectField> |
getActiveObjectFields(java.util.List<ObjectField> objectFields) |
com.liferay.petra.sql.dsl.Column<?,?> |
getColumn(long objectDefinitionId,
java.lang.String name) |
java.util.List<ObjectField> |
getCustomObjectFields(long objectFieldId) |
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
java.util.List<ObjectField> |
getListTypeDefinitionObjectFields(long listTypeDefinitionId,
boolean state) |
ObjectField |
getObjectField(long objectFieldId)
Returns the object field with the primary key.
|
ObjectField |
getObjectField(long objectDefinitionId,
java.lang.String name) |
ObjectField |
getObjectFieldByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the object field with the matching UUID and company.
|
java.util.List<ObjectField> |
getObjectFields(int start,
int end)
Returns a range of all the object fields.
|
java.util.List<ObjectField> |
getObjectFields(long objectDefinitionId) |
java.util.List<ObjectField> |
getObjectFields(long objectDefinitionId,
boolean system) |
java.util.List<ObjectField> |
getObjectFields(long objectDefinitionId,
java.lang.String dbTableName) |
int |
getObjectFieldsCount()
Returns the number of object fields.
|
int |
getObjectFieldsCount(long objectDefinitionId) |
int |
getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId) |
java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
com.liferay.petra.sql.dsl.Table |
getTable(long objectDefinitionId,
java.lang.String name) |
ObjectField |
updateCustomObjectField(java.lang.String externalReferenceCode,
long objectFieldId,
long listTypeDefinitionId,
java.lang.String businessType,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
boolean localized,
java.lang.String name,
boolean required,
boolean state,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
ObjectField |
updateObjectField(ObjectField objectField)
Updates the object field in the database or adds it if it does not yet exist.
|
ObjectField |
updateObjectField(java.lang.String externalReferenceCode,
long objectFieldId,
long userId,
long listTypeDefinitionId,
long objectDefinitionId,
java.lang.String businessType,
java.lang.String dbColumnName,
java.lang.String dbTableName,
java.lang.String dbType,
boolean indexed,
boolean indexedAsKeyword,
java.lang.String indexedLanguageId,
java.util.Map<java.util.Locale,java.lang.String> labelMap,
boolean localized,
java.lang.String name,
boolean required,
boolean state,
boolean system,
java.util.List<ObjectFieldSetting> objectFieldSettings) |
ObjectField |
updateRequired(long objectFieldId,
boolean required) |
@Indexable(type=REINDEX) ObjectField addCustomObjectField(java.lang.String externalReferenceCode, long userId, long listTypeDefinitionId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, boolean localized, java.lang.String name, boolean required, boolean state, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField addObjectField(ObjectField objectField)
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object field@Indexable(type=REINDEX) ObjectField addOrUpdateCustomObjectField(java.lang.String externalReferenceCode, long objectFieldId, long userId, long listTypeDefinitionId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, boolean localized, java.lang.String name, boolean required, boolean state, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField addOrUpdateSystemObjectField(long userId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbColumnName, java.lang.String dbTableName, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, boolean required, boolean state) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField addSystemObjectField(long userId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbColumnName, java.lang.String dbTableName, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, java.lang.String name, boolean required, boolean state) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(enabled=false) ObjectField createObjectField(long objectFieldId)
objectFieldId
- the primary key for the new object fieldcom.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
createPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) ObjectField deleteObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectFieldId
- the primary key of the object fieldcom.liferay.portal.kernel.exception.PortalException
- if a object field with the primary key could not be found@Indexable(type=DELETE) @SystemEvent(type=1) ObjectField deleteObjectField(ObjectField objectField) throws com.liferay.portal.kernel.exception.PortalException
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object fieldcom.liferay.portal.kernel.exception.PortalException
void deleteObjectFieldByObjectDefinitionId(java.lang.Long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
deletePersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=DELETE) ObjectField deleteRelationshipTypeObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQuery
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
dslQueryCount
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(long objectFieldId)
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(long objectDefinitionId, java.lang.String name)
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(java.lang.String externalReferenceCode, long objectDefinitionId)
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectFieldByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the object field's UUIDcompanyId
- the primary key of the companynull
if a matching object field could not be found@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getActiveObjectFields(java.util.List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.petra.sql.dsl.Column<?,?> getColumn(long objectDefinitionId, java.lang.String name)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getCustomObjectFields(long objectFieldId)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getListTypeDefinitionObjectFields(long listTypeDefinitionId, boolean state)
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
objectFieldId
- the primary key of the object fieldcom.liferay.portal.kernel.exception.PortalException
- if a object field with the primary key could not be found@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectField(long objectDefinitionId, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectFieldByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the object field's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching object field could not be found@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getObjectFields(int start, int end)
Useful when paginating results. Returns a maximum of end - start
instances. start
and end
are not primary keys, they are indexes in the result set. Thus, 0
refers to the first result in the set. Setting both start
and end
to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. If orderByComparator
is specified, then the query will include the given ORDER BY logic. If orderByComparator
is absent, then the query will include the default ORDER BY logic from com.liferay.object.model.impl.ObjectFieldModelImpl
.
start
- the lower bound of the range of object fieldsend
- the upper bound of the range of object fields (not inclusive)@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getObjectFields(long objectDefinitionId)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getObjectFields(long objectDefinitionId, boolean system)
@Transactional(propagation=SUPPORTS, readOnly=true) java.util.List<ObjectField> getObjectFields(long objectDefinitionId, java.lang.String dbTableName)
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCount()
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCount(long objectDefinitionId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId)
java.lang.String getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
getPersistedModel
in interface com.liferay.portal.kernel.service.PersistedModelLocalService
com.liferay.portal.kernel.exception.PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.petra.sql.dsl.Table getTable(long objectDefinitionId, java.lang.String name) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField updateCustomObjectField(java.lang.String externalReferenceCode, long objectFieldId, long listTypeDefinitionId, java.lang.String businessType, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, boolean localized, java.lang.String name, boolean required, boolean state, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField updateObjectField(ObjectField objectField)
Important: Inspect ObjectFieldLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
objectField
- the object fieldObjectField updateObjectField(java.lang.String externalReferenceCode, long objectFieldId, long userId, long listTypeDefinitionId, long objectDefinitionId, java.lang.String businessType, java.lang.String dbColumnName, java.lang.String dbTableName, java.lang.String dbType, boolean indexed, boolean indexedAsKeyword, java.lang.String indexedLanguageId, java.util.Map<java.util.Locale,java.lang.String> labelMap, boolean localized, java.lang.String name, boolean required, boolean state, boolean system, java.util.List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
@Indexable(type=REINDEX) ObjectField updateRequired(long objectFieldId, boolean required) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException