Interface WorkflowEventProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
WorkflowEventManager, WorkflowEventProxyManager
public interface WorkflowEventProfile extends OsidProfile

The workflow event profile describes the interoperability among workflow event 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.

    • supportsWorkflowEventLookup

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

    • supportsWorkflowEventQuery

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

    • supportsWorkflowEventSearch

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

    • supportsWorkflowEventAdmin

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

    • supportsWorkflowEventNotification

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

    • supportsWorkflowEventOffice

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

    • supportsWorkflowEventOfficeAssignment

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

    • supportsWorkflowEventSmartOffice

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

    • getWorkflowEventRecordTypes

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

    • supportsWorkflowEventRecordType

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

    • getWorkflowEventSearchRecordTypes

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

    • supportsWorkflowEventSearchRecordType

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