Interface WorkflowProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
WorkflowManager, WorkflowProxyManager
public interface WorkflowProfile extends OsidProfile

The workflow profile describes the interoperability among workflow services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      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.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessLookup

      boolean supportsProcessLookup()
      Tests if looking up process is supported.
      Returns:
      true if process lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessQuery

      boolean supportsProcessQuery()
      Tests if querying process is supported.
      Returns:
      true if process query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessSearch

      boolean supportsProcessSearch()
      Tests if searching process is supported.
      Returns:
      true if process search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessAdmin

      boolean supportsProcessAdmin()
      Tests if process administrative service is supported.
      Returns:
      true if process administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessNotification

      boolean supportsProcessNotification()
      Tests if a process notification service is supported.
      Returns:
      true if process notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessOffice

      boolean supportsProcessOffice()
      Tests if a process office lookup service is supported.
      Returns:
      true if a process office lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessOfficeAssignment

      boolean supportsProcessOfficeAssignment()
      Tests if a process office service is supported.
      Returns:
      true if process to office assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessSmartOffice

      boolean supportsProcessSmartOffice()
      Tests if a process smart office lookup service is supported.
      Returns:
      true if a process smart office service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepLookup

      boolean supportsStepLookup()
      Tests if looking up steps is supported.
      Returns:
      true if step lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepQuery

      boolean supportsStepQuery()
      Tests if querying steps is supported.
      Returns:
      true if step query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepSearch

      boolean supportsStepSearch()
      Tests if searching steps is supported.
      Returns:
      true if step search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepAdmin

      boolean supportsStepAdmin()
      Tests if a step administrative service is supported.
      Returns:
      true if step administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepNotification

      boolean supportsStepNotification()
      Tests if a step notification service is supported.
      Returns:
      true if step notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepOffice

      boolean supportsStepOffice()
      Tests if a step office lookup service is supported.
      Returns:
      true if a step office lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepOfficeAssignment

      boolean supportsStepOfficeAssignment()
      Tests if a step office assignment service is supported.
      Returns:
      true if a step to office assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepSmartOffice

      boolean supportsStepSmartOffice()
      Tests if a step smart office service is supported.
      Returns:
      true if a step smart office service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkLookup

      boolean supportsWorkLookup()
      Tests if looking up work is supported.
      Returns:
      true if work lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkQuery

      boolean supportsWorkQuery()
      Tests if querying work is supported.
      Returns:
      true if work query is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkSearch

      boolean supportsWorkSearch()
      Tests if searching work is supported.
      Returns:
      true if work search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkAdmin

      boolean supportsWorkAdmin()
      Tests if work administrative service is supported.
      Returns:
      true if work administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkNotification

      boolean supportsWorkNotification()
      Tests if a work notification service is supported.
      Returns:
      true if work notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkOffice

      boolean supportsWorkOffice()
      Tests if a work office lookup service is supported.
      Returns:
      true if a work office lookup service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkOfficeAssignment

      boolean supportsWorkOfficeAssignment()
      Tests if a work office service is supported.
      Returns:
      true if work to office assignment service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkSmartOffice

      boolean supportsWorkSmartOffice()
      Tests if a work smart office lookup service is supported.
      Returns:
      true if a work smart office service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflow

      boolean supportsWorkflow()
      Tests if a workflow service is supported.
      Returns:
      true if workflow is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflowInitiation

      boolean supportsWorkflowInitiation()
      Tests if a workflow initiation service is supported.
      Returns:
      true if workflow initiation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflowManagement

      boolean supportsWorkflowManagement()
      Tests if a workflow management service is supported.
      Returns:
      true if workflow management is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsManualWorkflow

      boolean supportsManualWorkflow()
      Tests if a manual workflow service is supported.
      Returns:
      true if manual workflow is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeLookup

      boolean supportsOfficeLookup()
      Tests if looking up offices is supported.
      Returns:
      true if office lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeQuery

      boolean supportsOfficeQuery()
      Tests if querying offices is supported.
      Returns:
      true if an office query service is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeSearch

      boolean supportsOfficeSearch()
      Tests if searching offices is supported.
      Returns:
      true if office search is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeAdmin

      boolean supportsOfficeAdmin()
      Tests if office administrative service is supported.
      Returns:
      true if office administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeNotification

      boolean supportsOfficeNotification()
      Tests if an office notification service is supported.
      Returns:
      true if office notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeHierarchy

      boolean supportsOfficeHierarchy()
      Tests for the availability of an office hierarchy traversal service.
      Returns:
      true if office hierarchy traversal is available, false otherwise
      Compliance:
      mandatory - This method must be implemented in all providers.

    • supportsOfficeHierarchyDesign

      boolean supportsOfficeHierarchyDesign()
      Tests for the availability of an office hierarchy design service.
      Returns:
      true if office hierarchy design is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflowBatch

      boolean supportsWorkflowBatch()
      Tests for the availability of a workflow batch service.
      Returns:
      true if a workflow batch service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflowRules

      boolean supportsWorkflowRules()
      Tests for the availability of a workflow rules service.
      Returns:
      true if a workflow rules service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkflowEvents

      boolean supportsWorkflowEvents()
      Tests for the availability of a workflow events service.
      Returns:
      true if a workflow events service is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getProcessRecordTypes

      TypeList getProcessRecordTypes()
      Gets the supported Process record types.
      Returns:
      a list containing the supported Process record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessRecordType

      boolean supportsProcessRecordType(Type processRecordType)
      Tests if the given Process record type is supported.
      Parameters:
      processRecordType - a Type indicating a Process record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - processRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getProcessSearchRecordTypes

      TypeList getProcessSearchRecordTypes()
      Gets the supported Process search record types.
      Returns:
      a list containing the supported Process search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessSearchRecordType

      boolean supportsProcessSearchRecordType(Type processSearchRecordType)
      Tests if the given Process search record type is supported.
      Parameters:
      processSearchRecordType - a Type indicating a Process search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - processSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStepRecordTypes

      TypeList getStepRecordTypes()
      Gets the supported Step record types.
      Returns:
      a list containing the supported Step record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepRecordType

      boolean supportsStepRecordType(Type stepRecordType)
      Tests if the given Step record type is supported.
      Parameters:
      stepRecordType - a Type indicating a Step record type
      Returns:
      true if the given record type is supported, false otherwise
      Throws:
      NullArgumentException - stepRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getStepSearchRecordTypes

      TypeList getStepSearchRecordTypes()
      Gets the supported Step search types.
      Returns:
      a list containing the supported Step search types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStepSearchRecordType

      boolean supportsStepSearchRecordType(Type stepSearchRecordType)
      Tests if the given Step search type is supported.
      Parameters:
      stepSearchRecordType - a Type indicating a Step search type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - effiortSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getWorkRecordTypes

      TypeList getWorkRecordTypes()
      Gets the supported Work record types.
      Returns:
      a list containing the supported Work record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkRecordType

      boolean supportsWorkRecordType(Type workRecordType)
      Tests if the given Work record type is supported.
      Parameters:
      workRecordType - a Type indicating a Work record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - workRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getWorkSearchRecordTypes

      TypeList getWorkSearchRecordTypes()
      Gets the supported Work search record types.
      Returns:
      a list containing the supported Work search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkSearchRecordType

      boolean supportsWorkSearchRecordType(Type workSearchRecordType)
      Tests if the given Work search record type is supported.
      Parameters:
      workSearchRecordType - a Type indicating a Work search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - workSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOfficeRecordTypes

      TypeList getOfficeRecordTypes()
      Gets the supported Office record types.
      Returns:
      a list containing the supported Office types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeRecordType

      boolean supportsOfficeRecordType(Type officeRecordType)
      Tests if the given Office record type is supported.
      Parameters:
      officeRecordType - a Type indicating an Office record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - officeRecordType is null
      Compliance:
      mandatory - This method must be implemented.

    • getOfficeSearchRecordTypes

      TypeList getOfficeSearchRecordTypes()
      Gets the supported Office search record types.
      Returns:
      a list containing the supported Office search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsOfficeSearchRecordType

      boolean supportsOfficeSearchRecordType(Type officeSearchRecordType)
      Tests if the given Office search record type is supported.
      Parameters:
      officeSearchRecordType - a Type indicating an Office search record type
      Returns:
      true if the given Type is supported, false otherwise
      Throws:
      NullArgumentException - officeSearchRecordType is null
      Compliance:
      mandatory - This method must be implemented.