OSID - osid.workflow.WorkflowProfile Service Interface Definition

Interface	osid.workflow.WorkflowProfile
Implements	`osid.OsidProfile`
Description	The workflow profile describes the interoperability among workflow 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	supportsProcessLookup
Description	Tests if looking up process is supported.
Return	`boolean`		`true` if process lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessQuery
Description	Tests if querying process is supported.
Return	`boolean`		`true` if process query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessSearch
Description	Tests if searching process is supported.
Return	`boolean`		`true` if process search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessAdmin
Description	Tests if process administrative service is supported.
Return	`boolean`		`true` if process administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessNotification
Description	Tests if a process notification service is supported.
Return	`boolean`		`true` if process notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessOffice
Description	Tests if a process office lookup service is supported.
Return	`boolean`		`true` if a process office lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessOfficeAssignment
Description	Tests if a process office service is supported.
Return	`boolean`		`true` if process to office assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessSmartOffice
Description	Tests if a process smart office lookup service is supported.
Return	`boolean`		`true` if a process smart office service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepLookup
Description	Tests if looking up steps is supported.
Return	`boolean`		`true` if step lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepQuery
Description	Tests if querying steps is supported.
Return	`boolean`		`true` if step query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepSearch
Description	Tests if searching steps is supported.
Return	`boolean`		`true` if step search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepAdmin
Description	Tests if a step administrative service is supported.
Return	`boolean`		`true` if step administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepNotification
Description	Tests if a step notification service is supported.
Return	`boolean`		`true` if step notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepOffice
Description	Tests if a step office lookup service is supported.
Return	`boolean`		`true` if a step office lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepOfficeAssignment
Description	Tests if a step office assignment service is supported.
Return	`boolean`		`true` if a step to office assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepSmartOffice
Description	Tests if a step smart office service is supported.
Return	`boolean`		`true` if a step smart office service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkLookup
Description	Tests if looking up work is supported.
Return	`boolean`		`true` if work lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkQuery
Description	Tests if querying work is supported.
Return	`boolean`		`true` if work query is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkSearch
Description	Tests if searching work is supported.
Return	`boolean`		`true` if work search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkAdmin
Description	Tests if work administrative service is supported.
Return	`boolean`		`true` if work administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkNotification
Description	Tests if a work notification service is supported.
Return	`boolean`		`true` if work notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkOffice
Description	Tests if a work office lookup service is supported.
Return	`boolean`		`true` if a work office lookup service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkOfficeAssignment
Description	Tests if a work office service is supported.
Return	`boolean`		`true` if work to office assignment service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkSmartOffice
Description	Tests if a work smart office lookup service is supported.
Return	`boolean`		`true` if a work smart office service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflow
Description	Tests if a workflow service is supported.
Return	`boolean`		`true` if workflow is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflowInitiation
Description	Tests if a workflow initiation service is supported.
Return	`boolean`		`true` if workflow initiation is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflowManagement
Description	Tests if a workflow management service is supported.
Return	`boolean`		`true` if workflow management is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsManualWorkflow
Description	Tests if a manual workflow service is supported.
Return	`boolean`		`true` if manual workflow is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflowEventLookup
Description	Tests if a workflow event lookup service is supported.
Return	`boolean`		`true` if workflow event lookup service 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 a workflow event notification service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeLookup
Description	Tests if looking up offices is supported.
Return	`boolean`		`true` if office lookup is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeQuery
Description	Tests if querying offices is supported.
Return	`boolean`		`true` if a office query service is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeSearch
Description	Tests if searching offices is supported.
Return	`boolean`		`true` if office search is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeAdmin
Description	Tests if office administrative service is supported.
Return	`boolean`		`true` if office administration is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeNotification
Description	Tests if a office notification service is supported.
Return	`boolean`		`true` if office notification is supported, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeHierarchy
Description	Tests for the availability of a office hierarchy traversal service.
Return	`boolean`		`true` if office hierarchy traversal is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented in all providers.
Method	supportsOfficeHierarchyDesign
Description	Tests for the availability of a office hierarchy design service.
Return	`boolean`		`true` if office hierarchy design is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflowBatch
Description	Tests for the availability of a workflow batch service.
Return	`boolean`		`true` if a workflow batch service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkflowRules
Description	Tests for the availability of a workflow rules service.
Return	`boolean`		`true` if a workflow rules service is available, `false` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getProcessRecordTypes
Description	Gets the supported `Process` record types.
Return	`osid.type.TypeList`		a list containing the supported `Process` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessRecordType
Description	Tests if the given `Process` record type is supported.
Parameters	`osid.type.Type`	`processRecordType`	a `Type` indicating a `Process` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`processRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getProcessSearchRecordTypes
Description	Gets the supported `Process` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Process` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsProcessSearchRecordType
Description	Tests if the given `Process` search record type is supported.
Parameters	`osid.type.Type`	`processSearchRecordType`	a `Type` indicating a `Process` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`processSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStepRecordTypes
Description	Gets the supported `Step` record types.
Return	`osid.type.TypeList`		a list containing the supported `Step` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepRecordType
Description	Tests if the given `Step` record type is supported.
Parameters	`osid.type.Type`	`stepRecordType`	a `Type` indicating a `Step` record type
Return	`boolean`		`true` if the given record type is supported, `false` otherwise
Errors	NULL_ARGUMENT		`stepRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getStepSearchRecordTypes
Description	Gets the supported `Step` search types.
Return	`osid.type.TypeList`		a list containing the supported `Step` search types
Compliance	`mandatory`		This method must be implemented.
Method	supportsStepSearchRecordType
Description	Tests if the given `Step` search type is supported.
Parameters	`osid.type.Type`	`stepSearchRecordType`	a `Type` indicating a `Step` search type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`effiortSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkRecordTypes
Description	Gets the supported `Work` record types.
Return	`osid.type.TypeList`		a list containing the supported `Work` record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkRecordType
Description	Tests if the given `Work` record type is supported.
Parameters	`osid.type.Type`	`workRecordType`	a `Type` indicating a `Work` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`workRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkSearchRecordTypes
Description	Gets the supported `Work` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Work` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsWorkSearchRecordType
Description	Tests if the given `Work` search record type is supported.
Parameters	`osid.type.Type`	`workSearchRecordType`	a `Type` indicating a `Work` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`workSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getWorkflowEventRecordTypes
Description	Gets the supported `WorkflowEvent` record types.
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 `WorkflowEvent` record type is supported.
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	getOfficeRecordTypes
Description	Gets the supported `Office` record types.
Return	`osid.type.TypeList`		a list containing the supported `Office` types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeRecordType
Description	Tests if the given `Office` record type is supported.
Parameters	`osid.type.Type`	`officeRecordType`	a `Type` indicating a `Office` record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`officeRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getOfficeSearchRecordTypes
Description	Gets the supported `Office` search record types.
Return	`osid.type.TypeList`		a list containing the supported `Office` search record types
Compliance	`mandatory`		This method must be implemented.
Method	supportsOfficeSearchRecordType
Description	Tests if the given `Office` search record type is supported.
Parameters	`osid.type.Type`	`officeSearchRecordType`	a `Type` indicating a `Office` search record type
Return	`boolean`		`true` if the given `Type` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`officeSearchRecordType` is `null`
Compliance	`mandatory`		This method must be implemented.