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

This session provides methods to re-assign IssueConstrainerEnabler to Oubliette mappings. An IssueConstrainerEnabler may appear in multiple Oubliette catalogs and removing the last reference to an IssueConstrainerEnabler is the equivalent of deleting it. Each Oubliette may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an IssueConstrainerEnabler to another Oubliette is n ot a copy operation (eg: does not change its Id).

MethodcanAssignIssueConstrainerEnablers
Description

Tests if this user can alter issue constrainer enabler/oubliette 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignIssueConstrainerEnablerToOubliette
Description

Tests if this user can alter issue constrainer enabler/oubliette 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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdoublietteId the Id of the Oubliette
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT oublietteId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableOublietteIds
Description

Gets a list of oubliettes including and under the given oubliette node in which any issue constrainer enabler can be assigned.

Parametersosid.id.IdoublietteId the Id of the Oubliette
Returnosid.id.IdList list of assignable oubliette Ids
ErrorsNULL_ARGUMENT oublietteId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableOublietteIdsForIssueConstrainerEnabler
Description

Gets a list of oubliettes including and under the given oubliette node in which a specific issue constrainer enabler can be assigned.

Parametersosid.id.IdoublietteId the Id of the Oubliette
osid.id.IdissueConstrainerEnablerId the Id of the IssueConstrainerEnabler
Returnosid.id.IdList list of assignable oubliette Ids
ErrorsNULL_ARGUMENT oublietteId or issueConstrainerEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignIssueConstrainerEnablerToOubliette
Description

Adds an existing IssueConstrainerEnabler to an Oubliette.

Parametersosid.id.IdissueConstrainerEnablerId the Id of the IssueConstrainerEnabler
osid.id.IdoublietteId the Id of the Oubliette
ErrorsALREADY_EXISTS issueConstrainerEnablerId is already assigned to oublietteId
NOT_FOUND issueConstrainerEnablerId or oublietteId not found
NULL_ARGUMENT issueConstrainerEnablerId or oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignIssueConstrainerEnablerFromOubliette
Description

Removes an IssueConstrainerEnabler from an Oubliette.

Parametersosid.id.IdissueConstrainerEnablerId the Id of the IssueConstraienrEnabler
osid.id.IdoublietteId the Id of the Oubliette
ErrorsNOT_FOUND issueConstrainerEnablerId or oublietteId not found or issueConstrainerEnablerId not assigned to oublietteId
NULL_ARGUMENT issueConstrainerEnablerId or oublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignIssueConstrainerEnablerToOubliette
Description

Moves an IssueConstrainerEnabler from one Oubliette to another. Mappings to other Oubliettes are unaffected.

Parametersosid.id.IdissueConstrainerEnablerId the Id of the IssueConstrainerEnabler
osid.id.IdfromOublietteId the Id of the current Oubliette
osid.id.IdtoOublietteId the Id of the destination Oubliette
ErrorsALREADY_EXISTS issueConstrainerEnablerId already assigned to toOublietteId
NOT_FOUND issueConstrainerEnablerId, fromOublietteId, or toOublietteId not found or issueConstrainerEnablerId not mapped to fromOublietteId
NULL_ARGUMENT issueConstrainerEnablerId, fromOublietteId, or toOublietteId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.