OSID Logo
OSID Specifications
workflow package
Version 3.0.0
Interfaceosid.workflow.StepOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.workflow.WorkflowManager
osid.workflow.WorkflowProxyManager
Description

This session provides methods to re-assign Step to Office mappings. A Step may appear in multiple Offices and removing the last reference to a Step is the equivalent of deleting it. Each Office may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Step to another Office is not a copy operation (eg: does not change its Id ).

MethodcanAssignStepes
Description

Tests if this user can alter step/office 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.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignStepesToOffice
Description

Tests if this user can alter step/office 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.IdofficeIdthe Id of the Office
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTofficeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIds
Description

Gets a list of offices including and under the given office node in which any step can be assigned.

Parametersosid.id.IdofficeIdthe Id of the Office
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENTofficeId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIdsForStep
Description

Gets a list of offices including and under the given office node in which a specific step can be assigned.

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepIdthe Id of the Step
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENTofficeId or stepId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepToOffice
Description

Adds an existing Step to an Office .

Parametersosid.id.IdstepIdthe Id of the Step
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTSstepId is already assigned to officeId
NOT_FOUNDstepId or officeId not found
NULL_ARGUMENTstepId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepFromOffice
Description

Removes a Step from an Office .

Parametersosid.id.IdstepIdthe Id of the Step
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUNDstepId or officeId not found or stepId is not assigned to officeId
NULL_ARGUMENTstepId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepToOffice
Description

Moves a Step from one Office to another. Mappings to other Offices are unaffected.

Parametersosid.id.IdstepIdthe Id of the Step
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsALREADY_EXISTSstepId , already assigned to toOfficeId
NOT_FOUNDstepId, fromOfficeId , or toOfficeId not found or stepId not mapped to fromOfficeId
NULL_ARGUMENTstepId, fromOfficeId , or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.