com.liferay.change.tracking.engine

Interface CTManager

@ProviderType
public interface CTManager

Provides functionality to register and retrieve model changes from the change tracking framework.

Method Summary

Modifier and Type	Method and Description
java.util.Optional<CTEntryAggregate>	addRelatedCTEntry(long companyId, long userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry) Assigns a model change to the change entry aggregate associated with the owner model change.
java.util.Optional<CTEntryAggregate>	addRelatedCTEntry(long companyId, long userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry, boolean force) Assigns a model change to the change entry aggregate associated with the owner model change.
java.util.Optional<CTEntryAggregate>	addRelatedCTEntry(long companyId, long userId, long ownerCTEntryId, long relatedCTEntryId) Assigns a model change to the change entry aggregate associated with the owner model change.
<T> T	executeModelUpdate(com.liferay.petra.function.UnsafeSupplier<T,com.liferay.portal.kernel.exception.PortalException> modelUpdateSupplier) Executes a model addition or update using the given supplier, toggling the flag that indicates the update before and after the operation.
java.util.Optional<CTEntry>	getActiveCTCollectionCTEntryOptional(long companyId, long userId, long modelClassNameId, long modelClassPK) Returns the model change of the current user's active change collection.
java.util.Optional<CTCollection>	getActiveCTCollectionOptional(long companyId, long userId) Returns the user's active change collection in the given company.
java.util.List<CTEntry>	getCTCollectionCTEntries(long companyId, long ctCollectionId, long classNameId) Returns the list change entries associated with the given change collections and class name ID.
java.util.List<CTCollection>	getCTCollections(long companyId, long userId, boolean includeProduction, boolean includeActive, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition) Returns change tracking collections associated with the given company, optionally including production or active change lists.
java.util.Optional<CTEntryAggregate>	getCTEntryAggregateOptional(CTEntry ctEntry, CTCollection ctCollection) Returns the change entry aggregate containing the change entry and change entry collection.
java.util.Optional<CTEntry>	getLatestModelChangeCTEntryOptional(long companyId, long userId, long modelResourcePrimKey) Returns the latest model change for the current user's active change collection.
java.util.List<CTEntry>	getModelChangeCTEntries(long companyId, long userId, long modelResourcePrimKey) Returns all model changes for a given resource model for the current user's active change collection.
java.util.List<CTEntry>	getModelChangeCTEntries(long companyId, long userId, long modelResourcePrimKey, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Returns all model changes for a given resource model for the current user's active change collection.
java.util.Optional<CTEntryAggregate>	getModelChangeCTEntryAggregateOptional(long companyId, long userId, long modelClassNameId, long modelClassPK) Returns a model change's bag, first searching for it in the current user's active change collection; if it doesn't exist there, the production change collection is searched.
java.util.Optional<CTEntry>	getModelChangeCTEntryOptional(long companyId, long userId, long modelClassNameId, long modelClassPK) Returns a model change, first searching for it in the current user's active change collection; if it doesn't exist there, the production change collection is searched.
java.util.Optional<CTEntry>	getProductionCTCollectionCTEntryOptional(long companyId, long modelClassNameId, long modelClassPK) Returns a model change from the production change collection.
java.util.List<CTEntry>	getRelatedCTEntries(CTEntry ctEntry, CTCollection ctCollection) Returns the change related change entries associated with the given change entry collection.
int	getRelatedOwnerCTEntriesCount(long ctEntryId) Returns the number of change related change entries associated with the given change entry.
boolean	isModelUpdateInProgress() Returns true if a model addition or update is in progress.
java.util.Optional<CTEntry>	registerModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType) Registers the model change into the change tracking framework for the current user's active change collection.
java.util.Optional<CTEntry>	registerModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType, boolean force) Registers a model change into the change tracking framework for the current user's active change collection.
<V extends com.liferay.portal.kernel.model.BaseModel> void	registerRelatedChanges(long companyId, long userId, long classNameId, long classPK) Assigns all related model changes to a change entry aggregate associated with the owner model change.
<V extends com.liferay.portal.kernel.model.BaseModel> void	registerRelatedChanges(long companyId, long userId, long classNameId, long classPK, boolean force) Assigns all related model changes to a change entry aggregate associated with the owner model change.
java.util.Optional<CTEntry>	unregisterModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK) Unregisters a model change from the change tracking framework.

Method Detail

addRelatedCTEntry

java.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId,
                                                       long userId,
                                                       CTEntry ownerCTEntry,
                                                       CTEntry relatedCTEntry)

Assigns a model change to the change entry aggregate associated with the owner model change. If there is no change aggregate associated with the owner, it creates a new one. Also, a new aggregate is created if the related entry was already part of the aggregate and is being changed.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

ownerCTEntry - the change bag's owner

relatedCTEntry - the change to add to the bag

Returns:

the created or updated change entry aggregate

addRelatedCTEntry

java.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId,
                                                       long userId,
                                                       CTEntry ownerCTEntry,
                                                       CTEntry relatedCTEntry,
                                                       boolean force)

Assigns a model change to the change entry aggregate associated with the owner model change. If there is no change aggregate associated with the owner, it creates a new one. Also, a new aggregate is created if the related entry was already part of the aggregate and is being changed, unless you force the override of the existing change entry aggregate.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

ownerCTEntry - the owner of the change bag

relatedCTEntry - the change to add to the bag

force - whether to override the existing change entry aggregate

Returns:

the created or updated change entry aggregate

addRelatedCTEntry

java.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId,
                                                       long userId,
                                                       long ownerCTEntryId,
                                                       long relatedCTEntryId)

Assigns a model change to the change entry aggregate associated with the owner model change. If there is no change aggregate associated with the owner, it creates a new one. Also, a new aggregate is created if the related entry was already part of the aggregate and is being changed.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

ownerCTEntryId - the primary key of the change bag's owner

relatedCTEntryId - the primary key of the change to add to the bag

Returns:

the created or updated change entry aggregate

executeModelUpdate

<T> T executeModelUpdate(com.liferay.petra.function.UnsafeSupplier<T,com.liferay.portal.kernel.exception.PortalException> modelUpdateSupplier)
                  throws com.liferay.portal.kernel.exception.PortalException

Executes a model addition or update using the given supplier, toggling the flag that indicates the update before and after the operation. Therefore, during the execution, isModelUpdateInProgress() will return true.

Parameters:

modelUpdateSupplier - the supplier that performs the add or update and supplies the resulting model

Returns:

the created or updated model

Throws:

com.liferay.portal.kernel.exception.PortalException

getActiveCTCollectionCTEntryOptional

java.util.Optional<CTEntry> getActiveCTCollectionCTEntryOptional(long companyId,
                                                                 long userId,
                                                                 long modelClassNameId,
                                                                 long modelClassPK)

Returns the model change of the current user's active change collection.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

Returns:

the change tracking entry representing the model change

getActiveCTCollectionOptional

java.util.Optional<CTCollection> getActiveCTCollectionOptional(long companyId,
                                                               long userId)

Returns the user's active change collection in the given company.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

Returns:

the user's active change collection

getCTCollectionCTEntries

java.util.List<CTEntry> getCTCollectionCTEntries(long companyId,
                                                 long ctCollectionId,
                                                 long classNameId)

Returns the list change entries associated with the given change collections and class name ID.

Parameters:

companyId - the primary key of the company

ctCollectionId - the primary key of the selected change collection

classNameId - the class name primary key

Returns:

the list change entries associated with the given change collections and class name ID.

getCTCollections

java.util.List<CTCollection> getCTCollections(long companyId,
                                              long userId,
                                              boolean includeProduction,
                                              boolean includeActive,
                                              com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)

Returns change tracking collections associated with the given company, optionally including production or active change lists.

Parameters:

companyId - the primary key of the company

includeProduction - whether to return the production change list

includeActive - whether to return the active change lists

queryDefinition - the settings regarding pagination, order and filter

Returns:

the change tracking collections

getCTEntryAggregateOptional

java.util.Optional<CTEntryAggregate> getCTEntryAggregateOptional(CTEntry ctEntry,
                                                                 CTCollection ctCollection)

Returns the change entry aggregate containing the change entry and change entry collection.

Parameters:

ctEntry - the model change entry

ctCollection - the model change entry collection

Returns:

the change entry aggregate containing the change entry and change entry collection

getLatestModelChangeCTEntryOptional

java.util.Optional<CTEntry> getLatestModelChangeCTEntryOptional(long companyId,
                                                                long userId,
                                                                long modelResourcePrimKey)

Returns the latest model change for the current user's active change collection.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelResourcePrimKey - the primary key of the changed resource model

Returns:

the change tracking entry representing the model change

getModelChangeCTEntries

java.util.List<CTEntry> getModelChangeCTEntries(long companyId,
                                                long userId,
                                                long modelResourcePrimKey)

Returns all model changes for a given resource model for the current user's active change collection.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelResourcePrimKey - the primary key of the changed resource model

Returns:

a list of change tracking entries representing all the registered model changes

getModelChangeCTEntries

java.util.List<CTEntry> getModelChangeCTEntries(long companyId,
                                                long userId,
                                                long modelResourcePrimKey,
                                                com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

Returns all model changes for a given resource model for the current user's active change collection.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelResourcePrimKey - the primary key of the changed resource model

queryDefinition - the settings regarding pagination, order, and filter

Returns:

a list of change tracking entries representing the registered model changes

getModelChangeCTEntryAggregateOptional

java.util.Optional<CTEntryAggregate> getModelChangeCTEntryAggregateOptional(long companyId,
                                                                            long userId,
                                                                            long modelClassNameId,
                                                                            long modelClassPK)

Returns a model change's bag, first searching for it in the current user's active change collection; if it doesn't exist there, the production change collection is searched.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

Returns:

the change tracking entry representing the model change

getModelChangeCTEntryOptional

java.util.Optional<CTEntry> getModelChangeCTEntryOptional(long companyId,
                                                          long userId,
                                                          long modelClassNameId,
                                                          long modelClassPK)

Returns a model change, first searching for it in the current user's active change collection; if it doesn't exist there, the production change collection is searched.

Parameters:

companyId - the primary key of the company

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

Returns:

the change tracking entry representing the model change

getProductionCTCollectionCTEntryOptional

java.util.Optional<CTEntry> getProductionCTCollectionCTEntryOptional(long companyId,
                                                                     long modelClassNameId,
                                                                     long modelClassPK)

Returns a model change from the production change collection.

Parameters:

companyId - the primary key of the company

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

Returns:

the change tracking entry representing the model change

getRelatedCTEntries

java.util.List<CTEntry> getRelatedCTEntries(CTEntry ctEntry,
                                            CTCollection ctCollection)

Returns the change related change entries associated with the given change entry collection.

Parameters:

ctEntry - the model change entry

ctCollection - the model change entry collection

Returns:

the change related change entries associated with the given change entry collection

getRelatedOwnerCTEntriesCount

int getRelatedOwnerCTEntriesCount(long ctEntryId)

Returns the number of change related change entries associated with the given change entry.

Parameters:

ctEntryId - a model change entry

Returns:

the number of change related change entries associated with the given change entry

isModelUpdateInProgress

boolean isModelUpdateInProgress()

Returns true if a model addition or update is in progress. This only returns true if the addition or update is being executed with executeModelUpdate(UnsafeSupplier) and the execution is in progress. It's useful to bypass change tracking consideration when a get or fetch is executed for a model during its own addition or update.

Returns:

true if a model addition or update is in progress; false otherwise

registerModelChange

java.util.Optional<CTEntry> registerModelChange(long companyId,
                                                long userId,
                                                long modelClassNameId,
                                                long modelClassPK,
                                                long modelResourcePrimKey,
                                                int changeType)
                                         throws CTEngineException

Registers the model change into the change tracking framework for the current user's active change collection. A DuplicateCTEntryException is thrown if the change tracking entry already exists with the same model class name ID and model class primary key.

Parameters:

companyId - the company ID

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

modelResourcePrimKey - the primary key of the changed resource model

changeType - the model change's type

Returns:

the change tracking entry representing the registered model change

Throws:

CTEngineException

registerModelChange

java.util.Optional<CTEntry> registerModelChange(long companyId,
                                                long userId,
                                                long modelClassNameId,
                                                long modelClassPK,
                                                long modelResourcePrimKey,
                                                int changeType,
                                                boolean force)
                                         throws CTEngineException

Registers a model change into the change tracking framework for the current user's active change collection. A DuplicateCTEntryException is thrown if a change tracking entry already exists with the same model class name ID and model class primary key, unless you force the override of the existing change entry.

Parameters:

companyId - the company ID

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

modelResourcePrimKey - the primary key of the changed resource model

changeType - the model change's type

force - whether to override an existing change entry

Returns:

the change tracking entry representing the registered model change

Throws:

CTEngineException

registerRelatedChanges

<V extends com.liferay.portal.kernel.model.BaseModel> void registerRelatedChanges(long companyId,
                                                                                  long userId,
                                                                                  long classNameId,
                                                                                  long classPK)

Assigns all related model changes to a change entry aggregate associated with the owner model change. A new aggregate is created if the related entry was already part of the aggregate.

Parameters:

companyId - the company ID

userId - the primary key of the user

classNameId - the primary key of the owner version model's class

classPK - the primary key of the owner version model

registerRelatedChanges

<V extends com.liferay.portal.kernel.model.BaseModel> void registerRelatedChanges(long companyId,
                                                                                  long userId,
                                                                                  long classNameId,
                                                                                  long classPK,
                                                                                  boolean force)

Assigns all related model changes to a change entry aggregate associated with the owner model change. A new aggregate is created if the related entry was already part of the aggregate, unless you force the override of the existing change entry aggregate.

Parameters:

companyId - the company ID

userId - the primary key of the user

classNameId - the primary key of the owner version model's class

classPK - the primary key of the owner version model

force - whether to override the existing change entry aggregate

unregisterModelChange

java.util.Optional<CTEntry> unregisterModelChange(long companyId,
                                                  long userId,
                                                  long modelClassNameId,
                                                  long modelClassPK)

Unregisters a model change from the change tracking framework.

Parameters:

companyId - the company ID

userId - the primary key of the user

modelClassNameId - the primary key of the changed version model's class

modelClassPK - the primary key of the changed version model

Returns:

the change tracking entry that was deleted