Interface ObjectFieldLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
ObjectFieldLocalServiceWrapper

@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
Provides the local service interface for ObjectField. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.
See Also:
Generated:
  • Method Details

    • addCustomObjectField

      @Indexable(type=REINDEX) ObjectField addCustomObjectField(String externalReferenceCode, long userId, long listTypeDefinitionId, long objectDefinitionId, String businessType, String dbType, boolean indexed, boolean indexedAsKeyword, String indexedLanguageId, Map<Locale,String> labelMap, boolean localized, String name, String readOnly, String readOnlyConditionExpression, boolean required, boolean state, List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectField

      @Indexable(type=REINDEX) ObjectField addObjectField(ObjectField objectField)
      Adds the object field to the database. Also notifies the appropriate model listeners.

      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.

      Parameters:
      objectField - the object field
      Returns:
      the object field that was added
    • addOrUpdateCustomObjectField

      @Indexable(type=REINDEX) ObjectField addOrUpdateCustomObjectField(String externalReferenceCode, long objectFieldId, long userId, long listTypeDefinitionId, long objectDefinitionId, String businessType, String dbType, boolean indexed, boolean indexedAsKeyword, String indexedLanguageId, Map<Locale,String> labelMap, boolean localized, String name, String readOnly, String readOnlyConditionExpression, boolean required, boolean state, List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateSystemObjectField

      @Indexable(type=REINDEX) ObjectField addOrUpdateSystemObjectField(String externalReferenceCode, long userId, long listTypeDefinitionId, long objectDefinitionId, String businessType, String dbColumnName, String dbTableName, String dbType, boolean indexed, boolean indexedAsKeyword, String indexedLanguageId, Map<Locale,String> labelMap, boolean localized, String name, String readOnly, String readOnlyConditionExpression, boolean required, boolean state, List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSystemObjectField

      @Indexable(type=REINDEX) ObjectField addSystemObjectField(String externalReferenceCode, long userId, long listTypeDefinitionId, long objectDefinitionId, String businessType, String dbColumnName, String dbTableName, String dbType, boolean indexed, boolean indexedAsKeyword, String indexedLanguageId, Map<Locale,String> labelMap, boolean localized, String name, String readOnly, String readOnlyConditionExpression, boolean required, boolean state, List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createObjectField

      @Transactional(enabled=false) ObjectField createObjectField(long objectFieldId)
      Creates a new object field with the primary key. Does not add the object field to the database.
      Parameters:
      objectFieldId - the primary key for the new object field
      Returns:
      the new object field
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectField

      @Indexable(type=DELETE) ObjectField deleteObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object field with the primary key from the database. Also notifies the appropriate model listeners.

      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.

      Parameters:
      objectFieldId - the primary key of the object field
      Returns:
      the object field that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object field with the primary key could not be found
    • deleteObjectField

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectField deleteObjectField(ObjectField objectField) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object field from the database. Also notifies the appropriate model listeners.

      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.

      Parameters:
      objectField - the object field
      Returns:
      the object field that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectFieldByObjectDefinitionId

      void deleteObjectFieldByObjectDefinitionId(Long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deletePersistedModel

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRelationshipTypeObjectField

      @Indexable(type=DELETE) ObjectField deleteRelationshipTypeObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Performs a dynamic query on the database and returns the matching rows.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> 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.

      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      Returns:
      the range of matching rows
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> 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.

      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.

      Parameters:
      dynamicQuery - the dynamic query
      start - the lower bound of the range of model instances
      end - the upper bound of the range of model instances (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the ordered range of matching rows
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
      Returns the number of rows matching the dynamic query.
      Parameters:
      dynamicQuery - the dynamic query
      Returns:
      the number of rows matching the dynamic query
    • dynamicQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) 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.
      Parameters:
      dynamicQuery - the dynamic query
      projection - the projection to apply to the query
      Returns:
      the number of rows matching the dynamic query
    • fetchObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(long objectFieldId)
    • fetchObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(long objectDefinitionId, String name)
    • fetchObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectField(String externalReferenceCode, long objectDefinitionId)
    • fetchObjectFieldByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField fetchObjectFieldByUuidAndCompanyId(String uuid, long companyId)
      Returns the object field with the matching UUID and company.
      Parameters:
      uuid - the object field's UUID
      companyId - the primary key of the company
      Returns:
      the matching object field, or null if a matching object field could not be found
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getActiveObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getActiveObjectFields(List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getColumn

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.petra.sql.dsl.Column<?,?> getColumn(long objectDefinitionId, String name)
    • getCustomObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getCustomObjectFields(long objectDefinitionId)
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getListTypeDefinitionObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getListTypeDefinitionObjectFields(long listTypeDefinitionId, boolean state)
    • getLocalizedObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getLocalizedObjectFields(long objectDefinitionId)
    • getObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object field with the primary key.
      Parameters:
      objectFieldId - the primary key of the object field
      Returns:
      the object field
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object field with the primary key could not be found
    • getObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectField(long objectDefinitionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectField

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectField(String externalReferenceCode, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectFieldByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectField getObjectFieldByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object field with the matching UUID and company.
      Parameters:
      uuid - the object field's UUID
      companyId - the primary key of the company
      Returns:
      the matching object field
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object field could not be found
    • getObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFields(int start, int end)
      Returns a range of all the object fields.

      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.

      Parameters:
      start - the lower bound of the range of object fields
      end - the upper bound of the range of object fields (not inclusive)
      Returns:
      the range of object fields
    • getObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFields(long objectDefinitionId)
    • getObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFields(long objectDefinitionId, boolean system)
    • getObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFields(long objectDefinitionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ObjectField> orderByComparator)
    • getObjectFields

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFields(long objectDefinitionId, String dbTableName)
    • getObjectFieldsByBusinessType

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectField> getObjectFieldsByBusinessType(long objectDefinitionId, String businessType)
    • getObjectFieldsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCount()
      Returns the number of object fields.
      Returns:
      the number of object fields
    • getObjectFieldsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCount(long objectDefinitionId)
    • getObjectFieldsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCount(long objectDefinitionId, boolean system)
    • getObjectFieldsCountByListTypeDefinitionId

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId)
    • getObjectFieldsMap

      @Transactional(propagation=SUPPORTS, readOnly=true) Map<Long,List<ObjectField>> getObjectFieldsMap(long companyId)
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTable

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.petra.sql.dsl.Table getTable(long objectDefinitionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectField

      @Indexable(type=REINDEX) ObjectField updateObjectField(ObjectField objectField)
      Updates the object field in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      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.

      Parameters:
      objectField - the object field
      Returns:
      the object field that was updated
    • updateObjectField

      ObjectField updateObjectField(String externalReferenceCode, long objectFieldId, long userId, long listTypeDefinitionId, long objectDefinitionId, String businessType, String dbColumnName, String dbTableName, String dbType, boolean indexed, boolean indexedAsKeyword, String indexedLanguageId, Map<Locale,String> labelMap, boolean localized, String name, String readOnly, String readOnlyConditionExpression, boolean required, boolean state, boolean system, List<ObjectFieldSetting> objectFieldSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateRequired

      @Indexable(type=REINDEX) ObjectField updateRequired(long objectFieldId, boolean required) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateUserId

      void updateUserId(long companyId, long oldUserId, long newUserId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validateExternalReferenceCode

      void validateExternalReferenceCode(String externalReferenceCode, long objectFieldId, long companyId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validateReadOnlyAndReadOnlyConditionExpression

      void validateReadOnlyAndReadOnlyConditionExpression(String businessType, String readOnly, String readOnlyConditionExpression, boolean required) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • validateRequired

      void validateRequired(String businessType, boolean objectDefinitionApproved, ObjectField oldObjectField, boolean required) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException