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

Interface	osid.hold.rules.IssueConstrainerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.hold.rules.HoldRulesManager`
Used By	`osid.hold.rules.HoldRulesProxyManager`
Description	This session creates, updates, and deletes `IssueConstraine` rs. 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 `IssueConstrain` er, an `IssueConstrainerF` orm is requested using `getIssueConstraierFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `IssueConstrainernF` orm 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 `IssueConstrainerF` orm is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IssueConstrainernF` orm corresponds to an attempted transaction. For updates, `IssueConstrainernFo` rms are requested to the `IssueConstrai` ner `Id` that is to be updated using `getIssueConstrainerFormForUpdate` (). Similarly, the `IssueConstrainerF` orm has metadata about the data that can be updated and it can perform validation before submitting the update. The `IssueConstrainerF` orm can only be used once for a successful update and cannot be reused. The delete operations delete `IssueConstraine` rs. To unmap an `IssueConstrai` ner from the current `Oubliette` , the `IssueConstrainerOublietteeAssignmentSess` ion should be used. These delete operations attempt to remove the `IssueConstrai` ner 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	canCreateIssueConstrainers
Description	Tests if this user can create `IssueConstraine` rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `IssueConstrai` ner 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 `IssueConstrainer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIssueConstrainerWithRecordTypes
Description	Tests if this user can create a single `IssueConstrain` er using the desired record types. While `Hold.rulesManager.getIssueConstrainerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `IssueConstrain` er. Providing an empty array tests if an `IssueConstrainer` can be created with no records.
Parameters	`osid.type.Type[]`	`issueConstrainerRecordTypes`	array of issue constrainer record types
Return	`boolean`		`true` if `IssueConstrainer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueConstrainerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerFormForCreate
Description	Gets the issue constrainer form for creating new issue constrainers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`issueConstrainerRecordTypes`	array of issue constrainer record types
Return	`osid.hold.rules.IssueConstrainerForm`		the issue constrainer form
Errors	NULL_ARGUMENT		`issueConstrainerRecordTypes` 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	createIssueConstrainer
Description	Creates a new `IssueConstrainer` .
Parameters	`osid.hold.rules.IssueConstrainerForm`	`issueConstrainerForm`	the form for this `IssueConstrainer`
Return	`osid.hold.rules.IssueConstrainer`		the new `IssueConstrainer`
Errors	ILLEGAL_STATE		`issueConstrainerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`issueConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueConstrainerForm` did not originate from `getIssueConstrainerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIssueConstrainers
Description	Tests if this user can update `IssueConstraine` rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `IssueConstrai` ner 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 `IssueConstrainer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueConstrainerFormForUpdate
Description	Gets the issue constrainer form for updating an existing issue constrainer. A new issue constrainer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`issueConstrainerId`	the `Id` of the `IssueConstrainer`
Return	`osid.hold.rules.IssueConstrainerForm`		the issue constrainer form
Errors	NOT_FOUND		`issueConstrainerId` is not found
	NULL_ARGUMENT		`issueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateIssueConstrainer
Description	Updates an existing issue constrainer.
Parameters	`osid.hold.rules.IssueConstrainerForm`	`issueConstrainerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`issueConstrainerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`issueConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueConstrainerForm` did not originate from `getIssueConstrainerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIssueConstrainers
Description	Tests if this user can delete `IssueConstraine` rs. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `IssueConstrai` ner 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 `IssueConstrainer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIssueConstrainer
Description	Deletes an `IssueConstrainer` .
Parameters	`osid.id.Id`	`issueConstrainerId`	the `Id` of the `IssueConstrainer` to remove
Errors	NOT_FOUND		`issueConstrainerId` not found
	NULL_ARGUMENT		`issueConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIssueConstrainerAliases
Description	Tests if this user can manage `Id` aliases for `IssueConstrain` ers 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 `IssueConstrainer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIssueConstrainer
Description	Adds an `Id` to an `IssueConstrai` ner for the purpose of creating compatibility. The primary `Id` of the `IssueConstrai` ner 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, it is reassigned to the given issue constrainer `Id` .
Parameters	`osid.id.Id`	`issueConstrainerId`	the `Id` of an `IssueConstrainer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`issueConstrainerId` not found
	NULL_ARGUMENT		`issueConstrainerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.