Interface QueueEnablerFrontOfficeSession

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

This session provides methods to retrieve QueueEnabler to FrontOffice mappings. A QueueEnabler may appear in multiple FrontOffices . 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

    • canLookupQueueEnablerFrontOfficeMappings

      boolean canLookupQueueEnablerFrontOfficeMappings()
      Tests if this user can perform lookups of queue enabler/front 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. T his 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.

    • useComparativeQueueEnablerFrontOfficeView

      void useComparativeQueueEnablerFrontOfficeView()
      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.

    • usePlenaryQueueEnablerFrontOfficeView

      void usePlenaryQueueEnablerFrontOfficeView()
      A complete view of the QueueEnabler 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.

    • getQueueEnablerIdsByFrontOffice

      IdList getQueueEnablerIdsByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of QueueEnabler Ids associated with a FrontOffice .
      Parameters:
      frontOfficeId - Id of the FrontOffice
      Returns:
      list of related queue 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.

    • getQueueEnablersByFrontOffice

      QueueEnablerList getQueueEnablersByFrontOffice(Id frontOfficeId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the list of QueueEnablers associated with a FrontOffice .
      Parameters:
      frontOfficeId - Id of the FrontOffice
      Returns:
      list of related queue 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.

    • getQueueEnablerIdsByFrontOffices

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

    • getQueueEnablersByFrontOffices

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

    • getFrontOfficeIdsByQueueEnabler

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

    • getFrontOfficesByQueueEnabler

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