Interface ObjectDefinitionLocalService

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

@ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface ObjectDefinitionLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for ObjectDefinition. 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

    • addCustomObjectDefinition

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) ObjectDefinition addOrUpdateSystemObjectDefinition(long companyId, long objectFolderId, SystemObjectDefinitionManager systemObjectDefinitionManager) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSystemObjectDefinition

      @Indexable(type=REINDEX) 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

      @Transactional(enabled=false) 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

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

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

      @Indexable(type=DELETE) 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

      @Indexable(type=DELETE) @SystemEvent(type=1) 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

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

      void deployInactiveObjectDefinition(ObjectDefinition objectDefinition)
    • deployObjectDefinition

      void deployObjectDefinition(ObjectDefinition objectDefinition)
    • deployObjectDefinitions

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

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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition fetchObjectDefinition(long objectDefinitionId)
    • fetchObjectDefinition

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition fetchObjectDefinition(long companyId, String name)
    • fetchObjectDefinitionByClassName

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition fetchObjectDefinitionByClassName(long companyId, String className)
    • fetchObjectDefinitionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition fetchObjectDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchObjectDefinitionByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition fetchSystemObjectDefinition(long companyId, String name)
    • getActionableDynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getBoundObjectDefinitions(long companyId, long rootObjectDefinitionId)
    • getCustomObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getCustomObjectDefinitions(int status)
    • 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()
    • getObjectDefinition

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition getObjectDefinition(long companyId, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectDefinition getObjectDefinitionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectDefinitionByUuidAndCompanyId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getObjectDefinitions(boolean accountEntryRestricted)
    • getObjectDefinitions

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, boolean system, int status)
    • getObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getObjectDefinitions(long companyId, boolean active, int status)
    • getObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getObjectDefinitions(long companyId, int status)
    • getObjectDefinitionsCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectDefinitionsCount(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getObjectFolderObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getObjectFolderObjectDefinitions(long objectFolderId)
    • getObjectFolderObjectDefinitionsCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFolderObjectDefinitionsCount(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • getSystemObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getSystemObjectDefinitions()
    • getUnmodifiableSystemObjectDefinitions

      @Transactional(propagation=SUPPORTS, readOnly=true) List<ObjectDefinition> getUnmodifiableSystemObjectDefinitions(long companyId)
    • hasObjectRelationship

      @Transactional(propagation=SUPPORTS, readOnly=true) boolean hasObjectRelationship(long objectDefinitionId)
    • publishCustomObjectDefinition

      @Indexable(type=REINDEX) ObjectDefinition publishCustomObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • publishSystemObjectDefinition

      @Indexable(type=REINDEX) ObjectDefinition publishSystemObjectDefinition(long userId, long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • undeployObjectDefinition

      void undeployObjectDefinition(ObjectDefinition objectDefinition)
    • updateCustomObjectDefinition

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) ObjectDefinition updateExternalReferenceCode(long objectDefinitionId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateObjectDefinition

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) ObjectDefinition updateObjectFolderId(long objectDefinitionId, long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updatePortlet

      @Indexable(type=REINDEX) ObjectDefinition updatePortlet(long objectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateRootDescendantNodeObjectDefinition

      @Indexable(type=REINDEX) ObjectDefinition updateRootDescendantNodeObjectDefinition(ObjectDefinition objectDefinition, long rootObjectDefinitionId)
    • updateRootObjectDefinitionId

      @Indexable(type=REINDEX) ObjectDefinition updateRootObjectDefinitionId(long objectDefinitionId, long rootObjectDefinitionId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSystemObjectDefinition

      @Indexable(type=REINDEX) 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

      @Indexable(type=REINDEX) ObjectDefinition updateTitleObjectFieldId(long objectDefinitionId, long titleObjectFieldId) 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