OSID Logo
OSID Specifications
hold package
Version 3.0.0
Release Candidate Preview
Interfaceosid.hold.IssueAdminSession
Implementsosid.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.

MethodgetOublietteId
Description

Gets the Oubliette Id associated with this session.

Returnosid.id.Idthe Oubliette Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetOubliette
Description

Gets the Oubliette associated with this session.

Returnosid.hold.Oubliettethe oubliette
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateIssues
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.

Returnboolean false if Issue creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateIssueWithRecordTypes
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.

Parametersosid.type.Type[]issueRecordTypesarray of issue record types
Returnboolean true if Issue creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT issueRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetIssueFormForCreate
Description

Gets the issue form for creating new issues. A new form should be requested for each create transaction.

Parametersosid.type.Type[]issueRecordTypesarray of issue record types
Returnosid.hold.IssueFormthe issue form
ErrorsNULL_ARGUMENT issueRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateIssue
Description

Creates a new Issue.

Parametersosid.hold.IssueFormissueFormthe form for this Issue
Returnosid.hold.Issuethe new Issue
ErrorsILLEGAL_STATE issueForm already used in a create transaction
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT issueForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED issueForm did not originate from getIssueFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateIssues
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.

Returnboolean false if Issue modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetIssueFormForUpdate
Description

Gets the issue form for updating an existing issue. A new issue form should be requested for each update transaction.

Parametersosid.id.IdissueIdthe Id of the Issue
Returnosid.hold.IssueFormthe issue form
ErrorsNOT_FOUND issueId is not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodupdateIssue
Description

Updates an existing issue.

Parametersosid.hold.IssueFormissueFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE issueForm already used in an update transaction
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT issueId or issueForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED issueForm did not originate from getIssueFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteIssues
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.

Returnboolean false if Issue deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteIssue
Description

Deletes an Issue.

Parametersosid.id.IdissueIdthe Id of the Issue to remove
ErrorsNOT_FOUND issueId not found
NULL_ARGUMENT issueId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageIssueAliases
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.

Returnboolean false if Issue aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasIssue
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.

Parametersosid.id.IdissueIdthe Id of an Issue
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND issueId not found
NULL_ARGUMENT issueId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.