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

This session provides methods to re-assign IssueEnablers to Oubliette mappings. An IssueEnabler may appear in multiple Oubliette catalogs and removing the last reference to an IssueEnabler 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 IssueEnabler to another Oubliette is not a copy operation (eg: does not change its Id).

MethodcanAssignIssueEnablers
Description

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

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

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

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

Adds an existing IssueEnabler to an oublietteId.

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

Removes an IssueEnabler from an Oubliette.

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

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

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