public interface Commitment extends OsidRelationship
A Commitment
maps a Resource
to an
Event.
Modifier and Type | Method and Description |
---|---|
CommitmentRecord |
getCommitmentRecord(Type commitmentRecordType)
Gets the record corresponding to the given
Commitment
record Type. |
Event |
getEvent()
Gets the
Event. |
Id |
getEventId()
Gets the event
Id. |
Resource |
getResource()
Gets the
Resource. |
Id |
getResourceId()
Gets the resource
Id. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getEventId()
Id.
Id
mandatory
- This method must be implemented. Event getEvent() throws OperationFailedException
Event.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getResourceId()
Id.
Id
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
Resource.
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. CommitmentRecord getCommitmentRecord(Type commitmentRecordType) throws OperationFailedException
Commitment
record Type.
This method is used to retrieve an object
implementing the requested record. The commitmentRecordType
may be the Type
returned in
getRecordTypes()
or any of its parents in a Type
hierarchy where hasRecordType(commitmentRecordType)
is true
.commitmentRecordType
- the type of the record to retrieveNullArgumentException
- commitmentRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(commitmentRecordType)
is false
mandatory
- This method must be implemented.