Interface QueueEnablerLookupSession

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

This session provides methods for retrieving QueueEnablers .

This session defines views that offer differing behaviors when retrieving multiple objects.

  • comparative view: elements may be silently omitted or re-ordered
  • plenary view: provides a complete set or is an error condition
  • isolated front office view: All queue enabler methods in this session operate, retrieve and pertain to queue enablers defined explicitly in the current front office Using an isolated view is useful for managing QueueEnablers with the QueueEnablerAdminSession .
  • federated front office view: All queue enabler methods in this session operate, retrieve and pertain to all queue enablers defined in this front office and any other queue enablers implicitly available in this front office through front office inheritence.

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. The methods useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() be have as a radio group and one should be selected before invoking any lookup methods.

  • Method Details

    • getFrontOfficeId

      Id getFrontOfficeId()
      Gets the FrontOffice Id associated with this session.
      Returns:
      the FrontOffice Id associated with this session
      Compliance:
      mandatory - This method must be implemented.

    • getFrontOffice

      FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
      Gets the FrontOffice associated with this session.
      Returns:
      the front office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupQueueEnablers

      boolean canLookupQueueEnablers()
      Tests if this user can perform QueueEnabler lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all 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 lookup methods are not authorized, true otherwise
      Compliance:
      mandatory - This method must be implemented.

    • useComparativeQueueEnablerView

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

    • usePlenaryQueueEnablerView

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

    • useFederatedFrontOfficeView

      void useFederatedFrontOfficeView()
      Federates the view for methods in this session. A federated view will include queue enablers in front offices which are children of this front office in the front office hierarchy.
      Compliance:
      mandatory - This method is must be implemented.

    • useIsolatedFrontOfficeView

      void useIsolatedFrontOfficeView()
      Isolates the view for methods in this session. An isolated view restricts lookups to this front office only.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueEnabler

      QueueEnabler getQueueEnabler(Id queueEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueEnabler specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueEnabler may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueEnabler and reta ined for compatibility.
      Parameters:
      queueEnablerId - Id of the QueueEnabler
      Returns:
      the queue enabler
      Throws:
      NotFoundException - queueEnablerId not found
      NullArgumentException - queueEnablerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueEnablersByIds

      QueueEnablerList getQueueEnablersByIds(IdList queueEnablerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a QueueEnablerList corresponding to the given IdList . In plenary mode, the returned list contains all of the queue enablers specified in the Id list, in the order of the list, including duplicates, or an error results if an Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueEnablers may be om itted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      queueEnablerIds - the list of Ids to retrieve
      Returns:
      the returned QueueEnabler list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - queueEnablerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueEnablersByGenusType

      QueueEnablerList getQueueEnablersByGenusType(Type queueEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a QueueEnablerList corresponding to the given queue enabler genus Type which does not include queue enablers of genus types derived from the specified Type . In plenary mode, the returned list contains all known queue enablers or an error results. Otherwise, the returned list may contain only those queue enablers that are accessible through this session.
      Parameters:
      queueEnablerGenusType - a queue enabler genus type
      Returns:
      the returned QueueEnabler list
      Throws:
      NullArgumentException - queueEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueEnablersByParentGenusType

      QueueEnablerList getQueueEnablersByParentGenusType(Type queueEnablerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a QueueEnablerList corresponding to the given queue enabler genus Type and include any additional queue enablers with genus types derived from the specified Type . In plenary mode, the returned list contains all known queue enablers or an error results. Otherwise, the returned list may contain only those queue enablers that are accessible through this session.
      Parameters:
      queueEnablerGenusType - a queue genus type
      Returns:
      the returned QueueEnabler list
      Throws:
      NullArgumentException - queueEnablerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueEnablersByRecordType

      QueueEnablerList getQueueEnablersByRecordType(Type queueEnablerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a QueueEnablerList containing the given queue enabler record Type . In plenary mode, the returned list contains all known queue enablers or an error results. Otherwise, the returned list may contain only those queue enablers that are accessible through this session.
      Parameters:
      queueEnablerRecordType - a queue enabler record type
      Returns:
      the returned QueueEnabler list
      Throws:
      NullArgumentException - queueEnablerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueEnablers

      QueueEnablerList getQueueEnablers() throws OperationFailedException, PermissionDeniedException
      Gets all QueueEnablers . In plenary mode, the returned list contains all known queue enablers or an error results. Otherwise, the returned list may contain only those queue enablers that are accessible through this session.
      Returns:
      a list of QueueEnablers
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.