org.osid.acknowledgement

Interface Credit

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal

public interface Credit
extends OsidRelationship

A Credit relates a Resource with a reference to an Id .

Method Summary

Methods

Modifier and Type	Method and Description
CreditRecord	getCreditRecord(Type creditRecordType) Gets the record corresponding to the given Credit record Type.
Id	getReferenceId() Gets the Id of the referenced object.
Resource	getResource() Gets the resource in this credit.
Id	getResourceId() Gets the Id of the resource in this credit.

Methods inherited from interface org.osid.OsidRelationship

getEndReason, getEndReasonId, hasEndReason

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Temporal

getEndDate, getStartDate, isEffective

Method Detail

getReferenceId

Id getReferenceId()

Gets the Id of the referenced object.

Returns:

the reference Id

Compliance:

mandatory - This method must be implemented.

getResourceId

Id getResourceId()

Gets the Id of the resource in this credit.

Returns:

the Resource Id

Compliance:

mandatory - This method must be implemented.

getResource

Resource getResource()
                     throws OperationFailedException

Gets the resource in this credit.

Returns:

the Resource

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getCreditRecord

CreditRecord getCreditRecord(Type creditRecordType)
                             throws OperationFailedException

Gets the record corresponding to the given Credit record Type. This method is used to retrieve an object implementing the requested record. The creditRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(creditRecordType) is true .

Parameters:

creditRecordType - the type of credit record to retrieve

Returns:

the credit record

Throws:

NullArgumentException - creditRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(creditRecordType) is false

Compliance:

mandatory - This method must be implemented.