OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.CommissionFoundryAssignmentSession
Implementsosid.OsidSession
Used Byosid.resourcing.ResourcingManager
osid.resourcing.ResourcingProxyManager
Description

This session provides methods to re-assign Commissions to Foundry mappings. A Commission may appear in multiple Foundry objects and removing the last reference to a Commission 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 Commission to another Foundry is not a copy operation (eg: does not change its Id).

MethodcanAssignCommissions
Description

Tests if this user can alter commission/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known availability 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 assignment operations to unauthorized users.

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

Tests if this user can alter commission/foundry mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known availability 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 assignment 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 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.
MethodgetAssignableFoundryIdsForCommission
Description

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

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

Adds an existing Commission to a Foundry.

Parametersosid.id.IdcommissionId the Id of the Commission
osid.id.IdfoundryId the Id of the Foundry
ErrorsNOT_FOUND commissionId or foundryId not found
NULL_ARGUMENT commissionId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignCommissionFromFoundry
Description

Removes a Commission from a Foundry.

Parametersosid.id.IdcommissionId the Id of the Commission
osid.id.IdfoundryId the Id of the Foundry
ErrorsNOT_FOUND commissionId or foundryId not found
NULL_ARGUMENT commissionId or foundryId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignCommissionToFoundry
Description

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

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