OSID Logo
OSID Specifications
resourcing package
Version 3.1.0
Interfaceosid.resourcing.WorkFoundryAssignmentSession
Implementsosid.OsidSession
Used Byosid.resourcing.ResourcingManager
osid.resourcing.ResourcingProxyManager
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
Compliancemandatory This 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.IdfoundryId the Id of the Foundry
Returnboolean false if resourcing 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 work 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.
MethodgetAssignableFoundryIdsForWork
Description

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

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

Adds an existing Work to a Foundry.

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

Removes a Work from a Foundry.

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

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

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