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

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

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

Adds an existing IssueConstrainerEnabler to an IssueConstrainer.

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

Removes an existing IssueConstrainerEnabler from an IssueConstrainer.

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

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

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

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

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

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

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

Parametersosid.id.Id[]issueConstrainerEnablerIds the Ids for a set of IssueConstrainerEnablers
osid.id.IdissueConstrainerId the Id of the IssueConstrainer
ErrorsNOT_FOUND issueConstrainerId not found or, an issueConstrainerEnablerId not related to issueConstrainerId
NULL_ARGUMENT issueConstrainerEnablerIds or issueConstrainerId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.