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

This session provides methods to apply IssueProcessorEnablers to IssueProcessors. Multiple IssueProcessorEnablers applied to an IssueProcessor may be sequenced such that the first positive evaluation results in the IssueProcessorEnabler used.

MethodgetOublietteId
Description

Gets the Oubliette Id associated with this session.

Returnosid.id.Id the Oubliette Id associated with this session
Compliancemandatory This method must be implemented.
MethodgetOubliette
Description

Gets the Oubliette associated with this session.

Returnosid.hold.Oubliette the oubliette
ErrorsOPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanAssignIssueProcessorEnablers
Description

Tests if this user can alter issue processor enabler/issue processor 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 mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodassignIssueProcessorEnablerToIssueProcessor
Description

Adds an existing IssueProcessorEnabler to an IssueProcessor.

Parametersosid.id.IdissueProcessorEnablerId the Id of the IssueProcessorEnabler
osid.id.IdissueProcessorId the Id of the IssueProcessor
ErrorsALREADY_EXISTS issueProcessorEnablerId already applied to issueProcessorId
NOT_FOUND issueProcessorEnablerId or issueProcessorId not found
NULL_ARGUMENT issueProcessorEnablerId or issueProcessorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignIssueProcessorEnablerFromIssueProcessor
Description

Removes an existing IssueProcessorEnabler from an IssueProcessor.

Parametersosid.id.IdissueProcessorEnablerId the Id of the IssueProcessorEnabler
osid.id.IdissueProcessorId the Id of the IssueProcessor
ErrorsNOT_FOUND issueProcessorEnablerId or issueProcessorId not found or issueProcessorEnablerId already applied to issueProcessorId
NULL_ARGUMENT issueProcessorEnablerId or issueProcessorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodcanSequenceIssueProcessorEnablers
Description

Tests if this user can order IssueProcessorEnablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known sequencing operations will result in a PERMISSION_DENIED.This is intended as a hint to an application that may opt not to offer sequencing operations to an unauthorized user.

Returnboolean false if IssueProcessorEnabler ordering is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodmoveIssueProcessorEnablerAhead
Description

Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler in front of a reference issue processor enabler.

Parametersosid.id.IdissueProcessorEnablerId the Id of the IssueProcessorEnabler
osid.id.IdissueProcessorId the Id of the IssueProcessor
osid.id.IdreferenceId the reference issue processor enabler Id
ErrorsNOT_FOUND issueProcessorEnablerId issueProcessorId, or referenceId not found or, issueProcessorEnablerId or referenceId not related to issueProcessorId
NULL_ARGUMENT issueProcessorEnablerId, issueProcessorId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveIssueProcessorEnablerBehind
Description

Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler behind a reference issue processor enabler.

Parametersosid.id.IdissueProcessorEnablerId the Id of the IssueProcessorEnabler
osid.id.IdissueProcessorId the Id of the IssueProcessor
osid.id.IdreferenceId the reference issue processor Id
ErrorsNOT_FOUND issueProcessorEnablerId issueProcessorId, or referenceId not found or, issueProcessorEnablerId or referenceId not related to issueProcessorId
NULL_ARGUMENT issueProcessorEnablerId, issueProcessorId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderIssueProcessorEnablers
Description

Reorders a set of issue processor enablers for an issue processor.

Parametersosid.id.Id[]issueProcessorEnablerIds the Ids for a set of IssueProcessorEnablers
osid.id.IdissueProcessorId the Id of the IssueProcessor
ErrorsNOT_FOUND issueProcessorId not found or, an issueProcessorEnablerId not related to issueProcessorId
NULL_ARGUMENT issueProcessorEnablerIds or issueProcessorId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.