org.gcube.accounting.datamodel

Interface UsageRecord

All Superinterfaces:

Comparable<UsageRecord>

All Known Subinterfaces:

AggregatedUsageRecord<T,B>, SingleUsageRecord

All Known Implementing Classes:

BasicUsageRecord, JobUsageRecord, JobUsageRecord, JobUsageRecord, PortletUsageRecord, PortletUsageRecord, PortletUsageRecord, RawUsageRecord, ServiceUsageRecord, ServiceUsageRecord, ServiceUsageRecord, StorageUsageRecord, StorageUsageRecord, StorageUsageRecord, TaskUsageRecord, TaskUsageRecord, 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	getConsumerId() Return the user (or the Consumer Identity, that in the S2S communication is another service)
Calendar	getCreationTime() Return the instant when this {#UsageRecord} was created.
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	getScope() Return the scope of this {#UsageRecord}
void	setConsumerId(String consumerId) Set the user (or the Consumer Identity, that in the S2S communication is another service)
void	setCreationTime(Calendar creationTime) The CreationTime is automatically created by the implementation Class.
void	setId(String id) The ID is automatically Created by the implementation Class.
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	setScope(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

The ID is automatically Created by the implementation Class. Set the ID only if you really know what you are going to do. Set the unique id for this {#UsageRecord}

Parameters:

id - {#UsageRecord} Unique ID

Throws:

InvalidValueException

getConsumerId

String getConsumerId()

Return the user (or the Consumer Identity, that in the S2S communication is another service)

Returns:

Consumer ID

setConsumerId

void setConsumerId(String consumerId)
                   throws InvalidValueException

Set the user (or the Consumer Identity, that in the S2S communication is another service)

Parameters:

consumerId - Consumer ID

Throws:

InvalidValueException

getCreationTime

Calendar getCreationTime()

Return the instant when this {#UsageRecord} was created.

Returns:

the creation time for this {#UsageRecord}

setCreationTime

void setCreationTime(Calendar creationTime)
                     throws InvalidValueException

The CreationTime is automatically created by the implementation Class. Set the CreationTime only if you really know what you are going to do. Set the instant when this {#UsageRecord} was created.

Parameters:

creationTime - creation time

Throws:

InvalidValueException

getScope

String getScope()

Return the scope of this {#UsageRecord}

Returns:

The scope of this {#UsageRecord}

setScope

void setScope(String scope)
              throws InvalidValueException

Set the accounting scope of the {#UsageRecord}

Parameters:

scope - The accounting scope of the {#UsageRecord}

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 of the accounted operation.

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. The validation check if all the Required Field are set and has valid value.

Throws:

InvalidValueException