OSID Logo
OSID Specifications
workflow package
Version 3.1.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.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This 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.IdofficeId the Id of the Office
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT officeId is null
Compliancemandatory This 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.IdofficeId the Id of the Office
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This 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.IdofficeId the Id of the Office
osid.id.IdstepId the Id of the Step
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId or stepId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignStepToOffice
Description

Adds an existing Step to an Office.

Parametersosid.id.IdstepId the Id of the Step
osid.id.IdofficeId the Id of the Office
ErrorsALREADY_EXISTS stepId is already assigned to officeId
NOT_FOUND stepId or officeId not found
NULL_ARGUMENT stepId or officeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignStepFromOffice
Description

Removes a Step from an Office.

Parametersosid.id.IdstepId the Id of the Step
osid.id.IdofficeId the Id of the Office
ErrorsNOT_FOUND stepId or officeId not found or stepId is not assigned to officeId
NULL_ARGUMENT stepId or officeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignStepToOffice
Description

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

Parametersosid.id.IdstepId the Id of the Step
osid.id.IdfromOfficeId the Id of the current Office
osid.id.IdtoOfficeId the Id of the destination Office
ErrorsALREADY_EXISTS stepId, already assigned to toOfficeId
NOT_FOUND stepId, fromOfficeId, or toOfficeId not found or stepId not mapped to fromOfficeId
NULL_ARGUMENT stepId, fromOfficeId, or toOfficeId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.