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

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

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

Adds an existing IssueEnabler to an Issue.

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

Removes an existing IssueEnabler from an Issue.

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

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

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

Parametersosid.id.IdissueEnablerId the Id of the IssueEnabler
osid.id.IdissueId the Id of the Issue
osid.id.IdreferenceId the reference issue enabler Id
ErrorsNOT_FOUND issueEnablerId, issueId, or referenceId not found or, issueEnablerId or referenceId not related to issueId
NULL_ARGUMENT issueEnablerId, issueId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodmoveIssueEnablerBehind
Description

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

Parametersosid.id.IdissueEnablerId the Id of the IssueEnabler
osid.id.IdissueId the Id of the Issue
osid.id.IdreferenceId the reference issue enabler Id
ErrorsNOT_FOUND issueEnablerId, issueId, or referenceId not found or, issueEnablerId or referenceId not related to issueId
NULL_ARGUMENT issueEnablerId, issueId, or referenceId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodorderIssueEnablers
Description

Reorders a set of issue enablers for an issue.

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