OSID Logo
OSID Specifications
resourcing rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.resourcing.rules.CommissionEnablerRuleApplicationSession
Implementsosid.OsidSession
Description

This session provides methods to apply CommissionEnablers to Commissions. A Commission with multiple CommissionEnablers means any positive rule evaluation across the enablers result in an accessible Commission.

MethodgetFoundryId
Description

Gets the Foundry Id associated with this session.

Returnosid.id.Idthe Foundry Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetFoundry
Description

Gets the Foundry associated with this session.

Returnosid.resourcing.Foundrythe foundry
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanAssignCommissionEnablers
Description

Tests if this user can alter commission enabler/commission 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
CompliancemandatoryThis method must be implemented.
MethodassignCommissionEnablerToCommission
Description

Adds an existing CommissionEnabler to a Commission.

Parametersosid.id.IdcommissionEnablerIdthe Id of the CommissionEnabler
osid.id.IdcommissionIdthe Id of the Commission
ErrorsALREADY_EXISTS commissionEnablerId is already applied to commissionId
NOT_FOUND commissionEnablerId or commissionId not found
NULL_ARGUMENT commissionEnablerId or commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCommissionEnablerFromCommission
Description

Removes a CommissionEnabler from a Commission.

Parametersosid.id.IdcommissionEnablerIdthe Id of the CommissionEnabler
osid.id.IdcommissionIdthe Id of the Commission
ErrorsNOT_FOUND commissionEnablerId or commissionId not found or commissionEnablerId not applied to commissionId
NULL_ARGUMENT commissionEnablerId or commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanSequenceCommissionEnablers
Description

Tests if this user can order CommissionEnablers. 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 CommissionEnabler ordering is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodmoveCommissionEnablerAhead
Description

Reorders commission enablers for a commission by moving the specified commission enabler in front of a reference commission enabler.

Parametersosid.id.IdcommissionEnablerIdthe Id of a CommissionEnabler
osid.id.IdcommissionIdthe Id of a Commission
osid.id.IdreferenceIdthe reference commission enabler Id
ErrorsNOT_FOUND commissionEnablerId, commissionId, or referenceId not found or, commissionEnablerId or referenceId not related to commissionId
NULL_ARGUMENT commissionEnablerId,commissionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodmoveCommissionEnablerBehind
Description

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

Parametersosid.id.IdcommissionEnablerIdthe Id of a CommissionEnabler
osid.id.IdcommissionIdthe Id of a Commission
osid.id.IdreferenceIdthe reference commission enabler Id
ErrorsNOT_FOUND commissionEnablerId, commissionId, or referenceId not found or, commissionEnablerId or referenceId not related to commissionId
NULL_ARGUMENT commissionEnablerId,commissionId, or referenceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodorderCommissionEnablers
Description

Reorders a set of commission enablers for a commission.

Parametersosid.id.Id[]commissionEnablerIdsthe Ids for a set of CommissionnEnablers
osid.id.IdcommissionIdthe Id of a Commission
ErrorsNOT_FOUND commissionId not found or, a commissionEnablerId not related to commissionId
NULL_ARGUMENT commissionEnablerIds or commissionId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.