OSID Logo
OSID Specifications
hold package
Version 3.1.0
Interfaceosid.hold.IssueOublietteAssignmentSession
Implementsosid.OsidSession
Used Byosid.hold.HoldManager
osid.hold.HoldProxyManager
Description

This session provides methods to re-assign Issues to Oubliette mappings. An Issue may appear in multiple Oubliette objects and removing the last reference to an Issue is the equivalent of deleting it. Each Oubliette may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an Issue to another Oubliette is not a copy operation (eg: does not change its Id).

MethodcanAssignIssues
Description

Tests if this user can alter issue/oubliette mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if issue is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignIssuesToOubliette
Description

Tests if this user can alter issue/oubliette mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdoublietteId the Id of the Oubliette
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT oublietteId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableOublietteIds
Description

Gets a list of oubliettes including and under the given oubliette node in which any issue can be assigned.

Parametersosid.id.IdoublietteId the Id of the Oubliette
Returnosid.id.IdList list of assignable oubliette Ids
ErrorsNULL_ARGUMENT oublietteId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableOublietteIdsForIssue
Description

Gets a list of oubliettes including and under the given oubliette node in which a specific issue can be assigned.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.id.IdissueId the Id of the Issue
Returnosid.id.IdList list of assignable oubliette Ids
ErrorsNULL_ARGUMENT oublietteId or issueId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignIssueToOubliette
Description

Adds an existing Issue to an Oubliette.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdoublietteId the Id of the Oubliette
ErrorsALREADY_EXISTS issueId is already assigned to oublietteId
NOT_FOUND issueId or oublietteId not found
NULL_ARGUMENT issueId or oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignIssueFromOubliette
Description

Removes an Issue from an Oubliette.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdoublietteId the Id of the Oubliette
ErrorsNOT_FOUND issueId or oublietteId not found or issueId is not assigned to oublietteId
NULL_ARGUMENT issueId or oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignIssueToOubliette
Description

Moves an Issue from one Oubliette to another. Mappings to other Oubliettes are unaffected.

Parametersosid.id.IdissueId the Id of the Issue
osid.id.IdfromOublietteId the Id of the current Oubliette
osid.id.IdtoOublietteId the Id of the destination Oubliette
ErrorsALREADY_EXISTS issueId already assigned to toOublietteId
NOT_FOUND issueId, fromOublietteId, or toOublietteId not found or issueId not mapped to fromOublietteId
NULL_ARGUMENT issueId, fromOublietteId, or toOublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.