Interface QueueProcessorEnablerFrontOfficeSession

All Superinterfaces:
AutoCloseable, Closeable, OsidSession, OsidSession
public interface QueueProcessorEnablerFrontOfficeSession extends OsidSession

This session provides methods to retrieve QueueProcessorEnabler to FrontOffice mappings. a QueueProcessorEnabler may appear in multiple FrontOffice objects. Each front office may have its own authorizations governing who is allowed to look at it.

This lookup session defines several views:

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete result set or is an error condition

  • Method Details

    • canLookupQueueProcessorEnablerFrontOfficeMappings

      boolean canLookupQueueProcessorEnablerFrontOfficeMappings()
      Tests if this user can perform lookups of queue processor enabler/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.
      Returns:
      false if looking up mappings is not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeQueueProcessorEnablerFrontOfficeView

      void useComparativeQueueProcessorEnablerFrontOfficeView()
      The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
      Compliance:
      mandatory - This method is must be implemented.

    • usePlenaryQueueProcessorEnablerFrontOfficeView

      void usePlenaryQueueProcessorEnablerFrontOfficeView()
      A complete view of the QueueProcessorEnabler and FrontOffice returns is desired. Methods will return what is requested or result in an error. This view is used when greater precision is desired at the expense of interoperability.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueProcessorEnablerIdsByFrontOffice

      IdList getQueueProcessorEnablerIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of QueueProcessorEnablerIds associated with a FrontFront Office .
      Parameters:
      frontOfficeId - Id of the FrontOffice
      Returns:
      list of related queue processor enabler Ids
      Throws:
      NotFoundException - frontOfficeId is not found
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablersByFrontOffice

      QueueProcessorEnablerList getQueueProcessorEnablersByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of queue processor enablers associated with a FrontFront Office .
      Parameters:
      frontOfficeId - Id of the FrontOffice
      Returns:
      list of related queue processor enablers
      Throws:
      NotFoundException - frontOfficeId is not found
      NullArgumentException - frontOfficeId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablerIdsByFrontOffices

      IdList getQueueProcessorEnablerIdsByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of QueueProcessorEnablerIds corresponding to a list of FrontOffices .
      Parameters:
      frontOfficeIds - list of front office Ids
      Returns:
      list of queue processor enabler Ids
      Throws:
      NullArgumentException - frontOfficeIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueProcessorEnablersByFrontOffices

      QueueProcessorEnablerList getQueueProcessorEnablersByFrontOffices(IdList frontOfficeIds) throws OperationFailedException, PermissionDeniedException
      Gets the list of queue processor enablers corresponding to a list of FrontOffices .
      Parameters:
      frontOfficeIds - list of front office Ids
      Returns:
      list of queue processor enablers
      Throws:
      NullArgumentException - frontOfficeIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOfficeIdsByQueueProcessorEnabler

      IdList getFrontOfficeIdsByQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the FrontOffice Ids mapped to a QueueProcessorEnabler .
      Parameters:
      queueProcessorEnablerId - Id of a QueueProcessorEnabler
      Returns:
      list of offices
      Throws:
      NotFoundException - queueProcessorEnablerId is not found
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOfficesByQueueProcessorEnabler

      FrontOfficeList getFrontOfficesByQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the FrontOffices mapped to a QueueProcessorEnabler .
      Parameters:
      queueProcessorEnablerId - Id of a QueueProcessorEnabler
      Returns:
      list of offices
      Throws:
      NotFoundException - queueProcessorEnablerId is not found
      NullArgumentException - queueProcessorEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.