Class ObjectFieldLocalServiceUtil

java.lang.Object
com.liferay.object.service.ObjectFieldLocalServiceUtil

public class ObjectFieldLocalServiceUtil extends Object
Provides the local service utility for ObjectField. This utility wraps com.liferay.object.service.impl.ObjectFieldLocalServiceImpl and is an access point for service operations in application layer code running on the local server. 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:
  • Constructor Details

    • ObjectFieldLocalServiceUtil

      public ObjectFieldLocalServiceUtil()
  • Method Details

    • addCustomObjectField

      public static 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

      public static 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

      public static 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

      public static 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

      public static 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

      public static 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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectField

      public static 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

      public static 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

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

      public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRelationshipTypeObjectField

      public static ObjectField deleteRelationshipTypeObjectField(long objectFieldId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

      public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <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

      public static <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

      public static <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

      public static 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

      public static 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

      public static ObjectField fetchObjectField(long objectFieldId)
    • fetchObjectField

      public static ObjectField fetchObjectField(long objectDefinitionId, String name)
    • fetchObjectField

      public static ObjectField fetchObjectField(String externalReferenceCode, long objectDefinitionId)
    • fetchObjectFieldByUuidAndCompanyId

      public static 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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getActiveObjectFields

      public static List<ObjectField> getActiveObjectFields(List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getColumn

      public static com.liferay.petra.sql.dsl.Column<?,?> getColumn(long objectDefinitionId, String name)
    • getCustomObjectFields

      public static List<ObjectField> getCustomObjectFields(long objectDefinitionId)
    • getExportActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getListTypeDefinitionObjectFields

      public static List<ObjectField> getListTypeDefinitionObjectFields(long listTypeDefinitionId, boolean state)
    • getLocalizedObjectFields

      public static List<ObjectField> getLocalizedObjectFields(long objectDefinitionId)
    • getObjectField

      public static 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

      public static ObjectField getObjectField(long objectDefinitionId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectField

      public static ObjectField getObjectField(String externalReferenceCode, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectFieldByUuidAndCompanyId

      public static 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

      public static 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

      public static List<ObjectField> getObjectFields(long objectDefinitionId)
    • getObjectFields

      public static List<ObjectField> getObjectFields(long objectDefinitionId, boolean system)
    • getObjectFields

      public static List<ObjectField> getObjectFields(long objectDefinitionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<ObjectField> orderByComparator)
    • getObjectFields

      public static List<ObjectField> getObjectFields(long objectDefinitionId, String dbTableName)
    • getObjectFieldsByBusinessType

      public static List<ObjectField> getObjectFieldsByBusinessType(long objectDefinitionId, String businessType)
    • getObjectFieldsCount

      public static int getObjectFieldsCount()
      Returns the number of object fields.
      Returns:
      the number of object fields
    • getObjectFieldsCount

      public static int getObjectFieldsCount(long objectDefinitionId)
    • getObjectFieldsCount

      public static int getObjectFieldsCount(long objectDefinitionId, boolean system)
    • getObjectFieldsCountByListTypeDefinitionId

      public static int getObjectFieldsCountByListTypeDefinitionId(long listTypeDefinitionId)
    • getObjectFieldsMap

      public static Map<Long,List<ObjectField>> getObjectFieldsMap(long companyId)
    • getOSGiServiceIdentifier

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

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getTable

      public static 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

      public static 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

      public static 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

      public static ObjectField updateRequired(long objectFieldId, boolean required) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateUserId

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

      public static 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

      public static 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

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

      public static ObjectFieldLocalService getService()