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

Interface	osid.hold.rules.IssueProcessorEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session creates, updates, and deletes `IssueProcessorEnablers` . 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 `IssueProcessorEnabler` , an `IssueProcessorEnablerForm` is requested using `getIssueProcessorEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `IssueProcessorEnablerForm` 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 `IssueProcessorEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IssueProcessorEnablerForm` corresponds to an attempted transaction. For updates, `IssueProcessorEnablerForms` are requested to the `IssueProcessorEnabler` `Id` that is to be updated using `getIssueProcessorEnablerFormForUpdate()` . Similarly, the `IssueProcessorEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IssueProcessorEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `IssueProcessorEnablers` . To unmap an `IssueProcessorEnabler` from the current `Oubliette` , the `IssueProcessorEnablerOublietteAssignmentSession` should be used. These delete operations attempt to remove the `IssueProcessorEnabler` 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	canCreateIssueProcessorEnablers
Description	Tests if this user can create `IssueProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `IssueProcessorEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessorEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIssueProcessorEnablerWithRecordTypes
Description	Tests if this user can create a single `IssueProcessorEnabler` using the desired record types. While `HoldRulesManager.getIssueProcessorEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `IssueProcessorrEnabler` . Providing an empty array tests if an `IssueProcessorEnabler can be cr` eated with no records.
Parameters	`osid.type.Type[]`	`issueProcessorEnablerRecordTypes`	array of issue processor enabler record types
Return	`boolean`		`true` if `IssueProcessorEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueProcessorEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerFormForCreate
Description	Gets the issue processor enabler form for creating new issue processor enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`issueProcessorEnablerRecordTypes`	array of issue processor enabler record types
Return	`osid.hold.rules.IssueProcessorEnablerForm`		the issue processor enabler form
Errors	NULL_ARGUMENT		`issueProcessorEnablerRecordTypes` 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	createIssueProcessorEnabler
Description	Creates a new `IssueProcessorEnabler` .
Parameters	`osid.hold.rules.IssueProcessorEnablerForm`	`issueProcessorEnablerForm`	the form for this `IssueProcessorEnabler`
Return	`osid.hold.rules.IssueProcessorEnabler`		the new `IssueProcessorEnabler`
Errors	ILLEGAL_STATE		`issueProcessorEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`issueProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorEnablerForm` did not originate from `getIssueProcessorEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIssueProcessorEnablers
Description	Tests if this user can update `IssueProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `IssueProcessorEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessorEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueProcessorEnablerFormForUpdate
Description	Gets the issue processor enabler form for updating an existing issue processor enabler. A new issue processor enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`issueProcessorEnablerId`	the `Id` of the `IssueProcessorEnabler`
Return	`osid.hold.rules.IssueProcessorEnablerForm`		the issue processor enabler form
Errors	NOT_FOUND		`issueProcessorEnablerId` is not found
	NULL_ARGUMENT		`issueProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateIssueProcessorEnabler
Description	Updates an existing issue processor enabler.
Parameters	`osid.hold.rules.IssueProcessorEnablerForm`	`issueProcessorEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`issueProcessorEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`issueProcessorEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueProcessorEnablerForm` did not originate from `getIssueProcessorEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIssueProcessorEnablers
Description	Tests if this user can delete `IssueProcessorEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `IssueProcessorEnabler` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `IssueProcessorEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIssueProcessorEnabler
Description	Deletes an `IssueProcessorEnabler` .
Parameters	`osid.id.Id`	`issueProcessorEnablerId`	the `Id` of the `IssueProcessorEnabler` to remove
Errors	NOT_FOUND		`issueProcessorEnablerId` not found
	NULL_ARGUMENT		`issueProcessorEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIssueProcessorEnablerAliases
Description	Tests if this user can manage `Id` aliases for `IssueProcessorEnablers` 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 `IssueProcessorEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIssueProcessorEnabler
Description	Adds an `Id` to an `IssueProcessorEnabler` for the purpose of creating compatibility. The primary `Id` of the `IssueProcessorEnabler` 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 enabler, it is reassigned to the given issue processor enabler `Id` .
Parameters	`osid.id.Id`	`issueProcessorEnablerId`	the `Id` of an `IssueProcessorEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`issueProcessorEnablerId` not found
	NULL_ARGUMENT		`issueProcessorEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.