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

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

MethodcanAssignStepConstrainers
Description

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

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

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

Parametersosid.id.IdofficeIdthe Id of the Office
osid.id.IdstepConstrainerIdthe Id of the StepConstrainer
Returnosid.id.IdListlist of assignable office Ids
ErrorsNULL_ARGUMENT officeId or stepConstrainerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignStepConstrainerToOffice
Description

Adds an existing StepConstrainer to an Office.

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

Removes a StepConstrainer from an Office.

Parametersosid.id.IdstepConstrainerIdthe Id of the StepConstrainer
osid.id.IdofficeIdthe Id of the Office
ErrorsNOT_FOUND stepConstrainerId or officeId not found or stepConstrainerId not assigned to officeId
NULL_ARGUMENT stepConstrainerId or officeId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignStepConstrainerToOffice
Description

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

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