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

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