Interface ObjectFolderLocalService

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

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

    • addObjectFolder

      @Indexable(type=REINDEX) ObjectFolder addObjectFolder(ObjectFolder objectFolder)
      Adds the object folder to the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFolderLocalServiceImpl 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:
      objectFolder - the object folder
      Returns:
      the object folder that was added
    • addObjectFolder

      @Indexable(type=REINDEX) ObjectFolder addObjectFolder(String externalReferenceCode, long userId, Map<Locale,String> labelMap, String name) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createObjectFolder

      @Transactional(enabled=false) ObjectFolder createObjectFolder(long objectFolderId)
      Creates a new object folder with the primary key. Does not add the object folder to the database.
      Parameters:
      objectFolderId - the primary key for the new object folder
      Returns:
      the new object folder
    • 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
    • deleteCompanyObjectFolders

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

      @Indexable(type=DELETE) ObjectFolder deleteObjectFolder(long objectFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object folder with the primary key from the database. Also notifies the appropriate model listeners.

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

      @Indexable(type=DELETE) @SystemEvent(type=1) ObjectFolder deleteObjectFolder(ObjectFolder objectFolder) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the object folder from the database. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFolderLocalServiceImpl 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:
      objectFolder - the object folder
      Returns:
      the object folder 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
    • 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.ObjectFolderModelImpl.

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchDefaultObjectFolder(long companyId)
    • fetchObjectFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolder(long objectFolderId)
    • fetchObjectFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolder(long companyId, String name)
    • fetchObjectFolderByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder fetchObjectFolderByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchObjectFolderByUuidAndCompanyId

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getDefaultObjectFolder(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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()
    • getObjectFolder

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

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

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

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

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

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getObjectFoldersCount(long companyId)
    • getOrAddDefaultObjectFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) ObjectFolder getOrAddDefaultObjectFolder(long companyId) 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
    • updateObjectFolder

      @Indexable(type=REINDEX) ObjectFolder updateObjectFolder(ObjectFolder objectFolder)
      Updates the object folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect ObjectFolderLocalServiceImpl 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:
      objectFolder - the object folder
      Returns:
      the object folder that was updated
    • updateObjectFolder

      @Indexable(type=REINDEX) ObjectFolder updateObjectFolder(String externalReferenceCode, long objectFolderId, Map<Locale,String> labelMap) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException