Interface WorkflowRulesManager

All Superinterfaces:
AutoCloseable, Closeable, OsidManager, OsidManager, OsidProfile, Sourceable, WorkflowRulesProfile
public interface WorkflowRulesManager extends OsidManager, WorkflowRulesProfile

The workflow rules manager provides access to workflow rules sessions and provides interoperability tests for various aspects of this service. The sessions included in this manager are:

  • ProcessEnablerLookupSession : a session to retrieve process enablers
  • ProcessEnablerQuerySession : a session to query for process enablers
  • ProcessEnablerSearchSession : a session to search for process enablers
  • ProcessEnablerAdminSession : a session to create and delete process enablers
  • ProcessEnablerNotificationSession : a session to receive notifications pertaining to process enabler changes
  • ProcessEnablerOfficeSession : a session to look up process enabler office mappings
  • ProcessEnablerOfficeAssignmentSession : a session to manage process enabler to office mappings
  • ProcessEnablerSmartOfficeSession : a session to manage dynamic offices of process enablers
  • ProcessEnablerRuleLookupSession : a session to look up process enablers to process mappings
  • ProcessEnablerRuleApplicationSession: a session to apply process enablers to processes
  • ProcessConstrainerLookupSession : a session to retrieve process constrainers
  • ProcessConstrainerQuerySession : a session to query for process constrainers
  • ProcessConstrainerSearchSession : a session to search for process constrainers
  • ProcessConstrainerAdminSession : a session to create and delete process constrainers
  • ProcessConstrainerNotificationSession : a session to receive notifications pertaining to process constrainer changes
  • ProcessConstrainerOfficeSession : a session to look up process constrainer office mappings
  • ProcessConstrainerOfficeAssignmentSession : a session to manage process constrainer to office mappings
  • ProcessConstrainerSmartOfficeSession : a session to manage dynamic offices of process constrainers
  • ProcessConstrainerRuleLookupSession : a session to look up process constrainers to process mappings
  • ProcessConstrainerRuleApplicationSession: a session to apply process constrainers to processes
  • ProcessConstrainerEnablerLookupSession : a session to retrieve process constrainer enablers
  • ProcessConstrainerEnablerQuerySession : a session to query for process constrainer enablers
  • ProcessConstrainerEnablerSearchSession : a session to search for process constrainer enablers
  • ProcessConstrainerEnablerAdminSession : a session to create and delete process constrainer enablers
  • ProcessConstrainerEnablerNotificationSession : a session to receive notifications pertaining to process constrainer enabler changes
  • ProcessConstrainerEnablerOfficeSession : a session to look up process constrainer enabler office mappings
  • ProcessConstrainerEnablerOfficeAssignmentSession : a session to manage process constrainer enabler to office mappings
  • ProcessConstrainerEnablerSmartOfficeSession : a session to manage dynamic offices of process constrainer enablers
  • ProcessConstrainerEnablerRuleLookupSession : a session to look up process constrainer enablers to process constrainer mappings
  • ProcessConstrainerEnablerRuleApplicationSession: a session to apply process constrainer enablers to process constrainers
  • ProcessProcessorLookupSession : a session to retrieve process processors
  • ProcessProcessorQuerySession : a session to query for process processors
  • ProcessProcessorSearchSession : a session to search for process processors
  • ProcessProcessorAdminSession : a session to create and delete process processors
  • ProcessProcessorNotificationSession : a session to receive notifications pertaining to process processor changes
  • ProcessProcessorOfficeSession : a session to look up process processor office mappings
  • ProcessProcessorOfficeAssignmentSession : a session to manage process processor to office mappings
  • ProcessProcessorSmartOfficeSession : a session to manage dynamic offices of process processors
  • ProcessProcessorRuleLookupSession : a session to look up process processors to process mappings
  • ProcessProcessorRuleApplicationSession: a session to apply process processors to processes
  • ProcessProcessorEnablerLookupSession : a session to retrieve process processor enablers
  • ProcessProcessorEnablerQuerySession : a session to query for process processor enablers
  • ProcessProcessorEnablerSearchSession : a session to search for process processor enablers
  • ProcessProcessorEnablerAdminSession : a session to create and delete process processor enablers
  • ProcessProcessorEnablerNotificationSession : a session to receive notifications pertaining to process processor enabler changes
  • ProcessProcessorEnablerOfficeSession : a session to look up process processor enabler office mappings
  • ProcessProcessorEnablerOfficeAssignmentSession : a session to manage process processor enabler to office mappings
  • ProcessProcessorEnablerSmartOfficeSession : a session to manage dynamic offices of process processor enablers
  • ProcessProcessorEnablerRuleLookupSession : a session to look up process processor enablers to process processor mappings
  • ProcessProcessorEnablerRuleApplicationSession: a session to apply process processor enablers to process processors
  • StepEnablerLookupSession : a session to retrieve step enablers
  • StepEnablerQuerySession : a session to query for step enablers
  • StepEnablerSearchSession : a session to search for step enablers
  • StepEnablerAdminSession : a session to create and delete step enablers
  • StepEnablerNotificationSession : a session to receive notifications pertaining to step enabler changes
  • StepEnablerOfficeSession : a session to look up step enabler office mappings
  • StepEnablerOfficeAssignmentSession : a session to manage step enabler to office mappings
  • StepEnablerSmartOfficeSession : a session to manage dynamic offices of step enablers
  • StepEnablerRuleLookupSession : a session to look up step enablers to step mappings
  • StepEnablerRuleApplicationSession: a session to apply step enablers to steps
  • StepConstrainerLookupSession : a session to retrieve step constrainer
  • StepConstrainerQuerySession : a session to query for step constrainer
  • StepConstrainerSearchSession : a session to search for step constrainer
  • StepConstrainerAdminSession : a session to create and delete step constrainer
  • StepConstrainerNotificationSession : a session to receive notifications pertaining to step constrainer changes
  • StepConstrainerOfficeSession : a session to look up step constrainer office mappings
  • StepConstrainerOfficeAssignmentSession : a session to manage step constrainer to office mappings
  • StepConstrainerSmartOfficeSession : a session to manage dynamic office of step constrainer
  • StepConstrainerRuleLookupSession : a session to look up step constrainer to step mappings
  • StepConstrainerRuleApplicationSession : a session to apply step constrainer to steps
  • StepConstrainerEnablerLookupSession : a session to retrieve step constrainer enablers
  • StepConstrainerEnablerQuerySession : a session to query for step constrainer enablers
  • StepConstrainerEnablerSearchSession : a session to search for step constrainer enablers
  • StepConstrainerEnablerAdminSession : a session to create and delete step constrainer enablers
  • StepConstrainerEnablerNotificationSession : a session to receive notifications pertaining to step constrainer enabler changes
  • StepConstrainerEnablerOfficeSession : a session to look up step constrainer enabler office mappings
  • StepConstrainerEnablerOfficeAssignmentSession : a session to manage step constrainer enabler to office mappings
  • StepConstrainerEnablerSmartOfficeSession : a session to manage dynamic office of step constrainer enablers
  • StepConstrainerEnableRuleLookupSession : a session to look up step constrainer enabler mappings
  • StepConstrainerEnablerRuleApplicationSession : a session to apply step constrainer enablers
  • StepProcessorLookupSession : a session to retrieve step processor
  • StepProcessorQuerySession : a session to query for step processor
  • StepProcessorSearchSession : a session to search for step processor
  • StepProcessorAdminSession : a session to create and delete step processor
  • StepProcessorNotificationSession : a session to receive notifications pertaining to step processor changes
  • StepProcessorOfficeSession : a session to look up step processor office mappings
  • StepProcessorOfficeAssignmentSession : a session to manage step processor to office mappings
  • StepProcessorSmartOfficeSession : a session to manage dynamic office of step processor
  • StepProcessorRuleLookupSession : a session to look up step processor to step mappings
  • StepProcessorRuleApplicationSession : a session to apply step processor to steps
  • StepProcessorEnablerLookupSession : a session to retrieve step processor enablers
  • StepProcessorEnablerQuerySession : a session to query for step processor enablers
  • StepProcessorEnablerSearchSession : a session to search for step processor enablers
  • StepProcessorEnablerAdminSession : a session to create and delete step processor enablers
  • StepProcessorEnablerNotificationSession : a session to receive notifications pertaining to step processor enabler changes
  • StepProcessorEnablerOfficeSession : a session to look up step processor enabler office mappings
  • StepProcessorEnablerOfficeAssignmentSession : a session to manage step processor enabler to office mappings
  • StepProcessorEnablerSmartOfficeSession : a session to manage dynamic office of step processor enablers
  • StepProcessorEnablerRuleLookupSession : a session to look up step processor enabler mappings
  • StepProcessorEnablerRuleApplicationSession : a session to apply step processor enablers
  • ProcessEnablerLookupSession : a session to retrieve process enabler
  • ProcessEnablerQuerySession : a session to query for process enabler
  • ProcessEnablerSearchSession : a session to search for process enabler
  • ProcessEnablerAdminSession : a session to create and delete process enabler
  • ProcessEnablerNotificationSession : a session to receive notifications pertaining to process enabler changes
  • ProcessEnablerOfficeSession : a session to look up process enabler office mappings
  • ProcessEnablerOfficeAssignmentSession : a session to manage process enabler to office mappings
  • ProcessEnablerSmartOfficeSession : a session to manage dynamic office of process enabler
  • ProcessEnablerRuleLookupSession : a session to look up process enabler to process mappings
  • ProcessEnablerRuleApplicationSession : a session to apply process enabler to processs

  • Method Details

    • getProcessEnablerLookupSession

      ProcessEnablerLookupSession getProcessEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process enabler lookup service.
      Returns:
      a ProcessEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerLookup()} is {@code true} .

    • getProcessEnablerLookupSessionForOffice

      ProcessEnablerLookupSession getProcessEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerQuerySession

      ProcessEnablerQuerySession getProcessEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the process enabler query service.
      Returns:
      a ProcessEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerQuery()} is {@code true} .

    • getProcessEnablerQuerySessionForOffice

      ProcessEnablerQuerySession getProcessEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerSearchSession

      ProcessEnablerSearchSession getProcessEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the process enabler search service.
      Returns:
      a ProcessEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerSearch()} is {@code true} .

    • getProcessEnablerSearchSessionForOffice

      ProcessEnablerSearchSession getProcessEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerAdminSession

      ProcessEnablerAdminSession getProcessEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the process enabler administration service.
      Returns:
      a ProcessEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerAdmin()} is {@code true} .

    • getProcessEnablerAdminSessionForOffice

      ProcessEnablerAdminSession getProcessEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerNotificationSession

      ProcessEnablerNotificationSession getProcessEnablerNotificationSession(ProcessEnablerReceiver processEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the process enabler notification service.
      Parameters:
      processEnablerReceiver - the notification callback
      Returns:
      a ProcessEnablerNotificationSession
      Throws:
      NullArgumentException - processReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerNotification()} is {@code true} .

    • getProcessEnablerNotificationSessionForOffice

      ProcessEnablerNotificationSession getProcessEnablerNotificationSessionForOffice(ProcessEnablerReceiver processEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler notification service for the given office.
      Parameters:
      processEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - processEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerOfficeSession

      ProcessEnablerOfficeSession getProcessEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup process enabler/office mappings.
      Returns:
      a ProcessEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerOffice()} is {@code true} .

    • getProcessEnablerOfficeAssignmentSession

      ProcessEnablerOfficeAssignmentSession getProcessEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning process enablers to offices.
      Returns:
      a ProcessEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerOfficeAssignment()} is {@code true} .

    • getProcessEnablerSmartOfficeSession

      ProcessEnablerSmartOfficeSession getProcessEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage process enabler smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerSmartOffice()} is {@code true} .

    • getProcessEnablerRuleLookupSession

      ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process enabler process mapping lookup service for looking up the rules applied to a process.
      Returns:
      a ProcessEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerRuleLookup()} is {@code true} .

    • getProcessEnablerRuleLookupSessionForOffice

      ProcessEnablerRuleLookupSession getProcessEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler mapping lookup service for the given office for looking up rules applied to a process.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessEnablerRuleApplicationSession

      ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer assignment service to apply to processes.
      Returns:
      a ProcessEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerRuleApplication()} is {@code true} .

    • getProcessEnablerRuleApplicationSessionForOffice

      ProcessEnablerRuleApplicationSession getProcessEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process enabler assignment service for the given office to apply to processes.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerLookupSession

      ProcessConstrainerLookupSession getProcessConstrainerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer lookup service.
      Returns:
      a ProcessConstrainerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerLookup()} is {@code true} .

    • getProcessConstrainerLookupSessionForOffice

      ProcessConstrainerLookupSession getProcessConstrainerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerQuerySession

      ProcessConstrainerQuerySession getProcessConstrainerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer query service.
      Returns:
      a ProcessConstrainerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerQuery()} is {@code true} .

    • getProcessConstrainerQuerySessionForOffice

      ProcessConstrainerQuerySession getProcessConstrainerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerSearchSession

      ProcessConstrainerSearchSession getProcessConstrainerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer search service.
      Returns:
      a ProcessConstrainerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerSearch()} is {@code true} .

    • getProcessConstrainerSearchSessionForOffice

      ProcessConstrainerSearchSession getProcessConstrainerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerAdminSession

      ProcessConstrainerAdminSession getProcessConstrainerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer administration service.
      Returns:
      a ProcessConstrainerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerAdmin()} is {@code true} .

    • getProcessConstrainerAdminSessionForOffice

      ProcessConstrainerAdminSession getProcessConstrainerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerNotificationSession

      ProcessConstrainerNotificationSession getProcessConstrainerNotificationSession(ProcessConstrainerReceiver processConstrainerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the process constrainer notification service.
      Parameters:
      processConstrainerReceiver - the notification callback
      Returns:
      a ProcessConstrainerNotificationSession
      Throws:
      NullArgumentException - processConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerNotification()} is {@code true} .

    • getProcessConstrainerNotificationSessionForOffice

      ProcessConstrainerNotificationSession getProcessConstrainerNotificationSessionForOffice(ProcessConstrainerReceiver processConstrainerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer notification service for the given office.
      Parameters:
      processConstrainerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - processConstrainerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerOfficeSession

      ProcessConstrainerOfficeSession getProcessConstrainerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup process constrainer/office mappings.
      Returns:
      a ProcessConstrainerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerOffice()} is {@code true} .

    • getProcessConstrainerOfficeAssignmentSession

      ProcessConstrainerOfficeAssignmentSession getProcessConstrainerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning process constrainers to offices.
      Returns:
      a ProcessConstrainerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerOfficeAssignment()} is {@code true} .

    • getProcessConstrainerSmartOfficeSession

      ProcessConstrainerSmartOfficeSession getProcessConstrainerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage process constrainer smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerSmartOffice()} is {@code true} .

    • getProcessConstrainerRuleLookupSession

      ProcessConstrainerRuleLookupSession getProcessConstrainerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer process mapping lookup service for looking up the rules applied to a process.
      Returns:
      a ProcessConstrainerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerRuleLookup()} is {@code true} .

    • getProcessConstrainerRuleLookupSessionForOffice

      ProcessConstrainerRuleLookupSession getProcessConstrainerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer mapping lookup service for the given office for looking up rules applied to a process.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerRuleApplicationSession

      ProcessConstrainerRuleApplicationSession getProcessConstrainerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer assignment service to apply to processes.
      Returns:
      a ProcessConstrainerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerRuleApplication()} is {@code true} .

    • getProcessConstrainerRuleApplicationSessionForOffice

      ProcessConstrainerRuleApplicationSession getProcessConstrainerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer assignment service for the given office to apply to processes.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerLookupSession

      ProcessConstrainerEnablerLookupSession getProcessConstrainerEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler lookup service.
      Returns:
      a ProcessConstrainerEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerLookup()} is {@code true} .

    • getProcessConstrainerEnablerLookupSessionForOffice

      ProcessConstrainerEnablerLookupSession getProcessConstrainerEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerQuerySession

      ProcessConstrainerEnablerQuerySession getProcessConstrainerEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler query service.
      Returns:
      a ProcessConstrainerEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerQuery()} is {@code true} .

    • getProcessConstrainerEnablerQuerySessionForOffice

      ProcessConstrainerEnablerQuerySession getProcessConstrainerEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerSearchSession

      ProcessConstrainerEnablerSearchSession getProcessConstrainerEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler search service.
      Returns:
      a ProcessConstrainerEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSearch()} is {@code true} .

    • getProcessConstrainerEnablerSearchSessionForOffice

      ProcessConstrainerEnablerSearchSession getProcessConstrainerEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerAdminSession

      ProcessConstrainerEnablerAdminSession getProcessConstrainerEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler administration service.
      Returns:
      a ProcessConstrainerEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerAdmin()} is {@code true} .

    • getProcessConstrainerEnablerAdminSessionForOffice

      ProcessConstrainerEnablerAdminSession getProcessConstrainerEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessConstrainerEnablerNotificationSession

      ProcessConstrainerEnablerNotificationSession getProcessConstrainerEnablerNotificationSession(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler notification service.
      Parameters:
      processConstrainerEnablerReceiver - the notification callback
      Returns:
      a ProcessConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - processConstrainerEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerNotification()} is {@code true} .

    • getProcessConstrainerEnablerNotificationSessionForOffice

      ProcessConstrainerEnablerNotificationSession getProcessConstrainerEnablerNotificationSessionForOffice(ProcessConstrainerEnablerReceiver processConstrainerEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler notification service for the given office.
      Parameters:
      processConstrainerEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - processConstrainerEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerOfficeSession

      ProcessConstrainerEnablerOfficeSession getProcessConstrainerEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup process constrainer enabler/office mappings.
      Returns:
      a ProcessConstrainerEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerOffice()} is {@code true} .

    • getProcessConstrainerEnablerOfficeAssignmentSession

      ProcessConstrainerEnablerOfficeAssignmentSession getProcessConstrainerEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning process constrainer enablers to offices.
      Returns:
      a ProcessConstrainerEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerOfficeAssignment()} is {@code true} .

    • getProcessConstrainerEnablerSmartOfficeSession

      ProcessConstrainerEnablerSmartOfficeSession getProcessConstrainerEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage process constrainer enabler smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerSmartOffice()} is {@code true} .

    • getProcessConstrainerEnablerRuleLookupSession

      ProcessConstrainerEnablerRuleLookupSession getProcessConstrainerEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler process mapping lookup service for looking up the rules applied to a process constrainer.
      Returns:
      a ProcessConstrainerEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleLookup()} is {@code true} .

    • getProcessConstrainerEnablerRuleLookupSessionForOffice

      ProcessConstrainerEnablerRuleLookupSession getProcessConstrainerEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler mapping lookup service for the given office for looking up rules applied to a process constrainer.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessConstrainerEnablerRuleApplicationSession

      ProcessConstrainerEnablerRuleApplicationSession getProcessConstrainerEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler assignment service to apply to process constrainers.
      Returns:
      a ProcessConstrainerEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnablerRuleApplication()} is {@code true} .

    • getProcessConstrainerEnablerRuleApplicationSessionForOffice

      ProcessConstrainerEnablerRuleApplicationSession getProcessConstrainerEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process constrainer enabler assignment service for the given office to apply to process constrainers.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessConstrainerEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorLookupSession

      ProcessProcessorLookupSession getProcessProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor lookup service.
      Returns:
      a ProcessProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorLookup()} is {@code true} .

    • getProcessProcessorLookupSessionForOffice

      ProcessProcessorLookupSession getProcessProcessorLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessProcessorQuerySession

      ProcessProcessorQuerySession getProcessProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the process processor query service.
      Returns:
      a ProcessProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorQuery()} is {@code true} .

    • getProcessProcessorQuerySessionForOffice

      ProcessProcessorQuerySession getProcessProcessorQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorSearchSession

      ProcessProcessorSearchSession getProcessProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor search service.
      Returns:
      a ProcessProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorSearch()} is {@code true} .

    • getProcessProcessorSearchSessionForOffice

      ProcessProcessorSearchSession getProcessProcessorSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessProcessorAdminSession

      ProcessProcessorAdminSession getProcessProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor administration service.
      Returns:
      a ProcessProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorAdmin()} is {@code true} .

    • getProcessProcessorAdminSessionForOffice

      ProcessProcessorAdminSession getProcessProcessorAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorNotificationSession

      ProcessProcessorNotificationSession getProcessProcessorNotificationSession(ProcessProcessorReceiver processProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the process processor notification service.
      Parameters:
      processProcessorReceiver - the notification callback
      Returns:
      a ProcessProcessorNotificationSession
      Throws:
      NullArgumentException - processConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorNotification()} is {@code true} .

    • getProcessProcessorNotificationSessionForOffice

      ProcessProcessorNotificationSession getProcessProcessorNotificationSessionForOffice(ProcessProcessorReceiver processProcessorReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor notification service for the given office.
      Parameters:
      processProcessorReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - processProcessorReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorOfficeSession

      ProcessProcessorOfficeSession getProcessProcessorOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup process processor/office mappings.
      Returns:
      a ProcessProcessorOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorOffice()} is {@code true} .

    • getProcessProcessorOfficeAssignmentSession

      ProcessProcessorOfficeAssignmentSession getProcessProcessorOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning process processors to offices.
      Returns:
      a ProcessProcessorOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorOfficeAssignment()} is {@code true} .

    • getProcessProcessorSmartOfficeSession

      ProcessProcessorSmartOfficeSession getProcessProcessorSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage process processor smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorSmartOffice()} is {@code true} .

    • getProcessProcessorRuleLookupSession

      ProcessProcessorRuleLookupSession getProcessProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor process mapping lookup service for looking up the rules applied to a process.
      Returns:
      a ProcessProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorRuleLookup()} is {@code true} .

    • getProcessProcessorRuleLookupSessionForOffice

      ProcessProcessorRuleLookupSession getProcessProcessorRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor mapping lookup service for the given office for looking up rules applied to a processes.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorRuleApplicationSession

      ProcessProcessorRuleApplicationSession getProcessProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor assignment service to apply to processes.
      Returns:
      a ProcessProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorRuleApplication()} is {@code true} .

    • getProcessProcessorRuleApplicationSessionForOffice

      ProcessProcessorRuleApplicationSession getProcessProcessorRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor assignment service for the given office to apply to processes.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorEnablerLookupSession

      ProcessProcessorEnablerLookupSession getProcessProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler lookup service.
      Returns:
      a ProcessProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerLookup()} is {@code true} .

    • getProcessProcessorEnablerLookupSessionForOffice

      ProcessProcessorEnablerLookupSession getProcessProcessorEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorEnablerQuerySession

      ProcessProcessorEnablerQuerySession getProcessProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler query service.
      Returns:
      a ProcessProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerQuery()} is {@code true} .

    • getProcessProcessorEnablerQuerySessionForOffice

      ProcessProcessorEnablerQuerySession getProcessProcessorEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessProcessorEnablerSearchSession

      ProcessProcessorEnablerSearchSession getProcessProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler search service.
      Returns:
      a ProcessProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerSearch()} is {@code true} .

    • getProcessProcessorEnablerSearchSessionForOffice

      ProcessProcessorEnablerSearchSession getProcessProcessorEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessProcessorEnablerAdminSession

      ProcessProcessorEnablerAdminSession getProcessProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler administration service.
      Returns:
      a ProcessProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerAdmin()} is {@code true} .

    • getProcessProcessorEnablerAdminSessionForOffice

      ProcessProcessorEnablerAdminSession getProcessProcessorEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true}

    • getProcessProcessorEnablerNotificationSession

      ProcessProcessorEnablerNotificationSession getProcessProcessorEnablerNotificationSession(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler notification service.
      Parameters:
      processProcessorEnablerReceiver - the notification callback
      Returns:
      a ProcessProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - processProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerNotification()} is {@code true} .

    • getProcessProcessorEnablerNotificationSessionForOffice

      ProcessProcessorEnablerNotificationSession getProcessProcessorEnablerNotificationSessionForOffice(ProcessProcessorEnablerReceiver processProcessorEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler notification service for the given office.
      Parameters:
      processProcessorEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - processProcessorEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorEnablerOfficeSession

      ProcessProcessorEnablerOfficeSession getProcessProcessorEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup process processor enabler/office mappings.
      Returns:
      a ProcessProcessorEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerOffice()} is {@code true} .

    • getProcessProcessorEnablerOfficeAssignmentSession

      ProcessProcessorEnablerOfficeAssignmentSession getProcessProcessorEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning process processors enablers to offices.
      Returns:
      a ProcessProcessorEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerOfficeAssignment()} is {@code true} .

    • getProcessProcessorEnablerSmartOfficeSession

      ProcessProcessorEnablerSmartOfficeSession getProcessProcessorEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage process processor enabler smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerSmartOffice()} is {@code true} .

    • getProcessProcessorEnablerRuleLookupSession

      ProcessProcessorEnablerRuleLookupSession getProcessProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler process mapping lookup service for looking up the rules applied to a process processor.
      Returns:
      a ProcessProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleLookup()} is {@code true} .

    • getProcessProcessorEnablerRuleLookupSessionForOffice

      ProcessProcessorEnablerRuleLookupSession getProcessProcessorEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler mapping lookup service for the given office for looking up rules applied to a process processors.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getProcessProcessorEnablerRuleApplicationSession

      ProcessProcessorEnablerRuleApplicationSession getProcessProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the process processor enabler assignment service to apply to process processors.
      Returns:
      a ProcessProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnablerRuleApplication()} is {@code true} .

    • getProcessProcessorEnablerRuleApplicationSessionForOffice

      ProcessProcessorEnablerRuleApplicationSession getProcessProcessorEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the process processor enabler assignment service for the given office to apply to process processors.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a ProcessProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsProcessProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProcessProcessorEnabelrRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerLookupSession

      StepEnablerLookupSession getStepEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step enabler lookup service.
      Returns:
      a StepEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerLookup()} is {@code true} .

    • getStepEnablerLookupSessionForOffice

      StepEnablerLookupSession getStepEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerQuerySession

      StepEnablerQuerySession getStepEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the step enabler query service.
      Returns:
      a StepEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerQuery()} is {@code true} .

    • getStepEnablerQuerySessionForOffice

      StepEnablerQuerySession getStepEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerQuerySession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerSearchSession

      StepEnablerSearchSession getStepEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the step enabler search service.
      Returns:
      a StepEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerSearch()} is {@code true} .

    • getStepEnablerSearchSessionForOffice

      StepEnablerSearchSession getStepEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler search service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerSearchSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerAdminSession

      StepEnablerAdminSession getStepEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the step enabler administration service.
      Returns:
      a StepEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerAdmin()} is {@code true} .

    • getStepEnablerAdminSessionForOffice

      StepEnablerAdminSession getStepEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerAdminSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerNotificationSession

      StepEnablerNotificationSession getStepEnablerNotificationSession(StepEnablerReceiver stepEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the step enabler notification service.
      Parameters:
      stepEnablerReceiver - the notification callback
      Returns:
      a StepEnablerNotificationSession
      Throws:
      NullArgumentException - stepReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerNotification()} is {@code true} .

    • getStepEnablerNotificationSessionForOffice

      StepEnablerNotificationSession getStepEnablerNotificationSessionForOffice(StepEnablerReceiver stepEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler notification service for the given office.
      Parameters:
      stepEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a StepEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - stepEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerOfficeSession

      StepEnablerOfficeSession getStepEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup step enabler/office mappings.
      Returns:
      a StepEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerOffice()} is {@code true} .

    • getStepEnablerOfficeAssignmentSession

      StepEnablerOfficeAssignmentSession getStepEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning step enablers to offices.
      Returns:
      a StepEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerOfficeAssignment()} is {@code true} .

    • getStepEnablerSmartOfficeSession

      StepEnablerSmartOfficeSession getStepEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage step enabler smart offices.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerSmartOfficeSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerSmartOffice()} is {@code true} .

    • getStepEnablerRuleLookupSession

      StepEnablerRuleLookupSession getStepEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step enabler step mapping lookup service for looking up the rules applied to a step.
      Returns:
      a StepEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerRuleLookup()} is {@code true} .

    • getStepEnablerRuleLookupSessionForOffice

      StepEnablerRuleLookupSession getStepEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler mapping lookup service for the given office for looking up rules applied to a step.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepEnablerRuleApplicationSession

      StepEnablerRuleApplicationSession getStepEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer assignment service to apply to steps.
      Returns:
      a StepEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerRuleApplication()} is {@code true} .

    • getStepEnablerRuleApplicationSessionForOffice

      StepEnablerRuleApplicationSession getStepEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step enabler assignment service for the given office to apply to steps.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerLookupSession

      StepConstrainerLookupSession getStepConstrainerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer lookup service.
      Returns:
      a StepConstrainerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerLookup()} is {@code true} .

    • getStepConstrainerLookupSessionForOffice

      StepConstrainerLookupSession getStepConstrainerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerQuerySession

      StepConstrainerQuerySession getStepConstrainerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer query service.
      Returns:
      a StepConstrainerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerQuery()} is {@code true} .

    • getStepConstrainerQuerySessionForOffice

      StepConstrainerQuerySession getStepConstrainerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerQuerySession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerSearchSession

      StepConstrainerSearchSession getStepConstrainerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer search service.
      Returns:
      a StepConstrainerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerSearch()} is {@code true} .

    • getStepConstrainerSearchSessionForOffice

      StepConstrainerSearchSession getStepConstrainerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer earch service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerSearchSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerAdminSession

      StepConstrainerAdminSession getStepConstrainerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer administration service.
      Returns:
      a StepConstrainerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerAdmin()} is {@code true} .

    • getStepConstrainerAdminSessionForOffice

      StepConstrainerAdminSession getStepConstrainerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerAdminSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerNotificationSession

      StepConstrainerNotificationSession getStepConstrainerNotificationSession(StepConstrainerReceiver stepConstrainerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the step constrainer notification service.
      Parameters:
      stepConstrainerReceiver - the notification callback
      Returns:
      a StepConstrainerNotificationSession
      Throws:
      NullArgumentException - stepConstrainerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerNotification()} is {@code true} .

    • getStepConstrainerNotificationSessionForOffice

      StepConstrainerNotificationSession getStepConstrainerNotificationSessionForOffice(StepConstrainerReceiver stepConstrainerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer notification service for the given office.
      Parameters:
      stepConstrainerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a StepConstrainerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - stepConstrainerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerOfficeSession

      StepConstrainerOfficeSession getStepConstrainerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup step constrainer/office mappings for step constrainers.
      Returns:
      a StepConstrainerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerOffice()} is {@code true} .

    • getStepConstrainerOfficeAssignmentSession

      StepConstrainerOfficeAssignmentSession getStepConstrainerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning step constrainer to office.
      Returns:
      a StepConstrainerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerOfficeAssignment()} is {@code true} .

    • getStepConstrainerSmartOfficeSession

      StepConstrainerSmartOfficeSession getStepConstrainerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage step constrainer smart office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerSmartOfficeSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerSmartOffice()} is {@code true} .

    • getStepConstrainerRuleLookupSession

      StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer mapping lookup service for looking up the rules applied to a step.
      Returns:
      a StepConstrainerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerRuleLookup()} is {@code true} .

    • getStepConstrainerRuleLookupSessionForOffice

      StepConstrainerRuleLookupSession getStepConstrainerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer mapping lookup service for the given office for looking up rules applied to a step.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerRuleApplicationSession

      StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer assignment service to apply to steps.
      Returns:
      a StepConstrainerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerRuleApplication()} is {@code true} .

    • getStepConstrainerRuleApplicationSessionForOffice

      StepConstrainerRuleApplicationSession getStepConstrainerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer assignment service for the given office to apply to steps.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerLookupSession

      StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler lookup service.
      Returns:
      a StepConstrainerEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerLookup()} is {@code true} .

    • getStepConstrainerEnablerLookupSessionForOffice

      StepConstrainerEnablerLookupSession getStepConstrainerEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerQuerySession

      StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler query service.
      Returns:
      a StepConstrainerEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerQuery()} is {@code true} .

    • getStepConstrainerEnablerQuerySessionForOffice

      StepConstrainerEnablerQuerySession getStepConstrainerEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerQuerySession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerSearchSession

      StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler search service.
      Returns:
      a StepConstrainerEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerSearch()} is {@code true} .

    • getStepConstrainerEnablerSearchSessionForOffice

      StepConstrainerEnablerSearchSession getStepConstrainerEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enablers earch service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerSearchSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerAdminSession

      StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler administration service.
      Returns:
      a StepConstrainerEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerAdmin()} is {@code true} .

    • getStepConstrainerEnablerAdminSessionForOffice

      StepConstrainerEnablerAdminSession getStepConstrainerEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerAdminSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerNotificationSession

      StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSession(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler notification service.
      Parameters:
      stepConstrainerEnablerReceiver - the notification callback
      Returns:
      a StepConstrainerEnablerNotificationSession
      Throws:
      NullArgumentException - stepConstrainerEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerNotification()} is {@code true} .

    • getStepConstrainerEnablerNotificationSessionForOffice

      StepConstrainerEnablerNotificationSession getStepConstrainerEnablerNotificationSessionForOffice(StepConstrainerEnablerReceiver stepConstrainerEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler notification service for the given office.
      Parameters:
      stepConstrainerEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - stepConstrainerEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerOfficeSession

      StepConstrainerEnablerOfficeSession getStepConstrainerEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup step constrainer enabler/office mappings for step constrainer enablers.
      Returns:
      a StepConstrainerEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerOffice()} is {@code true} .

    • getStepConstrainerEnablerOfficeAssignmentSession

      StepConstrainerEnablerOfficeAssignmentSession getStepConstrainerEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning step constrainer enablers to office.
      Returns:
      a StepConstrainerEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerOfficeAssignment()} is {@code true} .

    • getStepConstrainerEnablerSmartOfficeSession

      StepConstrainerEnablerSmartOfficeSession getStepConstrainerEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage step constrainer enabler smart office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerSmartOfficeSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerSmartOffice()} is {@code true} .

    • getStepConstrainerEnablerRuleLookupSession

      StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler mapping lookup service.
      Returns:
      a StepConstrainerEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleLookup()} is {@code true} .

    • getStepConstrainerEnablerRuleLookupSessionForOffice

      StepConstrainerEnablerRuleLookupSession getStepConstrainerEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler mapping lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepConstrainerEnablerRuleApplicationSession

      StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler assignment service.
      Returns:
      a StepConstrainerEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleApplication()} is {@code true} .

    • getStepConstrainerEnablerRuleApplicationSessionForOffice

      StepConstrainerEnablerRuleApplicationSession getStepConstrainerEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step constrainer enabler assignment service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepConstrainerEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepConstrainerEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepConstrainerEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorLookupSession

      StepProcessorLookupSession getStepProcessorLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor lookup service.
      Returns:
      a StepProcessorLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorLookup()} is {@code true} .

    • getStepProcessorLookupSessionForOffice

      StepProcessorLookupSession getStepProcessorLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorQuerySession

      StepProcessorQuerySession getStepProcessorQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the step processor query service.
      Returns:
      a StepProcessorQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorQuery()} is {@code true} .

    • getStepProcessorQuerySessionForOffice

      StepProcessorQuerySession getStepProcessorQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorQuerySession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorSearchSession

      StepProcessorSearchSession getStepProcessorSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor search service.
      Returns:
      a StepProcessorSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorSearch()} is {@code true} .

    • getStepProcessorSearchSessionForOffice

      StepProcessorSearchSession getStepProcessorSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor earch service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorSearchSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorAdminSession

      StepProcessorAdminSession getStepProcessorAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor administration service.
      Returns:
      a StepProcessorAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorAdmin()} is {@code true} .

    • getStepProcessorAdminSessionForOffice

      StepProcessorAdminSession getStepProcessorAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorAdminSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorNotificationSession

      StepProcessorNotificationSession getStepProcessorNotificationSession(StepProcessorReceiver stepProcessorReceiver) throws OperationFailedException
      Gets the OsidSession associated with the step processor notification service.
      Parameters:
      stepProcessorReceiver - the notification callback
      Returns:
      a StepProcessorNotificationSession
      Throws:
      NullArgumentException - stepProcessorReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorNotification()} is {@code true} .

    • getStepProcessorNotificationSessionForOffice

      StepProcessorNotificationSession getStepProcessorNotificationSessionForOffice(StepProcessorReceiver stepProcessorReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor notification service for the given office.
      Parameters:
      stepProcessorReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a StepProcessorNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - stepProcessorReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorOfficeSession

      StepProcessorOfficeSession getStepProcessorOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup step processor/office mappings for step processors.
      Returns:
      a StepProcessorOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorOffice()} is {@code true} .

    • getStepProcessorOfficeAssignmentSession

      StepProcessorOfficeAssignmentSession getStepProcessorOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning step processor to office.
      Returns:
      a StepProcessorOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorOfficeAssignment()} is {@code true} .

    • getStepProcessorSmartOfficeSession

      StepProcessorSmartOfficeSession getStepProcessorSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage step processor smart office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorSmartOfficeSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorSmartOffice()} is {@code true} .

    • getStepProcessorRuleLookupSession

      StepProcessorRuleLookupSession getStepProcessorRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor mapping lookup service for looking up the rules applied to a step.
      Returns:
      a StepProcessorRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorRuleLookup()} is {@code true} .

    • getStepProcessorRuleLookupSessionForOffice

      StepProcessorRuleLookupSession getStepProcessorRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor mapping lookup service for the given office for looking up rules applied to a step.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorRuleApplicationSession

      StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor assignment service.
      Returns:
      a StepProcessorRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorRuleApplication()} is {@code true} .

    • getStepProcessorRuleApplicationSessionForOffice

      StepProcessorRuleApplicationSession getStepProcessorRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor assignment service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerLookupSession

      StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler lookup service.
      Returns:
      a StepProcessorEnablerLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerLookup()} is {@code true} .

    • getStepProcessorEnablerLookupSessionForOffice

      StepProcessorEnablerLookupSession getStepProcessorEnablerLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler lookup service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerQuerySession

      StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler query service.
      Returns:
      a StepProcessorEnablerQuerySession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerQuery()} is {@code true} .

    • getStepProcessorEnablerQuerySessionForOffice

      StepProcessorEnablerQuerySession getStepProcessorEnablerQuerySessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler query service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerQuerySession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerQuery() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerQuery()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerSearchSession

      StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler search service.
      Returns:
      a StepProcessorEnablerSearchSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerSearch() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerSearch()} is {@code true} .

    • getStepProcessorEnablerSearchSessionForOffice

      StepProcessorEnablerSearchSession getStepProcessorEnablerSearchSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enablers earch service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerSearchSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerSearch() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerSearch()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerAdminSession

      StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler administration service.
      Returns:
      a StepProcessorEnablerAdminSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerAdmin() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerAdmin()} is {@code true} .

    • getStepProcessorEnablerAdminSessionForOffice

      StepProcessorEnablerAdminSession getStepProcessorEnablerAdminSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler administration service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerAdminSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerAdmin() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerAdmin()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerNotificationSession

      StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSession(StepProcessorEnablerReceiver stepProcessorEnablerReceiver) throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler notification service.
      Parameters:
      stepProcessorEnablerReceiver - the notification callback
      Returns:
      a StepProcessorEnablerNotificationSession
      Throws:
      NullArgumentException - stepProcessorEnablerReceiver is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerNotification() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerNotification()} is {@code true} .

    • getStepProcessorEnablerNotificationSessionForOffice

      StepProcessorEnablerNotificationSession getStepProcessorEnablerNotificationSessionForOffice(StepProcessorEnablerReceiver stepProcessorEnablerReceiver, Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler notification service for the given office.
      Parameters:
      stepProcessorEnablerReceiver - the notification callback
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerNotificationSession
      Throws:
      NotFoundException - no office found by the given Id
      NullArgumentException - stepProcessorEnablerReceiver or officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerNotification() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerNotification()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerOfficeSession

      StepProcessorEnablerOfficeSession getStepProcessorEnablerOfficeSession() throws OperationFailedException
      Gets the OsidSession to lookup step processor enabler/office mappings for step processor enablers.
      Returns:
      a StepProcessorEnablerOfficeSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerOffice()} is {@code true} .

    • getStepProcessorEnablerOfficeAssignmentSession

      StepProcessorEnablerOfficeAssignmentSession getStepProcessorEnablerOfficeAssignmentSession() throws OperationFailedException
      Gets the OsidSession associated with assigning step processor enablers to office.
      Returns:
      a StepProcessorEnablerOfficeAssignmentSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerOfficeAssignment() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerOfficeAssignment()} is {@code true} .

    • getStepProcessorEnablerSmartOfficeSession

      StepProcessorEnablerSmartOfficeSession getStepProcessorEnablerSmartOfficeSession(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession to manage step processor enabler smart office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerSmartOfficeSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerSmartOffice() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerSmartOffice()} is {@code true} .

    • getStepProcessorEnablerRuleLookupSession

      StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler mapping lookup service.
      Returns:
      a StepProcessorEnablerRuleLookupSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerRuleLookup() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleLookup()} is {@code true} .

    • getStepProcessorEnablerRuleLookupSessionForOffice

      StepProcessorEnablerRuleLookupSession getStepProcessorEnablerRuleLookupSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler mapping lookup service.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerRuleLookupSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerRuleLookup() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleLookup()} and {@code supportsVisibleFederation()} are {@code true} .

    • getStepProcessorEnablerRuleApplicationSession

      StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSession() throws OperationFailedException
      Gets the OsidSession associated with the step processor enabler assignment service.
      Returns:
      a StepProcessorEnablerRuleApplicationSession
      Throws:
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerRuleApplication() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleApplication()} is {@code true} .

    • getStepProcessorEnablerRuleApplicationSessionForOffice

      StepProcessorEnablerRuleApplicationSession getStepProcessorEnablerRuleApplicationSessionForOffice(Id officeId) throws NotFoundException, OperationFailedException
      Gets the OsidSession associated with the step processor enabler assignment service for the given office.
      Parameters:
      officeId - the Id of the Office
      Returns:
      a StepProcessorEnablerRuleApplicationSession
      Throws:
      NotFoundException - no Office found by the given Id
      NullArgumentException - officeId is null
      OperationFailedException - unable to complete request
      UnimplementedException - supportsStepProcessorEnablerRuleApplication() or supportsVisibleFederation() is false
      Compliance:
      optional - This method must be implemented if {@code supportsStepProcessorEnablerRuleApplication()} and {@code supportsVisibleFederation()} are {@code true} .