Interface ProcessProfile

All Superinterfaces:
OsidProfile, Sourceable
All Known Subinterfaces:
ProcessManager, ProcessProxyManager
public interface ProcessProfile extends OsidProfile

The state profile describes interoperability among state services.

  • Method Details

    • supportsVisibleFederation

      boolean supportsVisibleFederation()
      Tests if federation is visible.
      Returns:
      true if visible federation is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsState

      boolean supportsState()
      Tests if retrieving mappings of state and Ids is supported.
      Returns:
      true if state mapping retrieval is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateAssignment

      boolean supportsStateAssignment()
      Tests if managing mappings of states and Ids is supported.
      Returns:
      true if state assignment is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateChangeNotification

      boolean supportsStateChangeNotification()
      Tests if subscirbing to state change notifications is supported.
      Returns:
      true if state change notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateLookup

      boolean supportsStateLookup()
      Tests if state lookup is supported.
      Returns:
      true if state lookup is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateQuery

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

    • supportsStateSearch

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

    • supportsStateAdmin

      boolean supportsStateAdmin()
      Tests if state administration is supported.
      Returns:
      true if state administration is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateSequencing

      boolean supportsStateSequencing()
      Tests if state sequencing is supported.
      Returns:
      true if state sequencing is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateNotification

      boolean supportsStateNotification()
      Tests if state notification is supported. Messages may be sent when states are created, modified, or deleted.
      Returns:
      true if state notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessLookup

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

    • supportsProcessQuery

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

    • supportsProcessSearch

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

    • supportsProcessAdmin

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

    • supportsProcessNotification

      boolean supportsProcessNotification()
      Tests if process notification is supported. Messages may be sent when Process objects are created, deleted or updated. Notifications for states within processes are sent via the state notification session.
      Returns:
      true if process notification is supported, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessHierarchy

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

    • supportsProcessHierarchyDesign

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

    • getStateRecordTypes

      TypeList getStateRecordTypes()
      Gets all the state record types supported.
      Returns:
      the list of supported state record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateRecordType

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

    • getStateSearchRecordTypes

      TypeList getStateSearchRecordTypes()
      Gets all the state search record types supported.
      Returns:
      the list of supported state search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsStateSearchRecordType

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

    • getProcessRecordTypes

      TypeList getProcessRecordTypes()
      Gets all the process record types supported.
      Returns:
      the list of supported process record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessRecordType

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

    • getProcessSearchRecordTypes

      TypeList getProcessSearchRecordTypes()
      Gets all the process search record types supported.
      Returns:
      the list of supported process search record types
      Compliance:
      mandatory - This method must be implemented.

    • supportsProcessSearchRecordType

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