@ProviderType
public interface CTManager
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> |
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> |
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.
|
java.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId, long userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry)
companyId
- the primary key of the companyuserId
- the primary key of the userownerCTEntry
- the change bag's ownerrelatedCTEntry
- the change to add to the bagjava.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId, long userId, CTEntry ownerCTEntry, CTEntry relatedCTEntry, boolean force)
companyId
- the primary key of the companyuserId
- the primary key of the userownerCTEntry
- the owner of the change bagrelatedCTEntry
- the change to add to the bagforce
- whether to override the existing change entry aggregatejava.util.Optional<CTEntryAggregate> addRelatedCTEntry(long companyId, long userId, long ownerCTEntryId, long relatedCTEntryId)
companyId
- the primary key of the companyuserId
- the primary key of the userownerCTEntryId
- the primary key of the change bag's ownerrelatedCTEntryId
- the primary key of the change to add to the bag<T> T executeModelUpdate(com.liferay.petra.function.UnsafeSupplier<T,com.liferay.portal.kernel.exception.PortalException> modelUpdateSupplier) throws com.liferay.portal.kernel.exception.PortalException
isModelUpdateInProgress()
will
return true
.modelUpdateSupplier
- the supplier that performs the add or update
and supplies the resulting modelcom.liferay.portal.kernel.exception.PortalException
java.util.Optional<CTEntry> getActiveCTCollectionCTEntryOptional(long companyId, long userId, long modelClassNameId, long modelClassPK)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modeljava.util.Optional<CTCollection> getActiveCTCollectionOptional(long companyId, long userId)
companyId
- the primary key of the companyuserId
- the primary key of the userjava.util.List<CTEntry> getCTCollectionCTEntries(long companyId, long ctCollectionId, long classNameId)
companyId
- the primary key of the companyctCollectionId
- the primary key of the selected change collectionclassNameId
- the class name primary keyjava.util.List<CTCollection> getCTCollections(long companyId, long userId, boolean includeProduction, boolean includeActive, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)
companyId
- the primary key of the companyincludeProduction
- whether to return the production change listincludeActive
- whether to return the active change listsqueryDefinition
- the settings regarding pagination, order and
filterjava.util.Optional<CTEntryAggregate> getCTEntryAggregateOptional(CTEntry ctEntry, CTCollection ctCollection)
ctEntry
- the model change entryctCollection
- the model change entry collectionjava.util.Optional<CTEntry> getLatestModelChangeCTEntryOptional(long companyId, long userId, long modelResourcePrimKey)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelResourcePrimKey
- the primary key of the changed resource
modeljava.util.List<CTEntry> getModelChangeCTEntries(long companyId, long userId, long modelResourcePrimKey)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelResourcePrimKey
- the primary key of the changed resource
modeljava.util.List<CTEntry> getModelChangeCTEntries(long companyId, long userId, long modelResourcePrimKey, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelResourcePrimKey
- the primary key of the changed resource
modelqueryDefinition
- the settings regarding pagination, order, and
filterjava.util.Optional<CTEntryAggregate> getModelChangeCTEntryAggregateOptional(long companyId, long userId, long modelClassNameId, long modelClassPK)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modeljava.util.Optional<CTEntry> getModelChangeCTEntryOptional(long companyId, long userId, long modelClassNameId, long modelClassPK)
companyId
- the primary key of the companyuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modeljava.util.Optional<CTEntry> getProductionCTCollectionCTEntryOptional(long companyId, long modelClassNameId, long modelClassPK)
companyId
- the primary key of the companymodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modeljava.util.List<CTEntry> getRelatedCTEntries(CTEntry ctEntry, CTCollection ctCollection)
ctEntry
- the model change entryctCollection
- the model change entry collectionint getRelatedOwnerCTEntriesCount(long ctEntryId)
ctEntryId
- a model change entryboolean isModelUpdateInProgress()
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.true
if a model addition or update is in progress;
false
otherwisejava.util.Optional<CTEntry> registerModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType) throws CTEngineException
DuplicateCTEntryException
is thrown if the change tracking
entry already exists with the same model class name ID and model class
primary key.companyId
- the company IDuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modelmodelResourcePrimKey
- the primary key of the changed resource
modelchangeType
- the model change's typeCTEngineException
java.util.Optional<CTEntry> registerModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK, long modelResourcePrimKey, int changeType, boolean force) throws CTEngineException
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.companyId
- the company IDuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version modelmodelResourcePrimKey
- the primary key of the changed resource
modelchangeType
- the model change's typeforce
- whether to override an existing change entryCTEngineException
<V extends com.liferay.portal.kernel.model.BaseModel> void registerRelatedChanges(long companyId, long userId, long classNameId, long classPK)
companyId
- the company IDuserId
- the primary key of the userclassNameId
- the primary key of the owner version model's classclassPK
- the primary key of the owner version model<V extends com.liferay.portal.kernel.model.BaseModel> void registerRelatedChanges(long companyId, long userId, long classNameId, long classPK, boolean force)
companyId
- the company IDuserId
- the primary key of the userclassNameId
- the primary key of the owner version model's classclassPK
- the primary key of the owner version modelforce
- whether to override the existing change entry aggregatejava.util.Optional<CTEntry> unregisterModelChange(long companyId, long userId, long modelClassNameId, long modelClassPK)
companyId
- the company IDuserId
- the primary key of the usermodelClassNameId
- the primary key of the changed version model's
classmodelClassPK
- the primary key of the changed version model