com.day.cq.dam.usage.api

Interface AssetUsageTracker

public interface AssetUsageTracker

The AssetUsageTracker interface describes the methods for recording and accessing the asset usage record.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AssetUsageTracker.AggregateUsageInfo The Class AggregateUsageInfo, defines the meta properties for the asset usage information.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	LAST_USED The last used.
static java.lang.String	USAGE_COUNT The usage count.
static java.lang.String	USAGE_TYPE The asset usage type.

Method Summary

Modifier and Type	Method and Description
long	getAssetScore(Asset asset) Gets the asset score.
java.util.List<AssetUsageTracker.AggregateUsageInfo>	getUsageStats(Asset asset, java.util.List<java.lang.String> usagesType) Gets the asset usage stats.
void	recordUsage(Asset asset, AssetUsageRecord assetUsageRecord) Update the asset usages information with assetUsageRecord.

Field Detail

USAGE_COUNT

static final java.lang.String USAGE_COUNT

The usage count.

See Also:

Constant Field Values

LAST_USED

static final java.lang.String LAST_USED

The last used.

See Also:

Constant Field Values

USAGE_TYPE

static final java.lang.String USAGE_TYPE

The asset usage type.

See Also:

Constant Field Values

Method Detail

recordUsage

void recordUsage(Asset asset,
                 AssetUsageRecord assetUsageRecord)
          throws RepositoryException,
                 PersistenceException,
                 ReplicationException

Update the asset usages information with assetUsageRecord.

Parameters:

asset - the asset to update

assetUsageRecord - the new asset usage record

Throws:

RepositoryException - the repository exception

PersistenceException - the persistence exception

ReplicationException

getAssetScore

long getAssetScore(Asset asset)

Gets the asset score.

Parameters:

asset - asset for which score is required

Returns:

the asset score

getUsageStats

java.util.List<AssetUsageTracker.AggregateUsageInfo> getUsageStats(Asset asset,
                                                                   java.util.List<java.lang.String> usagesType)

Gets the asset usage stats.

Parameters:

asset - the asset for which information is required

usagesType - list of usages to be returned

Returns:

the list of AggregateUsageInfo for all the solutions in which this asset has been used.