org.gcube.accounting.datamodel

Class BasicUsageRecord

java.lang.Object

org.gcube.documentstore.records.implementation.AbstractRecord

org.gcube.accounting.datamodel.BasicUsageRecord

All Implemented Interfaces:

Serializable, Comparable<Record>, UsageRecord, Record

Direct Known Subclasses:

AbstractJobUsageRecord, AbstractPortletUsageRecord, AbstractServiceUsageRecord, AbstractStorageStatusRecord, AbstractStorageUsageRecord

public abstract class BasicUsageRecord
extends AbstractRecord
implements UsageRecord

Author:

Luca Frosini (ISTI - CNR)

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.gcube.accounting.datamodel.UsageRecord

UsageRecord.OperationResult

Field Summary

Fields inherited from interface org.gcube.accounting.datamodel.UsageRecord

CONSUMER_ID, OPERATION_RESULT, SCOPE

Constructor Summary

Constructors

Constructor and Description
BasicUsageRecord()
BasicUsageRecord(Map<String,? extends Serializable> properties)

Method Summary

Modifier and Type	Method and Description
String	getConsumerId() Return the user (or the Consumer Identity, that in the S2S communication is another service)
UsageRecord.OperationResult	getOperationResult()
String	getRecordType() Return the Record Type
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	setOperationResult(UsageRecord.OperationResult operationResult) Set the Operation Result related to the accounted Usage Record
void	setScope(String scope) Set the scope of the {#UsageRecord}

Methods inherited from class org.gcube.documentstore.records.implementation.AbstractRecord

compareTo, getAggregatedFields, getComputedFields, getCreationTime, getId, getQuerableKeys, getRequiredFields, getResourceProperties, getResourceProperty, removeResourceProperty, setCreationTime, setId, setResourceProperties, setResourceProperty, timestampToCalendar, toString, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

BasicUsageRecord

public BasicUsageRecord()

BasicUsageRecord

public BasicUsageRecord(Map<String,? extends Serializable> properties)
                 throws InvalidValueException

Throws:

InvalidValueException

Method Detail

getConsumerId

public String getConsumerId()

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

Specified by:

getConsumerId in interface UsageRecord

Returns:

Consumer ID

setConsumerId

public void setConsumerId(String consumerId)
                   throws InvalidValueException

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

Specified by:

setConsumerId in interface UsageRecord

Parameters:

consumerId - Consumer ID

Throws:

InvalidValueException

getRecordType

public String getRecordType()

Description copied from interface: Record

Return the Record Type

Specified by:

getRecordType in interface Record

Returns:

Record Type

getScope

public String getScope()

Return the scope of this {#UsageRecord}

Specified by:

getScope in interface UsageRecord

Returns:

The scope of this {#UsageRecord}

setScope

public void setScope(String scope)
              throws InvalidValueException

Set the scope of the {#UsageRecord}

Specified by:

setScope in interface UsageRecord

Parameters:

scope - the scope of the {#UsageRecord}

Throws:

InvalidValueException

getOperationResult

public UsageRecord.OperationResult getOperationResult()

Specified by:

getOperationResult in interface UsageRecord

Returns:

the Operation Result of the accounted operation.

setOperationResult

public void setOperationResult(UsageRecord.OperationResult operationResult)
                        throws InvalidValueException

Set the Operation Result related to the accounted Usage Record

Specified by:

setOperationResult in interface UsageRecord

Parameters:

operationResult - the Operation Result to set

Throws:

InvalidValueException