com.liferay.change.tracking.engine

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 change tracking collections 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 the change tracking collection.
void	disableChangeTracking(long companyId) Disables the change tracking functionality for the given company.
void	enableChangeTracking(long companyId, long userId) Enables the change tracking feature for the given company.
java.util.Map<java.lang.Integer,java.lang.Long>	getCTCollectionChangeTypeCounts(long ctCollectionId) Returns the number of changes per change type within a given change tracking collection.
java.util.Optional<CTCollection>	getCTCollectionOptional(long ctCollectionId) Returns the change tracking collection with the primary key.
java.util.List<CTCollection>	getCTCollections(long companyId) Returns all the change tracking collections 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 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 and query definition.
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 change entries associated with the given change collection and filters.
int	getCTEntriesCount(long ctCollectionId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Returns the number of the 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<CTProcess>	getCTProcesses(long companyId, long userId, java.lang.String keywords, com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition) Returns the change tracking processes.
java.util.Optional<CTProcess>	getLatestCTProcessOptional(long companyId) Returns the latest change tracking process executed for a given company.
java.util.Optional<CTCollection>	getProductionCTCollectionOptional(long companyId) Returns the production change tracking collection that contains all the changes published before.
long	getRecentCTCollectionId(long userId) Returns the recent change tracking collection ID for the user.
boolean	isChangeTrackingAllowed(long companyId) Returns true if change tracking is allowed for the given company.
boolean	isChangeTrackingEnabled(long companyId) Returns true if change tracking is enabled for the company.
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.
boolean	isChangeTrackingSupported(long companyId, long modelClassNameId) Returns true if the given base model supports change tracking.
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 collections 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 change tracking collections with the given company and keywords.

Parameters:

companyId - the primary key of the company

queryDefinition - the 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)
                                             throws CTEngineException

Creates a new change tracking collection.

Parameters:

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

name - the change tracking collection's name

description - the change tracking collection's description

Returns:

the new change tracking collection

Throws:

CTEngineException

deleteCTCollection

void deleteCTCollection(long ctCollectionId)

Deletes the change tracking collection.

Parameters:

ctCollectionId - the primary key of the change collection

disableChangeTracking

void disableChangeTracking(long companyId)

Disables the change tracking functionality for 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 for the given company.

Parameters:

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

getCTCollectionChangeTypeCounts

java.util.Map<java.lang.Integer,java.lang.Long> getCTCollectionChangeTypeCounts(long ctCollectionId)

Returns the number of changes per change type within a given change tracking collection.

Parameters:

ctCollectionId - the primary key of the change collection

Returns:

the change counts per change type

getCTCollectionOptional

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

Returns the change tracking collection with 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 collections associated with the given company.

Parameters:

companyId - the primary key of the company

Returns:

the 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 change entries associated with the given change collection.

Parameters:

ctCollection - the primary key of the change collection

groupIds - the group primary keys

userIds - the user primary keys

classNameIds - the class name primary keys

changeTypes - the change types

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

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

Returns:

the 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 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 and query definition.

Parameters:

ctCollectionId - the primary key of the change collection

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

Returns:

the 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 change entries associated with the given change collection and filters.

Parameters:

ctCollection - the primary key of the change collection

groupIds - the group primary keys

userIds - the user primary keys

classNameIds - the class name primary keys

changeTypes - the change types

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

queryDefinition - the settings regarding the status filtering

Returns:

the number of change tracking entries with the given change collection and filters

getCTEntriesCount

int getCTEntriesCount(long ctCollectionId,
                      com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

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

Parameters:

ctCollectionId - the primary key of the change collection

queryDefinition - the settings regarding pagination, order and status filtering

Returns:

the number of change entries

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 change entry aggregates

getCTProcesses

java.util.List<CTProcess> getCTProcesses(long companyId,
                                         long userId,
                                         java.lang.String keywords,
                                         com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)

Returns the change tracking processes.

Parameters:

companyId - the company ID of the desired processes

userId - the user ID of the user to filter the processes. If it's not a valid user it's omitted from the filter

keywords - the keywords to filter processes. If empty or null it's omitted from the filter

queryDefinition - the settings regarding pagination, order and status filtering

Returns:

the change tracking processes filtered based on the parameters

getLatestCTProcessOptional

java.util.Optional<CTProcess> getLatestCTProcessOptional(long companyId)

Returns the latest change tracking process executed for a given company.

Parameters:

companyId - the company ID of the company to return the latest change tracking process for

Returns:

the latest change tracking process for the given company

getProductionCTCollectionOptional

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

Returns the production change tracking collection that 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 the user.

Parameters:

userId - the user's ID

Returns:

the recent change tracking collection ID

isChangeTrackingAllowed

boolean isChangeTrackingAllowed(long companyId)

Returns true if change tracking is allowed for the given company.

Parameters:

companyId - the primary key of the company

Returns:

true if change tracking is allowed for the company; false otherwise

isChangeTrackingEnabled

boolean isChangeTrackingEnabled(long companyId)

Returns true if change tracking is enabled for the company.

Parameters:

companyId - the primary key of the company

Returns:

true if change tracking is enabled for the 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.

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.

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 - whether to publish the change tracking collection if a collision is detected

searchByKeywords

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

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

Parameters:

companyId - the primary key of the company

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

Returns:

the change tracking collections