Class CTEntryLocalServiceUtil

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

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

    • CTEntryLocalServiceUtil

      public CTEntryLocalServiceUtil()
  • Method Details

    • addCTEntry

      public static CTEntry addCTEntry(CTEntry ctEntry)
      Adds the ct entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect CTEntryLocalServiceImpl 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:
      ctEntry - the ct entry
      Returns:
      the ct entry that was added
    • addCTEntry

      public static CTEntry addCTEntry(String externalReferenceCode, long ctCollectionId, long modelClassNameId, com.liferay.portal.kernel.model.change.tracking.CTModel<?> ctModel, long userId, int changeType) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createCTEntry

      public static CTEntry createCTEntry(long ctEntryId)
      Creates a new ct entry with the primary key. Does not add the ct entry to the database.
      Parameters:
      ctEntryId - the primary key for the new ct entry
      Returns:
      the new ct entry
    • 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
    • deleteCTEntry

      public static CTEntry deleteCTEntry(CTEntry ctEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ct entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect CTEntryLocalServiceImpl 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:
      ctEntry - the ct entry
      Returns:
      the ct entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteCTEntry

      public static CTEntry deleteCTEntry(long ctEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the ct entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect CTEntryLocalServiceImpl 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:
      ctEntryId - the primary key of the ct entry
      Returns:
      the ct entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ct entry 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.change.tracking.model.impl.CTEntryModelImpl.

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

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

      public static CTEntry fetchCTEntry(long ctEntryId)
    • fetchCTEntry

      public static CTEntry fetchCTEntry(long ctCollectionId, long modelClassNameId, long modelClassPK)
    • fetchCTEntryByExternalReferenceCode

      public static CTEntry fetchCTEntryByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchCTEntryByUuidAndCompanyId

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

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

      public static List<CTEntry> getCTCollectionCTEntries(long ctCollectionId)
    • getCTCollectionCTEntries

      public static List<CTEntry> getCTCollectionCTEntries(long ctCollectionId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<CTEntry> orderByComparator)
    • getCTCollectionCTEntriesCount

      public static int getCTCollectionCTEntriesCount(long ctCollectionId)
    • getCTEntries

      public static List<CTEntry> getCTEntries(int start, int end)
      Returns a range of all the ct entries.

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

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

      public static List<CTEntry> getCTEntries(long ctCollectionId, long modelClassNameId)
    • getCTEntriesCount

      public static int getCTEntriesCount()
      Returns the number of ct entries.
      Returns:
      the number of ct entries
    • getCTEntry

      public static CTEntry getCTEntry(long ctEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the ct entry with the primary key.
      Parameters:
      ctEntryId - the primary key of the ct entry
      Returns:
      the ct entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a ct entry with the primary key could not be found
    • getCTEntryByExternalReferenceCode

      public static CTEntry getCTEntryByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTEntryByUuidAndCompanyId

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

      public static long getCTRowCTCollectionId(CTEntry ctEntry) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getExclusiveModelClassPKs

      public static List<Long> getExclusiveModelClassPKs(long ctCollectionId, long modelClassNameId)
    • 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
    • hasCTEntries

      public static boolean hasCTEntries(long ctCollectionId, long modelClassNameId)
    • hasCTEntry

      public static boolean hasCTEntry(long ctCollectionId, long modelClassNameId, long modelClassPK)
    • hasUnpublishedCTEntries

      public static boolean hasUnpublishedCTEntries(long modelClassNameId, long modelClassPK, int changeType)
    • updateCTEntry

      public static CTEntry updateCTEntry(CTEntry ctEntry)
      Updates the ct entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect CTEntryLocalServiceImpl 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:
      ctEntry - the ct entry
      Returns:
      the ct entry that was updated
    • updateModelMvccVersion

      public static CTEntry updateModelMvccVersion(long ctEntryId, long modelMvccVersion)
    • getService

      public static CTEntryLocalService getService()