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

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

MethodcanAssignWorks
Description

Tests if this user can alter work/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 mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignWorksToFoundry
Description

Tests if this user can alter work/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 work 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.
MethodgetAssignableFoundryIdsForWork
Description

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

Parametersosid.id.IdfoundryIdthe Id of the Foundry
osid.id.IdworkIdthe Id of the Work
Returnosid.id.IdListlist of assignable foundry Ids
ErrorsNULL_ARGUMENT foundryId or workId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignWorkToFoundry
Description

Adds an existing Work to a Foundry.

Parametersosid.id.IdworkIdthe Id of the Work
osid.id.IdfoundryIdthe Id of the Foundry
ErrorsNOT_FOUND workId or foundryId not found
NULL_ARGUMENT workId or foundryId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignWorkFromFoundry
Description

Removes a Work from a Foundry.

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