com.liferay.change.tracking.service

Class CTEntryLocalServiceUtil

java.lang.Object

com.liferay.change.tracking.service.CTEntryLocalServiceUtil

public class CTEntryLocalServiceUtil
extends java.lang.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:

CTEntryLocalService

Constructor Summary

Constructors

Constructor and Description
CTEntryLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static CTEntry	addCTEntry(CTEntry ctEntry) Adds the ct entry to the database.
static CTEntry	addCTEntry(long ctCollectionId, long modelClassNameId, CTModel<?> ctModel, long userId, int changeType)
static CTEntry	createCTEntry(long ctEntryId) Creates a new ct entry with the primary key.
static PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static CTEntry	deleteCTEntry(CTEntry ctEntry) Deletes the ct entry from the database.
static CTEntry	deleteCTEntry(long ctEntryId) Deletes the ct entry with the primary key from the database.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(DSLQuery dslQuery)
static DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static CTEntry	fetchCTEntry(long ctEntryId)
static CTEntry	fetchCTEntry(long ctCollectionId, long modelClassNameId, long modelClassPK)
static ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<CTEntry>	getCTCollectionCTEntries(long ctCollectionId)
static java.util.List<CTEntry>	getCTCollectionCTEntries(long ctCollectionId, int start, int end, OrderByComparator<CTEntry> orderByComparator)
static int	getCTCollectionCTEntriesCount(long ctCollectionId)
static java.util.List<CTEntry>	getCTEntries(int start, int end) Returns a range of all the ct entries.
static java.util.List<CTEntry>	getCTEntries(long ctCollectionId, long modelClassNameId)
static int	getCTEntriesCount() Returns the number of ct entries.
static CTEntry	getCTEntry(long ctEntryId) Returns the ct entry with the primary key.
static long	getCTRowCTCollectionId(CTEntry ctEntry)
static java.util.List<java.lang.Long>	getExclusiveModelClassPKs(long ctCollectionId, long modelClassNameId)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CTEntryLocalService	getService()
static boolean	hasCTEntries(long ctCollectionId, long modelClassNameId)
static CTEntry	updateCTEntry(CTEntry ctEntry) Updates the ct entry in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CTEntryLocalServiceUtil

public CTEntryLocalServiceUtil()

Method Detail

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(long ctCollectionId,
                                 long modelClassNameId,
                                 CTModel<?> ctModel,
                                 long userId,
                                 int changeType)
                          throws PortalException

Throws:

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 PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteCTEntry

public static CTEntry deleteCTEntry(CTEntry ctEntry)
                             throws 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:

PortalException

deleteCTEntry

public static CTEntry deleteCTEntry(long ctEntryId)
                             throws 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:

PortalException - if a ct entry with the primary key could not be found

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(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> java.util.List<T> dynamicQuery(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> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 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(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(DynamicQuery dynamicQuery,
                                     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)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCTCollectionCTEntries

public static java.util.List<CTEntry> getCTCollectionCTEntries(long ctCollectionId)

getCTCollectionCTEntries

public static java.util.List<CTEntry> getCTCollectionCTEntries(long ctCollectionId,
                                                               int start,
                                                               int end,
                                                               OrderByComparator<CTEntry> orderByComparator)

getCTCollectionCTEntriesCount

public static int getCTCollectionCTEntriesCount(long ctCollectionId)

getCTEntries

public static java.util.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 java.util.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 PortalException

Returns the ct entry with the primary key.

Parameters:

ctEntryId - the primary key of the ct entry

Returns:

the ct entry

Throws:

PortalException - if a ct entry with the primary key could not be found

getCTRowCTCollectionId

public static long getCTRowCTCollectionId(CTEntry ctEntry)
                                   throws PortalException

Throws:

PortalException

getExclusiveModelClassPKs

public static java.util.List<java.lang.Long> getExclusiveModelClassPKs(long ctCollectionId,
                                                                       long modelClassNameId)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

hasCTEntries

public static boolean hasCTEntries(long ctCollectionId,
                                   long modelClassNameId)

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

getService

public static CTEntryLocalService getService()