Class DLContentLocalServiceUtil

java.lang.Object
com.liferay.document.library.content.service.DLContentLocalServiceUtil

public class DLContentLocalServiceUtil extends Object
Provides the local service utility for DLContent. This utility wraps com.liferay.document.library.content.service.impl.DLContentLocalServiceImpl 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

    • DLContentLocalServiceUtil

      public DLContentLocalServiceUtil()
  • Method Details

    • addContent

      @Deprecated public static DLContent addContent(long companyId, long repositoryId, String path, String version, byte[] bytes)
      Deprecated.
      As of Athanasius (7.3.x), replaced by addContent(long, long, String, String, InputStream)
    • addContent

      public static DLContent addContent(long companyId, long repositoryId, String path, String version, InputStream inputStream)
    • addContent

      @Deprecated public static DLContent addContent(long companyId, long repositoryId, String path, String version, InputStream inputStream, long size)
      Deprecated.
      As of Athanasius (7.3.x), replaced by addContent(long, long, String, String, InputStream)
    • addDLContent

      public static DLContent addDLContent(DLContent dlContent)
      Adds the document library content to the database. Also notifies the appropriate model listeners.

      Important: Inspect DLContentLocalServiceImpl 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:
      dlContent - the document library content
      Returns:
      the document library content that was added
    • createDLContent

      public static DLContent createDLContent(long contentId)
      Creates a new document library content with the primary key. Does not add the document library content to the database.
      Parameters:
      contentId - the primary key for the new document library content
      Returns:
      the new document library content
    • 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
    • deleteContent

      public static void deleteContent(long companyId, long repositoryId, String path, String version)
    • deleteContents

      @Deprecated public static void deleteContents(long companyId, long repositoryId, String path)
      Deprecated.
      As of Athanasius (7.3.x), with no direct replacement
    • deleteContentsByDirectory

      public static void deleteContentsByDirectory(long companyId, long repositoryId, String dirName)
    • deleteDLContent

      public static DLContent deleteDLContent(DLContent dlContent)
      Deletes the document library content from the database. Also notifies the appropriate model listeners.

      Important: Inspect DLContentLocalServiceImpl 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:
      dlContent - the document library content
      Returns:
      the document library content that was removed
    • deleteDLContent

      public static DLContent deleteDLContent(long contentId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the document library content with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect DLContentLocalServiceImpl 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:
      contentId - the primary key of the document library content
      Returns:
      the document library content that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a document library content with the primary key could not be found
    • 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
    • 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.document.library.content.model.impl.DLContentModelImpl.

      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.document.library.content.model.impl.DLContentModelImpl.

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

      public static DLContent fetchDLContent(long contentId)
    • getActionableDynamicQuery

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

      @Deprecated public static DLContent getContent(long companyId, long repositoryId, String path) throws NoSuchContentException
      Deprecated.
      As of Athanasius (7.3.x), replaced by getContent(long, long, String, String)
      Throws:
      NoSuchContentException
    • getContent

      public static DLContent getContent(long companyId, long repositoryId, String path, String version) throws NoSuchContentException
      Throws:
      NoSuchContentException
    • getContents

      @Deprecated public static List<DLContent> getContents(long companyId, long repositoryId)
      Deprecated.
      As of Athanasius (7.3.x), replaced by getContentsByDirectory(long, long, String)
    • getContents

      public static List<DLContent> getContents(long companyId, long repositoryId, String path)
    • getContentsByDirectory

      public static List<DLContent> getContentsByDirectory(long companyId, long repositoryId, String dirName)
    • getDataBlobModel

      public static DLContentDataBlobModel getDataBlobModel(Serializable primaryKey)
    • getDLContent

      public static DLContent getDLContent(long contentId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the document library content with the primary key.
      Parameters:
      contentId - the primary key of the document library content
      Returns:
      the document library content
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a document library content with the primary key could not be found
    • getDLContents

      public static List<DLContent> getDLContents(int start, int end)
      Returns a range of all the document library contents.

      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.document.library.content.model.impl.DLContentModelImpl.

      Parameters:
      start - the lower bound of the range of document library contents
      end - the upper bound of the range of document library contents (not inclusive)
      Returns:
      the range of document library contents
    • getDLContentsCount

      public static int getDLContentsCount()
      Returns the number of document library contents.
      Returns:
      the number of document library contents
    • getIndexableActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • 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
    • hasContent

      public static boolean hasContent(long companyId, long repositoryId, String path, String version)
    • openDataInputStream

      public static InputStream openDataInputStream(long contentId)
    • updateDLContent

      public static DLContent updateDLContent(DLContent dlContent)
      Updates the document library content in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect DLContentLocalServiceImpl 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:
      dlContent - the document library content
      Returns:
      the document library content that was updated
    • updateDLContent

      @Deprecated public static void updateDLContent(long companyId, long oldRepositoryId, long newRepositoryId, String oldPath, String newPath)
      Deprecated.
      As of Athanasius (7.3.x), with no direct replacement
    • getService

      public static DLContentLocalService getService()