OSID Logo
OSID Specifications
resourcing package
Version 3.0.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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis 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.IdfoundryIdthe Id of the Foundry
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTfoundryId is null
CompliancemandatoryThis 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.IdfoundryIdthe Id of the Foundry
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENTfoundryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis 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.IdfoundryIdthe Id of the Foundry
osid.id.IdcommissionIdthe Id of the Commission
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENTfoundryId or commissionId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignCommissionToFoundry
Description

Adds an existing Commission to a Foundry .

Parametersosid.id.IdcommissionIdthe Id of the Commission
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUNDcommissionId or foundryId not found
NULL_ARGUMENTcommissionId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignCommissionFromFoundry
Description

Removes a Commission from a Foundry .

Parametersosid.id.IdcommissionIdthe Id of the Commission
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUNDcommissionId or foundryId not found
NULL_ARGUMENTcommissionId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignCommissionToFoundry
Description

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

Parametersosid.id.IdcommissionIdthe Id of the Commission
osid.id.IdfromFoundryIdthe Id of the current Foundry
osid.id.IdtoFoundryIdthe Id of the destination Foundry
ErrorsALREADY_EXISTScommissionId already assigned to toFoundryId
NOT_FOUNDcommissionId, fromFoundryId , or toFoundryId not found or commissionId not mapped to fromFoundryId
NULL_ARGUMENTcommissionId, fromFoundryId , or toFoundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.