OSID Specifications
workflow event package
Version 3.1.0
workflow event package
Version 3.1.0
| Interface | osid.workflow.event.WorkflowEventProfile | ||
|---|---|---|---|
| Implements | osid.OsidProfile | ||
| Implemented By | osid.workflow.event.WorkflowEventManager | ||
osid.workflow.event.WorkflowEventProxyManager | |||
| Description |
The workflow event profile describes the interoperability among workflow event services. | ||
| Method | supportsVisibleFederation | ||
| Description |
Tests if any office federation is exposed. Federation is exposed when a specific office may be identified, selected and used to create a lookup or admin session. Federation is not exposed when a set of offices appears as a single office. | ||
| Return | boolean | true if visible federation is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventLookup | ||
| Description |
Tests if looking up workflow events is supported. | ||
| Return | boolean | true if workflow event lookup is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventQuery | ||
| Description |
Tests if querying workflow events is supported. | ||
| Return | boolean | true if workflow event query is supported, false
otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventSearch | ||
| Description |
Tests if searching workflow events is supported. | ||
| Return | boolean | true if workflow event search is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventAdmin | ||
| Description |
Tests if a workflow event administrative service is supported. | ||
| Return | boolean | true if workflow event administration is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventNotification | ||
| Description |
Tests if a workflow event notification service is supported. | ||
| Return | boolean | true if workflow event notification is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventOffice | ||
| Description |
Tests if a workflow event office lookup service is supported. | ||
| Return | boolean | true if a workflow event office lookup service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventOfficeAssignment | ||
| Description |
Tests if a workflow event office assignment service is supported. | ||
| Return | boolean | true if a workflow event to office assignment service is
supported, false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventSmartOffice | ||
| Description |
Tests if a workflow event smart office service is supported. | ||
| Return | boolean | true if a smart office service is supported,
false otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported WorkflowEvent record types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | workflowEventRecordType | a Type indicating a WorkflowEvent record type |
| Return | boolean | true if the given record type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | workflowEventRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getWorkflowEventSearchRecordTypes | ||
| Description |
Gets the supported | ||
| Return | osid.type.TypeList | a list containing the supported WorkflowEvent search types | |
| Compliance | mandatory | This method must be implemented. | |
| Method | supportsWorkflowEventSearchRecordType | ||
| Description |
Tests if the given | ||
| Parameters | osid.type.Type | workflowEventSearchRecordType | a Type indicating a WorkflowEvent search type |
| Return | boolean | true if the given Type is supported,
false otherwise | |
| Errors | NULL_ARGUMENT | workflowEventSearchRecordType is null | |
| Compliance | mandatory | This method must be implemented. | |