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

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

MethodcanAssignStepProcessorEnablers
Description

Tests if this user can alter step processor enabler/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.
MethodcanAssignStepProcessorEnablersToOffice
Description

Tests if this user can alter step processor enabler/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 enabler 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.
MethodgetAssignableOfficeIdsForStepProcessorEnabler
Description

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepProcessorEnablerIdthe Id of the StepProcessorEnabler
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or stepProcessorEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepProcessorEnablerToOffice
Description

Adds an existing StepProcessorEnabler to an Office.

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

Removes a StepProcessorEnabler from an Office.

Parametersosid.id.IdstepProcessorEnablerIdthe Id of the StepProcessorEnabler
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUND stepProcessorEnablerId or officeId not found or stepProcessorEnablerId not assigned to officeId
NULL_ARGUMENT stepProcessorEnablerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepProcessorEnablerToOffice
Description

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

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