OSID - osid.hold.rules.HoldEnablerAdminSession Service Interface Definition

Interface	osid.hold.rules.HoldEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes hold enablers. The data for create and update is provided via the `HoldEnablerForm.`
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	canCreateHoldEnabler
Description	Tests if this user can create hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `HoldEnabler` 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 `HoldEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateHoldEnablerWithRecordTypes
Description	Tests if this user can create a single `HoldEnabler` using the desired record types. While `HoldRulesManager.getHoldEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `HoldEnabler.` Providing an empty array tests if a `HoldEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`holdEnablerRecordTypes`	array of hold enabler record types
Return	`boolean`		`true` if `HoldEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`holdEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablerFormForCreate
Description	Gets the hold enabler form for creating new hold enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`holdEnablerRecordTypes`	array of hold enabler record types
Return	`osid.hold.rules.HoldEnablerForm`		the hold enabler form
Errors	NULL_ARGUMENT		`holdEnablerRecordTypes` 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	createHoldEnabler
Description	Creates a new `HoldEnabler.`
Parameters	`osid.hold.rules.HoldEnablerForm`	`holdEnablerForm`	the form for this `HoldEnabler`
Return	`osid.hold.rules.HoldEnabler`		the new `HoldEnabler`
Errors	ILLEGAL_STATE		`holdEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`holdEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdEnablerForm` did not originate from `getHoldEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateHoldEnablers
Description	Tests if this user can update hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `HoldEnabler` 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 `HoldEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getHoldEnablerFormForUpdate
Description	Gets the hold enabler form for updating an existing hold enabler. A new hold enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of the `HoldEnabler`
Return	`osid.hold.rules.HoldEnablerForm`		the hold enabler form
Errors	NOT_FOUND		`holdEnablerId` is not found
	NULL_ARGUMENT		`holdEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateHoldEnabler
Description	Updates an existing hold enabler.
Parameters	`osid.hold.rules.HoldEnablerForm`	`holdEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`holdEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`holdEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`holdEnablerForm` did not originate from `getHoldEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteHoldEnablers
Description	Tests if this user can delete hold enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `HoldEnabler` 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 `HoldEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteHoldEnabler
Description	Deletes a `HoldEnabler.`
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of the `HoldEnabler` to remove
Errors	NOT_FOUND		`holdEnablerId` not found
	NULL_ARGUMENT		`holdEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageHoldEnablerAliases
Description	Tests if this user can manage `Id` aliases for hold enablers. 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 `HoldEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasHoldEnabler
Description	Adds an `Id` to a `HoldEnabler` for the purpose of creating compatibility. The primary `Id` of the `HoldEnabler` 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 enabler. it is reassigned to the given hold enabler `Id.`
Parameters	`osid.id.Id`	`holdEnablerId`	the `Id` of a `HoldEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`holdEnablerId` not found
	NULL_ARGUMENT		`holdEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.