OSID Logo
OSID Specifications
resourcing rules package
Version 3.1.0
Interfaceosid.resourcing.rules.CommissionEnablerFoundryAssignmentSession
Implementsosid.OsidSession
Used Byosid.resourcing.rules.ResourcingRulesManager
osid.resourcing.rules.ResourcingRulesProxyManager
Description

This session provides methods to re-assign CommissionEnabler to Foundry mappings. A CommissionEnabler may appear in multiple Foundry objects and removing the last reference to a CommissionEnabler is the equivalent of deleting it. Each Foundry may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a CommissionEnabler to another Foundry is not a copy operation (eg: does not change its Id).

MethodcanAssignCommissionEnablers
Description

Tests if this user can alter commission enabler/foundry 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.
MethodcanAssignCommissionEnablersToFoundry
Description

Tests if this user can alter commission enabler/foundry 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.

Parametersosid.id.IdfoundryId the Id of the Foundry
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT foundryId is null
Compliancemandatory This method must be implemented.
MethodgetAssignableFoundryIds
Description

Gets a list of foundries including and under the given foundry node in which any commission enabler can be assigned.

Parametersosid.id.IdfoundryId the Id of the Foundry
Returnosid.id.IdList list of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableFoundryIdsForCommissionEnabler
Description

Gets a list of foundries including and under the given foundry node in which a specific commission enabler can be assigned.

Parametersosid.id.IdfoundryId the Id of the Foundry
osid.id.IdcommissionEnablerId the Id of the CommissionEnabler
Returnosid.id.IdList list of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or commissionEnablerId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignCommissionEnablerToFoundry
Description

Adds an existing CommissionEnabler to a Foundry.

Parametersosid.id.IdcommissionEnablerId the Id of the CommissionEnabler
osid.id.IdfoundryId the Id of the Foundry
ErrorsALREADY_EXISTS ccommissionEnablerId is already assigned to foundryId
NOT_FOUND ccommissionEnablerId or foundryId not found
NULL_ARGUMENT commissionEnablerId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignCommissionEnablerFromFoundry
Description

Removes a CommissionEnabler from a Foundry.

Parametersosid.id.IdcommissionEnablerId the Id of the CommissionEnabler
osid.id.IdfoundryId the Id of the Foundry
ErrorsNOT_FOUND commissionEnablerId or foundryId not found or commissionEnablerId not assigned to foundryId
NULL_ARGUMENT commissionEnablerId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignCommissionEnablerToFoundry
Description

Moves a CommissionEnabler from one Foundry to another. Mappings to other Foundries are unaffected.

Parametersosid.id.IdcommissionEnablerId the Id of the CommissionEnabler
osid.id.IdfromFoundryId the Id of the current Foundry
osid.id.IdtoFoundryId the Id of the destination Foundry
ErrorsALREADY_EXISTS commissionEnablerId already assigned to toFoundryId
NOT_FOUND commissionEnablerId, fromFoundryId, or toFoundryId not found or commissionEnablerId not mapped to fromFoundryId
NULL_ARGUMENT commissionEnablerId, fromFoundryId, or toFoundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.