OSID - osid.hold.Hold Service Interface Definition

Interface	osid.hold.Hold
Implements	`osid.OsidRelationship`
Description	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.`
Method	getIssueId
Description	Gets the `Id` of the issue.
Return	`osid.id.Id`		the issue `Id`
Compliance	`mandatory`		This method must be implemented.
Method	getIssue
Description	Gets the issue.
Return	`osid.hold.Issue`		the issue
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasResource
Description	Tests if this hold is for a `Resource.`
Return	`boolean`		`true` if this hold has a `Resource,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getResourceId
Description	Gets the `Id` of resource.
Return	`osid.id.Id`		the resource `Id`
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getResource
Description	Gets the resources that can be assigned to an issue.
Return	`osid.resource.Resource`		the resource
Errors	ILLEGAL_STATE		`hasResource()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	hasAgent
Description	Tests if this hold is for an `Agent.`
Return	`boolean`		`true` if this hold has an `Agent,` `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAgentId
Description	Gets the `Agent Id` for this hold.
Return	`osid.id.Id`		the `Agent Id`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Compliance	`mandatory`		This method must be implemented.
Method	getAgent
Description	Gets the `Agent` for this hold.
Return	`osid.authentication.Agent`		the `Agent`
Errors	ILLEGAL_STATE		`hasAgent()` is `false`
Errors	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	getHoldRecord
Description	Gets the hold record corresponding to the given `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` .
Parameters	`osid.type.Type`	`holdRecordType`	the type of hold record to retrieve
Return	`osid.hold.records.HoldRecord`		the hold record
Errors	NULL_ARGUMENT		`holdRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure occurred
	UNSUPPORTED		`hasRecordType(holdRecordType)` is `false`
Compliance	`mandatory`		This method must be implemented.