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

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

MethodcanAssignIssueProcessorEnablers
Description

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

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

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

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

Adds an existing IssueProcessorEnabler to an Oubliette.

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

Removes an IssueProcessorEnabler from an Oubliette.

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

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

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