OSID Logo
OSID Specifications
hold rules package
Version 3.1.0
Interfaceosid.hold.rules.IssueConstrainerOublietteAssignmentSession
Implementsosid.OsidSession
Used Byosid.hold.rules.HoldRulesManager
osid.hold.rules.HoldRulesProxyManager
Description

This session provides methods to re-assign IssueConstrain ers to Oubliette mappings. An IssueConstrai ner may appear in multiple Oubliette catalogs and removing the last reference to an IssueConstrai ner 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 IssueConstrai ner to another Oubliette is not a copy operation (eg: does not change its Id).

MethodcanAssignIssueConstrainers
Description

Tests if this user can alter issue constrainer/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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

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

Tests if this user can alter issue constrainer/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. T his is intended as a hint to an application that may opt not to offer assignment 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 constrainer 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.
MethodgetAssignableOublietteIdsForIssueConstrainer
Description

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

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

Adds an existing IssueConstrainer to an oublietteId.

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

Removes an IssueConstrainer from an Oubliette.

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

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

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