org.gcube.accounting.datamodel

Interface UsageRecord

All Superinterfaces:

Comparable<UsageRecord>

All Known Subinterfaces:

AggregatedUsageRecord<T>, SingleUsageRecord

All Known Implementing Classes:

BasicUsageRecord, JobUsageRecord, JobUsageRecord, PortletUsageRecord, PortletUsageRecord, RawUsageRecord, ServiceUsageRecord, ServiceUsageRecord, StorageStatusUsageRecord, StorageUsageRecord, StorageUsageRecord, TaskUsageRecord

public interface UsageRecord
extends Comparable<UsageRecord>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UsageRecord.OperationResult

Method Summary

Methods

Modifier and Type	Method and Description
String	getAggregatedUsageRecordId() Return the id of the usage record aggregating this, null if this record has not been aggregated by any record.
String	getConsumerId() Return the identity of the entity that consumed the resource
Calendar	getCreationTime() Return the creation time for this {#UsageRecord}
String	getCreatorId() Return the identity of the entity creating this {#UsageRecord}
String	getId() Return the unique id for this {#UsageRecord}
UsageRecord.OperationResult	getOperationResult()
Map<String,Serializable>	getResourceProperties() Return all resource-specific properties.
Serializable	getResourceProperty(String key) Return the value of the given resource property.
String	getResourceScope() Return the accounting scope of the {#UsageRecord}
void	setAggregatedUsageRecordId(String aggregatedId) Set the id of the usage record aggregating this
void	setConsumerId(String consumerId) Set the identity of the entity that consumed the resource
void	setCreationTime(Calendar creationTime) Set the creation time for this {#UsageRecord}
void	setCreatorId(String creatorId) Set the identity of the entity creating this {#UsageRecord}
void	setId(String id) Set the unique id for this {#UsageRecord}
void	setOperationResult(UsageRecord.OperationResult operationResult) Set the Operation Result related to the accounted Usage Record
void	setResourceProperties(Map<String,Serializable> resourceSpecificProperties) Set all resource-specific properties, replacing existing ones
void	setResourceProperty(String key, Serializable value) Set the value of the given resource property.
void	setResourceScope(String scope) Set the accounting scope of the {#UsageRecord}
void	validate() Validate the Resource Record

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getId

String getId()

Return the unique id for this {#UsageRecord}

Returns:

{#UsageRecord} Unique ID

setId

void setId(String id)
           throws InvalidValueException

Set the unique id for this {#UsageRecord}

Parameters:

id - {#UsageRecord} Unique ID

Throws:

InvalidValueException

getCreatorId

String getCreatorId()

Return the identity of the entity creating this {#UsageRecord}

Returns:

Creator ID

setCreatorId

void setCreatorId(String creatorId)
                  throws InvalidValueException

Set the identity of the entity creating this {#UsageRecord}

Parameters:

creatorId - Creator ID

Throws:

InvalidValueException

getConsumerId

String getConsumerId()

Return the identity of the entity that consumed the resource

Returns:

Consumer ID

setConsumerId

void setConsumerId(String consumerId)
                   throws InvalidValueException

Set the identity of the entity that consumed the resource

Parameters:

consumerId - Consumer ID

Throws:

InvalidValueException

getCreationTime

Calendar getCreationTime()

Return the creation time for this {#UsageRecord}

Returns:

the creation time for this {#UsageRecord}

setCreationTime

void setCreationTime(Calendar creationTime)
                     throws InvalidValueException

Set the creation time for this {#UsageRecord}

Parameters:

creationTime - creation time

Throws:

InvalidValueException

getResourceScope

String getResourceScope()

Return the accounting scope of the {#UsageRecord}

Returns:

The Accounting scope of the {#UsageRecord}

setResourceScope

void setResourceScope(String scope)
                      throws InvalidValueException

Set the accounting scope of the {#UsageRecord}

Parameters:

scope - The accounting scope of the {#UsageRecord}

Throws:

InvalidValueException

getAggregatedUsageRecordId

String getAggregatedUsageRecordId()

Return the id of the usage record aggregating this, null if this record has not been aggregated by any record.

Returns:

Aggregated Id The ID of the aggregation Record

setAggregatedUsageRecordId

void setAggregatedUsageRecordId(String aggregatedId)
                                throws InvalidValueException

Set the id of the usage record aggregating this

Parameters:

aggregatedId - The ID of the aggregation Record

Throws:

InvalidValueException

getResourceProperties

Map<String,Serializable> getResourceProperties()

Return all resource-specific properties. The returned Map is a copy of the internal representation. Any modification to the returned Map MUST not affect the object

Returns:

a Map containing the properties

setResourceProperties

void setResourceProperties(Map<String,Serializable> resourceSpecificProperties)
                           throws InvalidValueException

Set all resource-specific properties, replacing existing ones

Throws:

InvalidValueException

getResourceProperty

Serializable getResourceProperty(String key)

Return the value of the given resource property.

Parameters:

key - the key of the requested property

Returns:

the value of the given resource property

setResourceProperty

void setResourceProperty(String key,
                       Serializable value)
                         throws InvalidValueException

Set the value of the given resource property. If the key has the value of one of the predefined property, the value is validated.

Parameters:

key - the key of the requested property

value - the value of the given resource property

Throws:

InvalidValueException

getOperationResult

UsageRecord.OperationResult getOperationResult()

Returns:

the Operation Result related to the accounted Usage Record

setOperationResult

void setOperationResult(UsageRecord.OperationResult operationResult)
                        throws InvalidValueException

Set the Operation Result related to the accounted Usage Record

Parameters:

operationResult - the Operation Result to set

Throws:

InvalidValueException

validate

void validate()
              throws InvalidValueException

Validate the Resource Record

Throws:

InvalidValueException