OSID - osid.hold.batch.HoldBatchForm Service Interface Definition

Interface	osid.hold.batch.HoldBatchForm
Implements	`osid.hold.HoldForm`
Used By	`osid.hold.batch.HoldBatchFormList`
Description	This is the form for creating and updating holds in bulk. Like all `OsidForms`, various data elements may be set here for use in the create and update methods in the `HoldBatchAdminSession`. For each data element that may be set, metadata may be examined to provide display hints or data constraints.
Method	getIssueId
Description	Gets the issue `Id` of the issue if this is a create transaction.
Return	`osid.id.Id`	the issue `Id`
Errors	ILLEGAL_STATE	`isForUpdate()` is `true`
Compliance	`mandatory`	This method must be implemented.
Method	hasAgent
Description	Tests if this create form was requested using an agent.
Return	`boolean`	`true` if the create request specified an agent, `false` otherwise
Errors	ILLEGAL_STATE	`isForUpdate()` is `true`
Compliance	`mandatory`	This method must be implemented.
Method	getAgentId
Description	Gets the agent `Id` of the issue if this is a create transaction.
Return	`osid.id.Id`	the agent `Id`
Errors	ILLEGAL_STATE	`isForUpdate()` is `true` or `hasAgent()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	hasResource
Description	Tests if this create form was requested using a resource.
Return	`boolean`	`true` if the create request specified a resource, `false` otherwise
Errors	ILLEGAL_STATE	`isForUpdate()` is `true`
Compliance	`mandatory`	This method must be implemented.
Method	getResourceId
Description	Gets the resource `Id` of the issue if this is a create transaction.
Return	`osid.id.Id`	the resource `Id`
Errors	ILLEGAL_STATE	`isForUpdate()` is `true` or `hasResource()` is `false`
Compliance	`mandatory`	This method must be implemented.
Method	getHoldId
Description	Gets the `Id` of the hold to be updated if this is an update transaction.
Return	`osid.id.Id`	the hold `Id`
Errors	ILLEGAL_STATE	`isForUpdate()` is `false`
Compliance	`mandatory`	This method must be implemented.