com.liferay.change.tracking

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 userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry) Puts a model change to a change entry aggregate associated with the owner model change.
java.util.Optional<CTEntryAggregate>	addRelatedCTEntry(long userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry, boolean force) Puts a model change to a change entry aggregate associated with the owner model change.
java.util.Optional<CTEntryAggregate>	addRelatedCTEntry(long userId, long ownerCTEntryId, long relatedCTEntryId) Puts a model change to a 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, with setting and un-setting the flag that indicates the update before and after the operation.
java.util.Optional<CTEntry>	getActiveCTCollectionCTEntryOptional(long userId, long modelClassNameId, long modelClassPK) Retrieves a model change in the context of the current user's active change collection.
java.util.Optional<CTCollection>	getActiveCTCollectionOptional(long userId) Returns the active change tracking collection associated with the given user in the scope of the given company.
java.util.Optional<CTEntryAggregate>	getCTEntryAggregateOptional(CTEntry ctEntry, CTCollection ctCollection) Returns the change entry aggregate containing the given change entry and associated with the given change entry collection.
java.util.Optional<CTEntry>	getLatestModelChangeCTEntryOptional(long userId, long modelResourcePrimKey) Retrieves the latest model change in the context of the current user's active change collection.
java.util.List<CTEntry>	getModelChangeCTEntries(long userId, long modelResourcePrimKey) Retrieves all model changes in the context of the current user's active change collection.
java.util.List<CTEntry>	getModelChangeCTEntries(long userId, long modelResourcePrimKey, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition) Retrieves a paginated and ordered list of all model changes in the context of the current user's active change collection.
java.util.Optional<CTEntryAggregate>	getModelChangeCTEntryAggregateOptional(long userId, long modelClassNameId, long modelClassPK) Retrieves a model change's bag, first looking for it in the current user's active change collection, and if it doesn't exist, looking for it in the production change collection
java.util.Optional<CTEntry>	getModelChangeCTEntryOptional(long userId, long modelClassNameId, long modelClassPK) Retrieves a model change, first looking for it in the current user's active change collection, and if it doesn't exist, looking for it in the production change collection
java.util.Optional<CTEntry>	getProductionCTCollectionCTEntryOptional(long userId, long modelClassNameId, long modelClassPK) Retrieves a model change from the production change collection.
java.util.List<CTEntry>	getRelatedCTEntries(CTEntry ctEntry, CTCollection ctCollection) Returns the list of change related change entries associated with the given change entry collection.
boolean	isModelUpdateInProgress() Indicates whether an add or update is in progress for a model.
java.util.Optional<CTEntry>	registerModelChange(long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType) Registers a model change into the change tracking framework in the context of the current user's active change collection.
java.util.Optional<CTEntry>	registerModelChange(long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType, boolean force) Registers a model change into the change tracking framework in the context of the current user's active change collection.
<V extends com.liferay.portal.kernel.model.BaseModel> void	registerRelatedChanges(long userId, long classNameId, long classPK) Puts 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 userId, long classNameId, long classPK, boolean force) Puts all related model changes to a change entry aggregate associated with the owner model change.
java.util.Optional<CTEntry>	unregisterModelChange(long userId, long modelClassNameId, long modelClassPK) Unregisters a model change from the change tracking framework.

Method Detail

addRelatedCTEntry

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

Puts a model change to a 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 creates a new aggregate if the related entry was already part of the aggregate, and it is being changed.

Parameters:

userId - the primary key of the user

ownerCTEntry - the owner of the change bag

relatedCTEntry - the change to add to the bag

Returns:

the created or updated change entry aggregate

addRelatedCTEntry

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

Puts a model change to a 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 creates a new aggregate if the related entry was already part of the aggregate, and it is being changed, except when the force attribute is true.

Parameters:

userId - the primary key of the user

ownerCTEntry - the owner of the change bag

relatedCTEntry - the change to add to the bag

force - forces to override existing change entry in aggregate

Returns:

the created or updated change entry aggregate

addRelatedCTEntry

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

Puts a model change to a 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 creates a new aggregate if the related entry was already part of the aggregate, and it is being changed.

Parameters:

userId - the primary key of the user

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

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, with setting and un-setting 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 of type T

Throws:

com.liferay.portal.kernel.exception.PortalException

getActiveCTCollectionCTEntryOptional

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

Retrieves a model change in the context of the current user's active change collection.

Parameters:

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 userId)

Returns the active change tracking collection associated with the given user in the scope of the given company.

Parameters:

userId - the primary key of the user

Returns:

the selected change tracking collection

getCTEntryAggregateOptional

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

Returns the change entry aggregate containing the given change entry and associated with the given change entry collection.

Parameters:

ctEntry - a model change entry

ctCollection - a model change entry collection

Returns:

the change entry aggregate containing the given change entry and associated with the given change entry collection.

getLatestModelChangeCTEntryOptional

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

Retrieves the latest model change in the context of the current user's active change collection.

Parameters:

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 userId,
                                                long modelResourcePrimKey)

Retrieves all model changes in the context of the current user's active change collection.

Parameters:

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 userId,
                                                long modelResourcePrimKey,
                                                com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)

Retrieves a paginated and ordered list of all model changes in the context of the current user's active change collection.

Parameters:

userId - the primary key of the user

modelResourcePrimKey - the primary key of the changed resource model

queryDefinition - the object contains 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 userId,
                                                                            long modelClassNameId,
                                                                            long modelClassPK)

Retrieves a model change's bag, first looking for it in the current user's active change collection, and if it doesn't exist, looking for it in the production change collection

Parameters:

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 userId,
                                                          long modelClassNameId,
                                                          long modelClassPK)

Retrieves a model change, first looking for it in the current user's active change collection, and if it doesn't exist, looking for it in the production change collection

Parameters:

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 userId,
                                                                     long modelClassNameId,
                                                                     long modelClassPK)

Retrieves a model change from the production change collection.

Parameters:

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

getRelatedCTEntries

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

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

Parameters:

ctEntry - a model change entry

ctCollection - a model change entry collection

Returns:

the list of change related change entries associated with the given change entry collection.

isModelUpdateInProgress

boolean isModelUpdateInProgress()

Indicates whether an add or update is in progress for a model. This will only return true if the add or update is being executed with executeModelUpdate(UnsafeSupplier) and the execution is in progress. Useful to be able to bypass change tracking consideration when a get or fetch is executed for a model during it's own addition or update.

Returns:

true if an add or update is in progress for a model using executeModelUpdate(UnsafeSupplier)

registerModelChange

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

Registers a model change into the change tracking framework in the context of the current user's active change collection. Throws DuplicateCTEntryException if a change tracking entry already exists with the same modelClassNameId and modelClassPK.

Parameters:

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 type of the model change

Returns:

the change tracking entry representing the registered model change

Throws:

CTException

registerModelChange

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

Registers a model change into the change tracking framework in the context of the current user's active change collection. Throws DuplicateCTEntryException if a change tracking entry already exists with the same modelClassNameId and modelClassPK, except when the force attribute is true.

Parameters:

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 type of the model change

force - forces to override an existing change entry

Returns:

the change tracking entry representing the registered model change

Throws:

CTException

registerRelatedChanges

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

Puts all related model changes to a change entry aggregate associated with the owner model change. Creates a new aggregate if the related entry was already part of the aggregate.

Parameters:

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 userId,
                                                                                  long classNameId,
                                                                                  long classPK,
                                                                                  boolean force)

Puts all related model changes to a change entry aggregate associated with the owner model change. Creates a new aggregate if the related entry was already part of the aggregate, except when the force attribute is true.

Parameters:

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 - forces to override existing change entry in aggregate

unregisterModelChange

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

Unregisters a model change from the change tracking framework.

Parameters:

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