public interface ProvisionReturn extends OsidObject, Subjugateable
A ProvisionReturn
captures data related to the return of
a provision.
Modifier and Type | Method and Description |
---|---|
ProvisionReturnRecord |
getProvisionReturnRecord(Type provisionReturnRecordType)
Gets the provision return record corresponding to the given
ProvisionReturn record Type. |
DateTime |
getReturnDate()
Gets the date returned.
|
Resource |
getReturner()
Gets the returner.
|
Id |
getReturnerId()
Gets the
Id of the returner resource. |
Agent |
getReturningAgent()
Gets the returning agent.
|
Id |
getReturningAgentId()
Gets the
Id of the returning agent. |
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
DateTime getReturnDate()
mandatory
- This method must be implemented. Id getReturnerId()
Id
of the returner resource. Id
mandatory
- This method must be implemented. Resource getReturner() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. Id getReturningAgentId()
Id
of the returning agent. Id
mandatory
- This method must be implemented. Agent getReturningAgent() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. ProvisionReturnRecord getProvisionReturnRecord(Type provisionReturnRecordType) throws OperationFailedException
ProvisionReturn
record Type.
This method is
used to retrieve an object implementing the requested record. The
provisionReturnRecordType
may be the Type
returned in getRecordTypes()
or any of its
parents in a Type
hierarchy where
hasRecordType(provisionReturnRecordType)
is true
.provisionReturnRecordType
- the type of provision return record
to retrieveNullArgumentException
-
provisionReturnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionReturnRecordType)
is
false
mandatory
- This method must be implemented.