OSID Logo
OSID Specifications
workflow rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.workflow.rules.StepProcessorOfficeAssignmentSession
Implementsosid.OsidSession
Description

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

MethodcanAssignStepProcessors
Description

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

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

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

Parametersosid.id.IdofficeIdthe Id of the Office
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT officeId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableOfficeIds
Description

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

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

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepProcessorIdthe Id of the StepProcessor
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or stepProcessorId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepProcessorToOffice
Description

Adds an existing StepProcessor to an Office.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor
osid.id.IdofficeIdthe Id of the Office
ErrorsALREADY_EXISTS stepProcessorId is already assigned to officeId
NOT_FOUND stepProcessorId or officeId not found
NULL_ARGUMENT stepProcessorId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignStepProcessorFromOffice
Description

Removes a StepProcessor from an Office.

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUND stepProcessorId or officeId not found or stepProcessorId not assigned to officeId
NULL_ARGUMENT stepProcessorId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepProcessorToOffice
Description

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

Parametersosid.id.IdstepProcessorIdthe Id of the StepProcessor
osid.id.IdfromOfficeIdthe Id of the current Office
osid.id.IdtoOfficeIdthe Id of the destination Office
ErrorsNOT_FOUND stepProcessorId, fromOfficeId, or toOfficeId not found or stepProcessorId not mapped to fromOfficeId
NULL_ARGUMENT stepProcessorId, fromOfficeId, or toOfficeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.