Class CTCollectionLocalServiceUtil

java.lang.Object
com.liferay.change.tracking.service.CTCollectionLocalServiceUtil

public class CTCollectionLocalServiceUtil extends Object
Provides the local service utility for CTCollection. This utility wraps com.liferay.change.tracking.service.impl.CTCollectionLocalServiceImpl 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

    • CTCollectionLocalServiceUtil

      public CTCollectionLocalServiceUtil()
  • Method Details

    • addCTCollection

      public static CTCollection addCTCollection(CTCollection ctCollection)
      Adds the ct collection to the database. Also notifies the appropriate model listeners.

      Important: Inspect CTCollectionLocalServiceImpl 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:
      ctCollection - the ct collection
      Returns:
      the ct collection that was added
    • addCTCollection

      public static CTCollection addCTCollection(String externalReferenceCode, long companyId, long userId, long ctRemoteId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkConflicts

      public static Map<Long,List<ConflictInfo>> checkConflicts(CTCollection ctCollection) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkConflicts

      public static Map<Long,List<ConflictInfo>> checkConflicts(long companyId, List<CTEntry> ctEntries, long fromCTCollectionId, String fromCTCollectionName, long toCTCollectionId, String toCTCollectionName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • checkConflicts

      public static Map<Long,List<ConflictInfo>> checkConflicts(long companyId, long[] ctEntryIds, long fromCTCollectionId, String fromCTCollectionName, long toCTCollectionId, String toCTCollectionName) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCTCollection

      public static CTCollection createCTCollection(long ctCollectionId)
      Creates a new ct collection with the primary key. Does not add the ct collection to the database.
      Parameters:
      ctCollectionId - the primary key for the new ct collection
      Returns:
      the new ct collection
    • 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
    • deleteCompanyCTCollections

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

      public static void deleteCTAutoResolutionInfo(long ctAutoResolutionInfoId)
    • deleteCTCollection

      public static CTCollection deleteCTCollection(CTCollection ctCollection) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ct collection from the database. Also notifies the appropriate model listeners.

      Important: Inspect CTCollectionLocalServiceImpl 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:
      ctCollection - the ct collection
      Returns:
      the ct collection that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCTCollection

      public static CTCollection deleteCTCollection(long ctCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ct collection with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CTCollectionLocalServiceImpl 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:
      ctCollectionId - the primary key of the ct collection
      Returns:
      the ct collection that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ct collection 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
    • discardCTEntry

      public static void discardCTEntry(long ctCollectionId, long modelClassNameId, long modelClassPK, boolean force) 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.change.tracking.model.impl.CTCollectionModelImpl.

      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.change.tracking.model.impl.CTCollectionModelImpl.

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

      public static CTCollection fetchCTCollection(long ctCollectionId)
    • fetchCTCollectionByExternalReferenceCode

      public static CTCollection fetchCTCollectionByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCTCollectionByUuidAndCompanyId

      public static CTCollection fetchCTCollectionByUuidAndCompanyId(String uuid, long companyId)
      Returns the ct collection with the matching UUID and company.
      Parameters:
      uuid - the ct collection's UUID
      companyId - the primary key of the company
      Returns:
      the matching ct collection, or null if a matching ct collection could not be found
    • getActionableDynamicQuery

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

      public static CTCollection getCTCollection(long ctCollectionId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ct collection with the primary key.
      Parameters:
      ctCollectionId - the primary key of the ct collection
      Returns:
      the ct collection
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ct collection with the primary key could not be found
    • getCTCollectionByExternalReferenceCode

      public static CTCollection getCTCollectionByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTCollectionByUuidAndCompanyId

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

      public static List<CTCollection> getCTCollections(int start, int end)
      Returns a range of all the ct collections.

      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.change.tracking.model.impl.CTCollectionModelImpl.

      Parameters:
      start - the lower bound of the range of ct collections
      end - the upper bound of the range of ct collections (not inclusive)
      Returns:
      the range of ct collections
    • getCTCollections

      public static List<CTCollection> getCTCollections(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CTCollection> orderByComparator)
    • getCTCollections

      public static List<CTCollection> getCTCollections(long companyId, int[] statuses, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CTCollection> orderByComparator)
    • getCTCollectionsCount

      public static int getCTCollectionsCount()
      Returns the number of ct collections.
      Returns:
      the number of ct collections
    • getCTMappingTableInfos

      public static List<CTMappingTableInfo> getCTMappingTableInfos(long ctCollectionId)
    • getExclusivePublishedCTCollections

      public static List<CTCollection> getExclusivePublishedCTCollections(long modelClassNameId, long modelClassPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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()
    • 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
    • getRelatedCTEntries

      public static List<CTEntry> getRelatedCTEntries(long ctCollectionId, long[] ctEntryIds) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getRelatedCTEntriesMap

      public static Map<Long,List<CTEntry>> getRelatedCTEntriesMap(long ctCollectionId, long modelClassNameId, long modelClassPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • hasUnapprovedChanges

      public static boolean hasUnapprovedChanges(long ctCollectionId) throws SQLException
      Throws:
      SQLException
    • isCTEntryEnclosed

      public static boolean isCTEntryEnclosed(long ctCollectionId, long modelClassNameId, long modelClassPK)
    • moveCTEntry

      public static void moveCTEntry(long fromCTCollectionId, long toCTCollectionId, long modelClassNameId, long modelClassPK) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • undoCTCollection

      public static CTCollection undoCTCollection(long ctCollectionId, long userId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateCTCollection

      public static CTCollection updateCTCollection(CTCollection ctCollection)
      Updates the ct collection in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CTCollectionLocalServiceImpl 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:
      ctCollection - the ct collection
      Returns:
      the ct collection that was updated
    • updateCTCollection

      public static CTCollection updateCTCollection(long userId, long ctCollectionId, String name, String description) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getService

      public static CTCollectionLocalService getService()