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

Interface	osid.hold.rules.IssueEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session creates, updates, and deletes `IssueEnablers` . 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 `IssueEnabler` , an `IssueEnablerForm` is requested using `getIssueEnablerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `IssueEnablernForm` 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 `IssueEnablerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IssueEnablernForm` corresponds to an attempted transaction. For updates, `IssueEnablernForms` are requested to the `IssueEnabler` `Id` that is to be updated using `getIssueEnablerFormForUpdate()` . Similarly, the `IssueEnablerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IssueEnablerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `IssueEnablers` . To unmap an `IssueEnabler` from the current `Oubliette` , the `IssueEnablerOublietteeAssignmentSession` should be used. These delete operations attempt to remove the `IssueEnabler` 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	canCreateIssueEnablers
Description	Tests if this user can create `IssueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `IssueEnabler` 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 `IssueEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIssueEnablerWithRecordTypes
Description	Tests if this user can create a single `IssueEnabler` using the desired record types. While `Hold.rulesManager.getIssueEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `IssueEnabler` . Providing an empty array tests if an `IssueEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`issueEnablerRecordTypes`	array of issue enabler record types
Return	`boolean`		`true` if `IssueEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerFormForCreate
Description	Gets the issue enabler form for creating new issue enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`issueEnablerRecordTypes`	array of issue enabler record types
Return	`osid.hold.rules.IssueEnablerForm`		the issue enabler form
Errors	NULL_ARGUMENT		`issueEnablerRecordTypes` 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	createIssueEnabler
Description	Creates a new `IssueEnabler` .
Parameters	`osid.hold.rules.IssueEnablerForm`	`issueEnablerForm`	the form for this `IssueEnabler`
Return	`osid.hold.rules.IssueEnabler`		the new `IssueEnabler`
Errors	ILLEGAL_STATE		`issueEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`issueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueEnablerForm` did not originate from `getIssueEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIssueEnablers
Description	Tests if this user can update `IssueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `IssueEnabler` 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 `IssueEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueEnablerFormForUpdate
Description	Gets the issue enabler form for updating an existing issue enabler. A new issue enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`issueEnablerId`	the `Id` of the `IssueEnabler`
Return	`osid.hold.rules.IssueEnablerForm`		the issue enabler form
Errors	NOT_FOUND		`issueEnablerId` is not found
	NULL_ARGUMENT		`issueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateIssueEnabler
Description	Updates an existing issue enabler.
Parameters	`osid.hold.rules.IssueEnablerForm`	`issueEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`issueEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`issueEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueEnablerForm` did not originate from `getIssueEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIssueEnablers
Description	Tests if this user can delete `IssueEnablers` . A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `IssueEnabler` 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 `IssueEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIssueEnabler
Description	Deletes an `IssueEnabler` .
Parameters	`osid.id.Id`	`issueEnablerId`	the `Id` of the `IssueEnabler` to remove
Errors	NOT_FOUND		`issueEnablerId` not found
	NULL_ARGUMENT		`issueEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIssueEnablerAliases
Description	Tests if this user can manage `Id` aliases for `IssueEnablers` 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 `IssueEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIssueEnabler
Description	Adds an `Id` to an `IssueEnabler` for the purpose of creating compatibility. The primary `Id` of the `IssueEnabler` 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 enabler, it is reassigned to the given issue enabler `Id` .
Parameters	`osid.id.Id`	`issueEnablerId`	the `Id` of an `IssueEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`issueEnablerId` not found
	NULL_ARGUMENT		`issueEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.