OSID - osid.hold.IssueAdminSession Service Interface Definition

Interface	osid.hold.IssueAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Ieeues.` 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 `Issue,` an `IssueForm` is requested using `getIssueFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `IssueForm` 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 `IssueForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IssueForm` corresponds to an attempted transaction. For updates, `IssueForms` are requested to the `Issue` `Id` that is to be updated using `getIssueFormForUpdate().` Similarly, the `IssueForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IssueForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Issues.` To unmap an `Issue` from the current `Oubliette,` the `IssueOublietteAssignmentSession` should be used. These delete operations attempt to remove the `Issue` 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	canCreateIssues
Description	Tests if this user can create `Issues.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Issue` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `Issue` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateIssueWithRecordTypes
Description	Tests if this user can create a single `Issue` using the desired record types. While `HoldManager.getIssueRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Issue.` Providing an empty array tests if an `Issue` can be created with no records.
Parameters	`osid.type.Type[]`	`issueRecordTypes`	array of issue record types
Return	`boolean`		`true` if `Issue` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`issueRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getIssueFormForCreate
Description	Gets the issue form for creating new issues. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`issueRecordTypes`	array of issue record types
Return	`osid.hold.IssueForm`		the issue form
Errors	NULL_ARGUMENT		`issueRecordTypes` 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	createIssue
Description	Creates a new `Issue.`
Parameters	`osid.hold.IssueForm`	`issueForm`	the form for this `Issue`
Return	`osid.hold.Issue`		the new `Issue`
Errors	ILLEGAL_STATE		`issueForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`issueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueForm` did not originate from `getIssueFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateIssues
Description	Tests if this user can update `Issues.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Issue` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `Issue` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getIssueFormForUpdate
Description	Gets the issue form for updating an existing issue. A new issue form should be requested for each update transaction.
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue`
Return	`osid.hold.IssueForm`		the issue form
Errors	NOT_FOUND		`issueId` is not found
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateIssue
Description	Updates an existing issue.
Parameters	`osid.hold.IssueForm`	`issueForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`issueForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`issueId` or `issueForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`issueForm` did not originate from `getIssueFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteIssues
Description	Tests if this user can delete `Issues.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Issue` will result in a `PERMISSION_DENIED.` This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Issue` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIssue
Description	Deletes an `Issue.`
Parameters	`osid.id.Id`	`issueId`	the `Id` of the `Issue` to remove
Errors	NOT_FOUND		`issueId` not found
	NULL_ARGUMENT		`issueId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageIssueAliases
Description	Tests if this user can manage `Id` aliases for `Issues.` 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 `Issue` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIssue
Description	Adds an `Id` to an `Issue` for the purpose of creating compatibility. The primary `Id` of the `Issue` 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, it is reassigned to the given issue `Id.`
Parameters	`osid.id.Id`	`issueId`	the `Id` of an `Issue`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`issueId` not found
	NULL_ARGUMENT		`issueId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.