Class ObjectDefinitionLocalServiceUtil

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

public class ObjectDefinitionLocalServiceUtil extends Object
Provides the local service utility for ObjectDefinition. This utility wraps com.liferay.object.service.impl.ObjectDefinitionLocalServiceImpl 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

    • ObjectDefinitionLocalServiceUtil

      public ObjectDefinitionLocalServiceUtil()
  • Method Details

    • addCustomObjectDefinition

      public static ObjectDefinition addCustomObjectDefinition(long userId, long objectFolderId, String className, boolean enableComments, boolean enableFriendlyURLCustomization, boolean enableIndexSearch, boolean enableLocalization, boolean enableObjectEntryDraft, Map<Locale,String> labelMap, String name, String panelAppOrder, String panelCategoryKey, Map<Locale,String> pluralLabelMap, boolean portlet, String scope, String storageType, List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addObjectDefinition

      public static ObjectDefinition addObjectDefinition(ObjectDefinition objectDefinition)
      Adds the object definition to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionLocalServiceImpl 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:
      objectDefinition - the object definition
      Returns:
      the object definition that was added
    • addObjectDefinition

      public static ObjectDefinition addObjectDefinition(String externalReferenceCode, long userId, long objectFolderId, boolean modifiable, String scope, boolean system) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addOrUpdateSystemObjectDefinition

      public static ObjectDefinition addOrUpdateSystemObjectDefinition(long companyId, long objectFolderId, SystemObjectDefinitionManager systemObjectDefinitionManager) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSystemObjectDefinition

      public static ObjectDefinition addSystemObjectDefinition(String externalReferenceCode, long userId, long objectFolderId, String className, String dbTableName, boolean enableComments, boolean enableFriendlyURLCustomization, boolean enableIndexSearch, boolean enableLocalization, Map<Locale,String> labelMap, boolean modifiable, String name, String panelAppOrder, String panelCategoryKey, String pkObjectFieldDBColumnName, String pkObjectFieldName, Map<Locale,String> pluralLabelMap, boolean portlet, String scope, String titleObjectFieldName, int version, int status, List<ObjectField> objectFields) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createObjectDefinition

      public static ObjectDefinition createObjectDefinition(long objectDefinitionId)
      Creates a new object definition with the primary key. Does not add the object definition to the database.
      Parameters:
      objectDefinitionId - the primary key for the new object definition
      Returns:
      the new object definition
    • 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
    • deleteCompanyObjectDefinitions

      public static void deleteCompanyObjectDefinitions(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteObjectDefinition

      public static ObjectDefinition deleteObjectDefinition(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object definition with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionLocalServiceImpl 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:
      objectDefinitionId - the primary key of the object definition
      Returns:
      the object definition that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object definition with the primary key could not be found
    • deleteObjectDefinition

      public static ObjectDefinition deleteObjectDefinition(ObjectDefinition objectDefinition) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object definition from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionLocalServiceImpl 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:
      objectDefinition - the object definition
      Returns:
      the object definition that was removed
      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
    • deployInactiveObjectDefinition

      public static void deployInactiveObjectDefinition(ObjectDefinition objectDefinition)
    • deployObjectDefinition

      public static void deployObjectDefinition(ObjectDefinition objectDefinition)
    • deployObjectDefinitions

      public static void deployObjectDefinitions()
    • 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.ObjectDefinitionModelImpl.

      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.ObjectDefinitionModelImpl.

      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
    • enableAccountEntryRestricted

      public static ObjectDefinition enableAccountEntryRestricted(ObjectRelationship objectRelationship) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • enableAccountEntryRestrictedForNondefaultStorageType

      public static ObjectDefinition enableAccountEntryRestrictedForNondefaultStorageType(ObjectField objectField) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchObjectDefinition

      public static ObjectDefinition fetchObjectDefinition(long objectDefinitionId)
    • fetchObjectDefinition

      public static ObjectDefinition fetchObjectDefinition(long companyId, String name)
    • fetchObjectDefinitionByClassName

      public static ObjectDefinition fetchObjectDefinitionByClassName(long companyId, String className)
    • fetchObjectDefinitionByExternalReferenceCode

      public static ObjectDefinition fetchObjectDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchObjectDefinitionByUuidAndCompanyId

      public static ObjectDefinition fetchObjectDefinitionByUuidAndCompanyId(String uuid, long companyId)
      Returns the object definition with the matching UUID and company.
      Parameters:
      uuid - the object definition's UUID
      companyId - the primary key of the company
      Returns:
      the matching object definition, or null if a matching object definition could not be found
    • fetchSystemObjectDefinition

      public static ObjectDefinition fetchSystemObjectDefinition(long companyId, String name)
    • getActionableDynamicQuery

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

      public static List<ObjectDefinition> getBoundObjectDefinitions(long companyId, long rootObjectDefinitionId)
    • getCustomObjectDefinitions

      public static List<ObjectDefinition> getCustomObjectDefinitions(int status)
    • 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()
    • getObjectDefinition

      public static ObjectDefinition getObjectDefinition(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object definition with the primary key.
      Parameters:
      objectDefinitionId - the primary key of the object definition
      Returns:
      the object definition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a object definition with the primary key could not be found
    • getObjectDefinition

      public static ObjectDefinition getObjectDefinition(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionByExternalReferenceCode

      public static ObjectDefinition getObjectDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionByUuidAndCompanyId

      public static ObjectDefinition getObjectDefinitionByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the object definition with the matching UUID and company.
      Parameters:
      uuid - the object definition's UUID
      companyId - the primary key of the company
      Returns:
      the matching object definition
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching object definition could not be found
    • getObjectDefinitions

      public static List<ObjectDefinition> getObjectDefinitions(boolean accountEntryRestricted)
    • getObjectDefinitions

      public static List<ObjectDefinition> getObjectDefinitions(int start, int end)
      Returns a range of all the object definitions.

      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.ObjectDefinitionModelImpl.

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

      public static List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, boolean system, int status)
    • getObjectDefinitions

      public static List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, int status)
    • getObjectDefinitions

      public static List<ObjectDefinition> getObjectDefinitions(long companyId, int status)
    • getObjectDefinitionsCount

      public static int getObjectDefinitionsCount()
      Returns the number of object definitions.
      Returns:
      the number of object definitions
    • getObjectDefinitionsCount

      public static int getObjectDefinitionsCount(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectFolderObjectDefinitions

      public static List<ObjectDefinition> getObjectFolderObjectDefinitions(long objectFolderId)
    • getObjectFolderObjectDefinitionsCount

      public static int getObjectFolderObjectDefinitionsCount(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • getSystemObjectDefinitions

      public static List<ObjectDefinition> getSystemObjectDefinitions()
    • getUnmodifiableSystemObjectDefinitions

      public static List<ObjectDefinition> getUnmodifiableSystemObjectDefinitions(long companyId)
    • hasObjectRelationship

      public static boolean hasObjectRelationship(long objectDefinitionId)
    • publishCustomObjectDefinition

      public static ObjectDefinition publishCustomObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • publishSystemObjectDefinition

      public static ObjectDefinition publishSystemObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • undeployObjectDefinition

      public static void undeployObjectDefinition(ObjectDefinition objectDefinition)
    • updateCustomObjectDefinition

      public static ObjectDefinition updateCustomObjectDefinition(String externalReferenceCode, long objectDefinitionId, long accountEntryRestrictedObjectFieldId, long descriptionObjectFieldId, long objectFolderId, long titleObjectFieldId, boolean accountEntryRestricted, boolean active, String className, boolean enableCategorization, boolean enableComments, boolean enableFriendlyURLCustomization, boolean enableIndexSearch, boolean enableLocalization, boolean enableObjectEntryDraft, boolean enableObjectEntryHistory, Map<Locale,String> labelMap, String name, String panelAppOrder, String panelCategoryKey, boolean portlet, Map<Locale,String> pluralLabelMap, String scope, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateExternalReferenceCode

      public static ObjectDefinition updateExternalReferenceCode(long objectDefinitionId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectDefinition

      public static ObjectDefinition updateObjectDefinition(ObjectDefinition objectDefinition)
      Updates the object definition in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectDefinitionLocalServiceImpl 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:
      objectDefinition - the object definition
      Returns:
      the object definition that was updated
    • updateObjectFolderId

      public static ObjectDefinition updateObjectFolderId(long objectDefinitionId, long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updatePortlet

      public static ObjectDefinition updatePortlet(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateRootDescendantNodeObjectDefinition

      public static ObjectDefinition updateRootDescendantNodeObjectDefinition(ObjectDefinition objectDefinition, long rootObjectDefinitionId)
    • updateRootObjectDefinitionId

      public static ObjectDefinition updateRootObjectDefinitionId(long objectDefinitionId, long rootObjectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSystemObjectDefinition

      public static ObjectDefinition updateSystemObjectDefinition(String externalReferenceCode, long objectDefinitionId, long objectFolderId, long titleObjectFieldId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateTitleObjectFieldId

      public static ObjectDefinition updateTitleObjectFieldId(long objectDefinitionId, long titleObjectFieldId) 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
    • getService

      public static ObjectDefinitionLocalService getService()