com.liferay.change.tracking

Interface CTEngineManager

@ProviderType
public interface CTEngineManager

Provides the main internal manager interface to interact with the Change Tracking framework.

Method Summary

Modifier and Type	Method and Description
void	checkoutCTCollection(long userId, long ctCollectionId) Changes the selected change tracking collection for the given user.
long	countByKeywords(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition) Returns the number of the change tracking collections associated with the given company and keywords.
java.util.Optional<CTCollection>	createCTCollection(long userId, java.lang.String name, java.lang.String description) Creates a new change tracking collection.
void	deleteCTCollection(long ctCollectionId) Deletes a change tracking collection.
void	disableChangeTracking(long companyId) Disables the change tracking functionality in the scope of the given company.
void	enableChangeTracking(long companyId, long userId) Enables the change tracking feature in the scope of the given company.
java.util.Optional<CTCollection>	getCTCollectionOptional(long ctCollectionId) Returns the change tracking collection identified by the primary key.
java.util.List<CTCollection>	getCTCollections(long companyId) Returns all the change tracking collection associated with the given company.
java.util.List<CTEntry>	getCTEntries(CTCollection ctCollection, long[] groupIds, long[] userIds, long[] classNameIds, int[] changeTypes, java.lang.Boolean collision, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Returns the filtered list of change entries associated with the given change collection.
java.util.List<CTEntry>	getCTEntries(long ctCollectionId) Returns all the change entries associated with the given change collection.
java.util.List<CTEntry>	getCTEntries(long ctCollectionId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Returns all the change entries associated with the given change collection.
int	getCTEntriesCount(CTCollection ctCollection, long[] groupIds, long[] userIds, long[] classNameIds, int[] changeTypes, java.lang.Boolean collision, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Returns the number of the filtered change entries associated with the given change collection.
java.util.List<CTEntryAggregate>	getCTEntryAggregates(long ctCollectionId) Returns all the change entry aggregates associated with the given change collection.
java.util.List<CTCollection>	getNonproductionCTCollections(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition) Returns all the non production change tracking collection associated with the given company.
java.util.Optional<CTCollection>	getProductionCTCollectionOptional(long companyId) Returns the special change tracking collection which is called production and contains all the changes published before.
long	getRecentCTCollectionId(long userId) Returns the recent change tracking collection ID for a specific user.
boolean	isChangeTrackingEnabled(long companyId) Returns true if the change tracking is enabled in the scope of the given company or false if not.
boolean	isChangeTrackingSupported(long companyId, java.lang.Class<? extends com.liferay.portal.kernel.model.BaseModel> clazz) Returns true if the given base model supports change tracking or false if not.
boolean	isChangeTrackingSupported(long companyId, long modelClassNameId) Returns true if the given base model supports change tracking or false if not.
void	publishCTCollection(long userId, long ctCollectionId, boolean ignoreCollision) Publishes all the change entries from the given change tracking collection to the production change tracking collection.
java.util.List<CTCollection>	searchByKeywords(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition) Returns all the change tracking collection associated with the given company and keywords.

Method Detail

checkoutCTCollection

void checkoutCTCollection(long userId,
                          long ctCollectionId)

Changes the selected change tracking collection for the given user.

Parameters:

userId - the primary key of the user

ctCollectionId - the primary key of the selected change collection

countByKeywords

long countByKeywords(long companyId,
                     com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)

Returns the number of the change tracking collections associated with the given company and keywords.

Parameters:

companyId - the primary key of the company

queryDefinition - the object contains settings regarding pagination, order and filter (keywords)

Returns:

the number of change tracking collections

createCTCollection

java.util.Optional<CTCollection> createCTCollection(long userId,
                                                    java.lang.String name,
                                                    java.lang.String description)

Creates a new change tracking collection.

Parameters:

userId - the primary key of the user who initiated the action

name - the name of the change tracking collection

description - the description of the change tracking collection

Returns:

the newly created change tracking collection

deleteCTCollection

void deleteCTCollection(long ctCollectionId)

Deletes a change tracking collection.

Parameters:

ctCollectionId - the primary key of the change collection

disableChangeTracking

void disableChangeTracking(long companyId)

Disables the change tracking functionality in the scope of the given company. As a side effect it deletes all the related change tracking collections and entries.

Parameters:

companyId - the primary key of the company

enableChangeTracking

void enableChangeTracking(long companyId,
                          long userId)

Enables the change tracking feature in the scope of the given company.

Parameters:

userId - the primary key of the user who initiated the action

getCTCollectionOptional

java.util.Optional<CTCollection> getCTCollectionOptional(long ctCollectionId)

Returns the change tracking collection identified by the primary key.

Parameters:

ctCollectionId - the primary key of the change collection

Returns:

the change tracking collection

getCTCollections

java.util.List<CTCollection> getCTCollections(long companyId)

Returns all the change tracking collection associated with the given company.

Parameters:

companyId - the primary key of the company

Returns:

the list of change tracking collections

getCTEntries

java.util.List<CTEntry> getCTEntries(CTCollection ctCollection,
                                     long[] groupIds,
                                     long[] userIds,
                                     long[] classNameIds,
                                     int[] changeTypes,
                                     java.lang.Boolean collision,
                                     com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

Returns the filtered list of change entries associated with the given change collection.

Parameters:

ctCollection - the primary key of the change collection

groupIds - the array of the group primary keys

userIds - the array of the user primary keys

classNameIds - the array of the class name primary keys

changeTypes - the array of the change types

collision - whether or not the change entries collide with the production change collection

queryDefinition - the object contains settings regarding pagination, order and status filtering

Returns:

the filtered list of change entries associated with the given change collection.

getCTEntries

java.util.List<CTEntry> getCTEntries(long ctCollectionId)

Returns all the change entries associated with the given change collection.

Parameters:

ctCollectionId - the primary key of the change collection

Returns:

the list of change entries

getCTEntries

java.util.List<CTEntry> getCTEntries(long ctCollectionId,
                                     com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

Returns all the change entries associated with the given change collection.

Parameters:

ctCollectionId - the primary key of the change collection

queryDefinition - the object contains settings regarding pagination, order and status filtering

Returns:

the list of change entries

getCTEntriesCount

int getCTEntriesCount(CTCollection ctCollection,
                      long[] groupIds,
                      long[] userIds,
                      long[] classNameIds,
                      int[] changeTypes,
                      java.lang.Boolean collision,
                      com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

Returns the number of the filtered change entries associated with the given change collection.

Parameters:

ctCollection - the primary key of the change collection

groupIds - the array of the group primary keys

userIds - the array of the user primary keys

classNameIds - the array of the class name primary keys

changeTypes - the array of the change types

collision - whether or not the change entries collide with the production change collection

queryDefinition - the object contains settings regarding the status filtering

Returns:

the number of filtered change tracking entries associated with the given change collection.

getCTEntryAggregates

java.util.List<CTEntryAggregate> getCTEntryAggregates(long ctCollectionId)

Returns all the change entry aggregates associated with the given change collection.

Parameters:

ctCollectionId - the primary key of the change collection

Returns:

the list of change entry aggregates

getNonproductionCTCollections

java.util.List<CTCollection> getNonproductionCTCollections(long companyId,
                                                           com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)

Returns all the non production change tracking collection associated with the given company.

Parameters:

companyId - the primary key of the company

queryDefinition - the object contains settings regarding pagination, order and filter

Returns:

the list of change tracking collections

getProductionCTCollectionOptional

java.util.Optional<CTCollection> getProductionCTCollectionOptional(long companyId)

Returns the special change tracking collection which is called production and contains all the changes published before.

Parameters:

companyId - the primary key of the company

Returns:

the production change tracking collection

getRecentCTCollectionId

long getRecentCTCollectionId(long userId)

Returns the recent change tracking collection ID for a specific user.

Parameters:

userId - the user ID of the user

Returns:

the recent change tracking collection ID

isChangeTrackingEnabled

boolean isChangeTrackingEnabled(long companyId)

Returns true if the change tracking is enabled in the scope of the given company or false if not.

Parameters:

companyId - the primary key of the company

Returns:

true if change tracking is enabled in the scope of the given company; false otherwise.

isChangeTrackingSupported

boolean isChangeTrackingSupported(long companyId,
                                  java.lang.Class<? extends com.liferay.portal.kernel.model.BaseModel> clazz)

Returns true if the given base model supports change tracking or false if not.

Parameters:

companyId - the primary key of the company

clazz - the class object

Returns:

true if the given base model supports change tracking; false otherwise.

isChangeTrackingSupported

boolean isChangeTrackingSupported(long companyId,
                                  long modelClassNameId)

Returns true if the given base model supports change tracking or false if not.

Parameters:

companyId - the primary key of the company

modelClassNameId - the class name ID of the model class

Returns:

true if the given base model supports change tracking; false otherwise.

publishCTCollection

void publishCTCollection(long userId,
                         long ctCollectionId,
                         boolean ignoreCollision)

Publishes all the change entries from the given change tracking collection to the production change tracking collection.

Parameters:

userId - the primary key of the user

ctCollectionId - the primary key of the change collection

ignoreCollision - publishing process will start anyway if true

searchByKeywords

java.util.List<CTCollection> searchByKeywords(long companyId,
                                              com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)

Returns all the change tracking collection associated with the given company and keywords.

Parameters:

companyId - the primary key of the company

queryDefinition - the object contains settings regarding pagination, order and filter (keywords)

Returns:

the list of change tracking collections