OSID - osid.hold.HoldAdminSession Service Interface Definition

Interface	osid.hold.HoldAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.hold.batch.HoldBatchAdminSession`
Used By	`osid.hold.HoldManager`
Used By	`osid.hold.HoldProxyManager`
Description	This session creates, updates, and deletes `Holds`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Hold`, a `HoldForm` is requested using `getHoldFormForCreate()` specifying the desired relationship peers and record `Types` or none if no record `Types` are needed. The returned `HoldForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `HoldForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `HoldForm` corresponds to an attempted transaction. For updates, `HoldForms` are requested to the `Hold` `Id` that is to be updated using `getHoldFormForUpdate()`. Similarly, the `HoldForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `HoldForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Holds`. To unmap a `Hold` from the current `Oubliette`, the `HoldOublietteAssignmentSession` should be used. These delete operations attempt to remove the `Hold` itself thus removing it from all known `Oubliette` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getOublietteId
Description	Gets the `Oubliette` `Id` associated with this session.
Return	`osid.id.Id`		the `Oubliette Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getOubliette
Description	Gets the `Oubliette` associated with this session.
Return	`osid.hold.Oubliette`		the oubliette
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateHolds
Description	Tests if this user can create `Holds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Hold` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Hold` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateHoldWithRecordTypes
Description	Tests if this user can create a single `Hold` using the desired record types. While `HoldManager.getHoldRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Hold`. Providing an empty array tests if a `Hold` can be created with no records.
Parameters	`osid.type.Type[]`	`holdRecordTypes`	array of hold record types
Return	`boolean`		`true` if `Hold` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`holdRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldFormForCreateForResource
Description	Gets the hold form for creating new holds. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`issueId`	the `Id` for the issue
	`osid.id.Id`	`resourceId`	the `Id` for the resource
	`osid.type.Type[]`	`holdRecordTypes`	array of hold record types
Return	`osid.hold.HoldForm`		the hold form
Errors	NOT_FOUND		`issueId` or `resourceId` is not found
	NULL_ARGUMENT		`issueId, resourceId` or `holdRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	getHoldFormForCreateForAgent
Description	Gets the hold form for creating new holds. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`issueId`	the `Id` for the issue
	`osid.id.Id`	`agentId`	the `Id` for the agent
	`osid.type.Type[]`	`holdRecordTypes`	array of hold record types
Return	`osid.hold.HoldForm`		the hold form
Errors	NOT_FOUND		`issueId` or `agentId` is not found
	NULL_ARGUMENT		`issueId, agentId` or `holdRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createHold
Description	Creates a new `Hold`.
Parameters	`osid.hold.HoldForm`	`holdForm`	the form for this `Hold`
Return	`osid.hold.Hold`		the new `Hold`
Errors	ILLEGAL_STATE		`holdForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`holdForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdForm` did not originate from `getHoldFormForCreateForResource()` or `getHoldFormForCreateForAgent()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateHolds
Description	Tests if this user can update `Holds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Hold` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Hold` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldFormForUpdate
Description	Gets the hold form for updating an existing hold. A new hold form should be requested for each update transaction.
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold`
Return	`osid.hold.HoldForm`		the hold form
Errors	NOT_FOUND		`holdId` is not found
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateHold
Description	Updates an existing hold.
Parameters	`osid.hold.HoldForm`	`holdForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`holdForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`holdId` or `holdForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdForm` did not originate from `getHoldFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteHolds
Description	Tests if this user can delete `Holds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Hold` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Hold` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteHold
Description	Deletes a `Hold`.
Parameters	`osid.id.Id`	`holdId`	the `Id` of the `Hold` to remove
Errors	NOT_FOUND		`holdId` not found
	NULL_ARGUMENT		`holdId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageHoldAliases
Description	Tests if this user can manage `Id` aliases for `Holds`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Hold` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasHold
Description	Adds an `Id` to a `Hold` for the purpose of creating compatibility. The primary `Id` of the `Hold` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another hold, it is reassigned to the given hold `Id`.
Parameters	`osid.id.Id`	`holdId`	the `Id` of a `Hold`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`holdId` not found
	NULL_ARGUMENT		`holdId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.