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

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

MethodcanAssignIssueProcessors
Description

Tests if this user can alter issue processor/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.
MethodcanAssignIssueProcessorToOubliette
Description

Tests if this user can alter issue processor/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 processor 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.
MethodgetAssignableOublietteIdsForIssueProcessor
Description

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

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

Adds an existing IssueProcessor to an oublietteId.

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

Removes an IssueProcessor from an Oubliette.

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

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

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