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

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

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

Adds an existing IssueConstrainer to an Issue.

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

Removes an existing IssueConstrainer from an Issue.

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

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

Reorders issue constrainers for an issue by moving the specified issue constrainer in front of a reference issue constrainer.

Parametersosid.id.IdissueConstrainerId the Id of the IssueConstrainer
osid.id.IdissueId the Id of the Issue
osid.id.IdreferenceId the reference issue constrainer Id
ErrorsNOT_FOUND issueConstrainerId, issueId, or referenceId not found or, issueConstrainerId or referenceId not related to issueId
NULL_ARGUMENT issueConstrainerId, issueId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveIssueConstrainerBehind
Description

Reorders issue constrainers for an issue by moving the specified issue constrainer behind a reference issue constrainer.

Parametersosid.id.IdissueConstrainerId the Id of the IssueConstrainer
osid.id.IdissueId the Id of the Issue
osid.id.IdreferenceId the reference issue constrainer Id
ErrorsNOT_FOUND issueConstrainerId, issueId, or referenceId not found or, issueConstrainerId or referenceId not related to issueId
NULL_ARGUMENT issueConstrainerId, issueId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderIssueConstrainers
Description

Reorders a set of issue constrainers for an issue.

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