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

Interface	osid.hold.rules.IssueProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session creates, updates, and deletes `IssueProcessors`. 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 an `IssueProcessor`, an `IssueProcessorForm` is requested using `getIssueProcessorFormForCreate(`) specifying the desired record `Types` or none if no record `Types` are needed. The returned `IssueProcessornForm` 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 `IssueProcessorForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IssueProcessornForm` corresponds to an attempted transaction. For updates, `IssueProcessornForms` are requested to the `IssueProcessor` `Id` that is to be updated using `getIssueProcessorFormForUpdate()`. Similarly, the `IssueProcessorForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IssueProcessorForm` can only be used once for a successful update and cannot be reused. The delete operations delete `IssueProcessors`. To unmap an `IssueProcessor` from the current `Oubliette`, the `IssueProcessorOublietteeAssignmentSessio` n should be used. These delete operations attempt to remove the `IssueProcessor` 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	canCreateIssueProcessors
Description	Tests if this user can create `IssueProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `IssueProcessor` will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIssueProcessorWithRecordTypes
Description	Tests if this user can create a single `IssueProcessor` using the desired record types. While `Hold.rulesManager.getIssueProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `IssueProcessor`. Providing an empty array tests if an `IssueProcessor` can be created with no records.
Parameters	`osid.type.Type[]`	`issueProcessorRecordTypes`	array of issue processor record types
Return	`boolean`		`true` if `IssueProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorFormForCreate
Description	Gets the issue processor form for creating new issue processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`issueProcessorRecordTypes`	array of issue processor record types
Return	`osid.hold.rules.IssueProcessorForm`		the issue processor form
Errors	NULL_ARGUMENT		`issueProcessorRecordTypes` 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	createIssueProcessor
Description	Creates a new `IssueProcessor`.
Parameters	`osid.hold.rules.IssueProcessorForm`	`issueProcessorForm`	the form for this `IssueProcessor`
Return	`osid.hold.rules.IssueProcessor`		the new `IssueProcessor`
Errors	ILLEGAL_STATE		`issueProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`issueProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorForm` did not originate from `getIssueProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIssueProcessors
Description	Tests if this user can update `IssueProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `IssueProcessor` will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorFormForUpdate
Description	Gets the issue processor form for updating an existing issue processor. A new issue processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`issueProcessorId`	the `Id` of the `IssueProcessor`
Return	`osid.hold.rules.IssueProcessorForm`		the issue processor form
Errors	NOT_FOUND		`issueProcessorId` is not found
	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateIssueProcessor
Description	Updates an existing issue processor.
Parameters	`osid.hold.rules.IssueProcessorForm`	`issueProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`issueProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`issueProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorForm` did not originate from `getIssueProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIssueProcessors
Description	Tests if this user can delete `IssueProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `IssueProcessor` will result in a `PERMISSION_DENIED. Th` is is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIssueProcessor
Description	Deletes an `IssueProcessor`.
Parameters	`osid.id.Id`	`issueProcessorId`	the `Id` of the `IssueProcessor` to remove
Errors	NOT_FOUND		`issueProcessorId` not found
	NULL_ARGUMENT		`issueProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIssueProcessorAliases
Description	Tests if this user can manage `Id` aliases for `IssueProcessors` 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 `IssueProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIssueProcessor
Description	Adds an `Id` to an `IssueProcessor` for the purpose of creating compatibility. The primary `Id` of the `IssueProcessor` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another issue processor, it is reassigned to the given issue processor `Id`.
Parameters	`osid.id.Id`	`issueProcessorId`	the `Id` of an `IssueProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`issueProcessorId` not found
	NULL_ARGUMENT		`issueProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.