@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 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.
|
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 settings regarding pagination, order, and
filter (keywords)java.util.Optional<CTCollection> createCTCollection(long userId, java.lang.String name, java.lang.String description) throws CTEngineException
userId
- the primary key of the user who initiated the actionname
- the change tracking collection's namedescription
- the change tracking collection's descriptionCTEngineException
void 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.Map<java.lang.Integer,java.lang.Long> getCTCollectionChangeTypeCounts(long ctCollectionId)
ctCollectionId
- the primary key of the change collectionjava.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 group primary keysuserIds
- the user primary keysclassNameIds
- the class name primary keyschangeTypes
- the change typescollision
- whether the change entries collide with the production
change collectionqueryDefinition
- the 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 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 group primary keysuserIds
- the user primary keysclassNameIds
- the class name primary keyschangeTypes
- the change typescollision
- whether the change entries collide with the production
change collectionqueryDefinition
- the settings regarding the status filteringint getCTEntriesCount(long ctCollectionId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTEntry> queryDefinition)
ctCollectionId
- the primary key of the change collectionqueryDefinition
- the settings regarding pagination, order and
status filteringjava.util.List<CTEntryAggregate> getCTEntryAggregates(long ctCollectionId)
ctCollectionId
- the primary key of the change collectionjava.util.List<CTProcess> getCTProcesses(long companyId, long userId, java.lang.String keywords, com.liferay.portal.kernel.dao.orm.QueryDefinition<?> queryDefinition)
companyId
- the company ID of the desired processesuserId
- the user ID of the user to filter the processes. If it's
not a valid user it's omitted from the filterkeywords
- the keywords to filter processes. If empty or
null
it's omitted from the filterqueryDefinition
- the settings regarding pagination, order and
status filteringjava.util.Optional<CTProcess> getLatestCTProcessOptional(long companyId)
companyId
- the company ID of the company to return the latest
change tracking process forjava.util.Optional<CTCollection> getProductionCTCollectionOptional(long companyId)
companyId
- the primary key of the companylong getRecentCTCollectionId(long userId)
userId
- the user's IDboolean isChangeTrackingAllowed(long companyId)
true
if change tracking is allowed for the given
company.companyId
- the primary key of the companytrue
if change tracking is allowed for the company;
false
otherwiseboolean isChangeTrackingEnabled(long companyId)
true
if change tracking is enabled for the company.companyId
- the primary key of the companytrue
if change tracking is enabled for the company;
false
otherwiseboolean isChangeTrackingSupported(long companyId, java.lang.Class<? extends com.liferay.portal.kernel.model.BaseModel> clazz)
true
if the given base model supports change
tracking.companyId
- the primary key of the companyclazz
- the class objecttrue
if the given base model supports change
tracking; false
otherwiseboolean isChangeTrackingSupported(long companyId, long modelClassNameId)
true
if the given base model supports change
tracking.companyId
- the primary key of the companymodelClassNameId
- the class name ID of the model classtrue
if the given base model supports change
tracking; false
otherwisevoid publishCTCollection(long userId, long ctCollectionId, boolean ignoreCollision)
userId
- the primary key of the userctCollectionId
- the primary key of the change collectionignoreCollision
- whether to publish the change tracking collection
if a collision is detectedjava.util.List<CTCollection> searchByKeywords(long companyId, com.liferay.portal.kernel.dao.orm.QueryDefinition<CTCollection> queryDefinition)
companyId
- the primary key of the companyqueryDefinition
- the settings regarding pagination, order, and
filter (keywords)