@ProviderType
public interface CTEngineManager
| 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.
|
void checkoutCTCollection(long userId,
long ctCollectionId)
userId - the primary key of the userctCollectionId - the primary key of the selected change collectionlong countByKeywords(long companyId,
com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)
companyId - the primary key of the companyqueryDefinition - the object contains settings regarding
pagination, order and filter (keywords)java.util.Optional<CTCollection> createCTCollection(long userId, java.lang.String name, java.lang.String description)
userId - the primary key of the user who initiated the actionname - the name of the change tracking collectiondescription - the description of the change tracking collectionvoid deleteCTCollection(long ctCollectionId)
ctCollectionId - the primary key of the change collectionvoid disableChangeTracking(long companyId)
companyId - the primary key of the companyvoid enableChangeTracking(long companyId,
long userId)
userId - the primary key of the user who initiated the actionjava.util.Optional<CTCollection> getCTCollectionOptional(long ctCollectionId)
ctCollectionId - the primary key of the change collectionjava.util.List<CTCollection> getCTCollections(long companyId)
companyId - the primary key of the companyjava.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)
ctCollection - the primary key of the change collectiongroupIds - the array of the group primary keysuserIds - the array of the user primary keysclassNameIds - the array of the class name primary keyschangeTypes - the array of the change typescollision - whether or not the change entries collide with the
production change collectionqueryDefinition - the object contains settings regarding
pagination, order and status filteringjava.util.List<CTEntry> getCTEntries(long ctCollectionId)
ctCollectionId - the primary key of the change collectionjava.util.List<CTEntry> getCTEntries(long ctCollectionId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)
ctCollectionId - the primary key of the change collectionqueryDefinition - the object contains settings regarding
pagination, order and status filteringint getCTEntriesCount(CTCollection ctCollection, long[] groupIds, long[] userIds, long[] classNameIds, int[] changeTypes, java.lang.Boolean collision, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)
ctCollection - the primary key of the change collectiongroupIds - the array of the group primary keysuserIds - the array of the user primary keysclassNameIds - the array of the class name primary keyschangeTypes - the array of the change typescollision - whether or not the change entries collide with the
production change collectionqueryDefinition - the object contains settings regarding the status
filteringjava.util.List<CTEntryAggregate> getCTEntryAggregates(long ctCollectionId)
ctCollectionId - the primary key of the change collectionjava.util.List<CTCollection> getNonproductionCTCollections(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)
companyId - the primary key of the companyqueryDefinition - the object contains settings regarding
pagination, order and filterjava.util.Optional<CTCollection> getProductionCTCollectionOptional(long companyId)
companyId - the primary key of the companylong getRecentCTCollectionId(long userId)
userId - the user ID of the userboolean isChangeTrackingEnabled(long companyId)
true if the change tracking is enabled in the scope
of the given company or false if not.companyId - the primary key of the companytrue if change tracking is enabled in the scope of
the given company; false otherwise.boolean isChangeTrackingSupported(long companyId,
java.lang.Class<? extends com.liferay.portal.kernel.model.BaseModel> clazz)
true if the given base model supports change
tracking or false if not.companyId - the primary key of the companyclazz - the class objecttrue if the given base model supports change
tracking; false otherwise.boolean isChangeTrackingSupported(long companyId,
long modelClassNameId)
true if the given base model supports change
tracking or false if not.companyId - the primary key of the companymodelClassNameId - the class name ID of the model classtrue if the given base model supports change
tracking; false otherwise.void publishCTCollection(long userId,
long ctCollectionId,
boolean ignoreCollision)
userId - the primary key of the userctCollectionId - the primary key of the change collectionignoreCollision - publishing process will start anyway if truejava.util.List<CTCollection> searchByKeywords(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)
companyId - the primary key of the companyqueryDefinition - the object contains settings regarding
pagination, order and filter (keywords)