public interface Hold extends OsidRelationship
A Hold
is an Issue applicable to a Resource
or Agent.
The effective dates of the relationship
specify the duration of the hold. A Hold
defined for a
Resource
is effective for all Agents
related
to the Resource.
Modifier and Type | Method and Description |
---|---|
Agent |
getAgent()
Gets the
Agent for this hold. |
Id |
getAgentId()
Gets the
Agent Id for this hold. |
HoldRecord |
getHoldRecord(Type holdRecordType)
Gets the hold record corresponding to the given
Hold
record Type. |
Issue |
getIssue()
Gets the issue.
|
Id |
getIssueId()
Gets the
Id of the issue. |
Resource |
getResource()
Gets the resources that can be assigned to an issue.
|
Id |
getResourceId()
Gets the
Id of resource. |
boolean |
hasAgent()
Tests if this hold is for an
Agent. |
boolean |
hasResource()
Tests if this hold is for a
Resource. |
getEndReason, getEndReasonId, hasEndReason
getDescription, getDisplayName, getGenusType, isOfGenusType
getId, isCurrent
getRecordTypes, hasRecordType
getProperties, getPropertiesByRecordType
getEndDate, getStartDate, isEffective
Id getIssueId()
Id
of the issue. Id
mandatory
- This method must be implemented. Issue getIssue() throws OperationFailedException
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasResource()
Resource.
true
if this hold has a Resource,
false
otherwisemandatory
- This method must be implemented. Id getResourceId()
Id
of resource. Id
IllegalStateException
- hasResource()
is
false
mandatory
- This method must be implemented. Resource getResource() throws OperationFailedException
IllegalStateException
- hasResource()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. boolean hasAgent()
Agent.
true
if this hold has an Agent,
false
otherwisemandatory
- This method must be implemented. Id getAgentId()
Agent Id
for this hold. Agent Id
IllegalStateException
- hasAgent()
is
false
mandatory
- This method must be implemented. Agent getAgent() throws OperationFailedException
Agent
for this hold. Agent
IllegalStateException
- hasAgent()
is
false
OperationFailedException
- unable to complete requestmandatory
- This method must be implemented. HoldRecord getHoldRecord(Type holdRecordType) throws OperationFailedException, PermissionDeniedException
Hold
record Type.
This method is used to retrieve an object
implementing the requested record. The holdRecordType
may be the Type
returned in getRecordTypes()
or any of its parents in a Type
hierarchy where
hasRecordType(holdRecordType)
is true
.holdRecordType
- the type of hold record to retrieveNullArgumentException
- holdRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
-
hasRecordType(holdRecordType)
is false
mandatory
- This method must be implemented.