OSID Logo
OSID Specifications
workflow event package
Version 3.1.0
Interfaceosid.workflow.event.WorkflowEventOfficeAssignmentSession
Implementsosid.OsidSession
Used Byosid.workflow.event.WorkflowEventManager
osid.workflow.event.WorkflowEventProxyManager
Description

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

MethodcanAssignWorkflowEvents
Description

Tests if this user can alter workflow event/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. T his 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.
MethodcanAssignWorkflowEventToOffice
Description

Tests if this user can alter workflow event/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. T his 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 workflow event 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.
MethodgetAssignableOfficeIdsForWorkflowEvent
Description

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

Parametersosid.id.IdofficeId the Id of the Office
osid.id.IdworkflowEventId the Id of the WorkflowEvent
Returnosid.id.IdList list of assignable office Ids
ErrorsNULL_ARGUMENT officeId or workflowEventId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignWorkflowEventToOffice
Description

Adds an existing WorkflowEvent to an Office.

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

Removes a WorkflowEvent from an Office.

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

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

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