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

This session provides methods to apply IssueProcessors to Issues. Multiple IssueProcessors applied to an Issue may be sequenced such that the first positive evaluation results in the IssueProcessor 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.
MethodcanAssignIssueProcessors
Description

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

Adds an existing IssueProcessorr to an Issue.

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

Removes an existing IssueProcessor from an Issue.

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

Tests if this user can order IssueProcessors. 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 IssueProcessor ordering is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodmoveIssueProcessorAhead
Description

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

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

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

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

Reorders a set of issue processors for an issue.

Parametersosid.id.Id[]issueProcessorIds the Ids for a set of IssueProcessors
osid.id.IdissueId the Id of the Issue
ErrorsNOT_FOUND issueId not found or, an issueProcessorId not related to issueId
NULL_ARGUMENT issueProcessorIds or issueId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.