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

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

MethodcanAssignEfforts
Description

Tests if this user can alter effort/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 assignment operations to unauthorized users.

Returnboolean false if resourcing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignEffortsToFoundry
Description

Tests if this user can alter effort/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 assignment operations to unauthorized users.

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnboolean false if resourcing is not authorized, true otherwise
ErrorsNULL_ARGUMENT foundryId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIds
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableFoundryIdsForEffort
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdeffortIdthe Id of the Effort
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or effortId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignEffortToFoundry
Description

Adds an existing Effort to a Foundry.

Parametersosid.id.IdeffortIdthe Id of the Effort
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND effortId or foundryId not found
NULL_ARGUMENT effortId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignEffortFromFoundry
Description

Removes an Effort from a Foundry.

Parametersosid.id.IdeffortIdthe Id of the Effort
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND effortId or foundryId not found
NULL_ARGUMENT effortId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.