public interface Credit extends OsidRelationship
A Credit
relates a Resource
with a
reference to an Id
.
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. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getReferenceId()
Id
of the referenced object. Id
mandatory
- This method must be implemented. Id getResourceId()
Id
of the resource in this credit. Resource
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CreditRecord getCreditRecord(Type creditRecordType) throws OperationFailedException
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
.creditRecordType
- the type of credit record to retrieveNullArgumentException
- creditRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(creditRecordType)
is false
mandatory
- This method must be implemented.