Interface QueueConstrainerLookupSession

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

This session provides methods for retrieving QueueConstrainers .

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 constrainer methods in this session operate, retrieve and pertain to queue constrainer defined explicitly in the current front office. Using an isolated view is useful for managing QueueConstrainers with the QueueConstrainerAdminSession .
  • federated front office view: All queue constrainer methods in this session operate, retrieve and pertain to all queue constrainer defined in this front office and any other queue constrainer implicitly available in this front office through front office inheritence.
  • active queue constrainer view: All queue constrainer lookup methods return active queue constrainers.
  • any status queue constrainer view: Queue constrainers of any active or inactive status are returned from methods.

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() behave as a radio group and one should be selected before invoking the methods in this session.

  • 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 office
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • canLookupQueueConstrainers

      boolean canLookupQueueConstrainers()
      Tests if this user can perform QueueConstrainers 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.

    • useComparativeQueueConstrainerView

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

    • usePlenaryQueueConstrainerView

      void usePlenaryQueueConstrainerView()
      A complete view of the QueueConstrainer 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 constrainer 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.

    • useActiveQueueConstrainerView

      void useActiveQueueConstrainerView()
      Only active queue constrainers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • useAnyStatusQueueConstrainerView

      void useAnyStatusQueueConstrainerView()
      All active and inactive queue constrainers are returned by methods in this session.
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueConstrainer

      QueueConstrainer getQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets the QueueConstrainer specified by its Id . In plenary mode, the exact Id is found or a NOT_FOUND results. Otherwise, the returned QueueConstrainer may have a different Id than requested, such as the case where a duplicate Id was assigned to a QueueConstrainer and retained for compatibility. In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.
      Parameters:
      queueConstrainerId - Id of the QueueConstrainer
      Returns:
      the queue constrainer
      Throws:
      NotFoundException - queueConstrainerId not found
      NullArgumentException - queueConstrainerId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method is must be implemented.

    • getQueueConstrainersByIds

      QueueConstrainerList getQueueConstrainersByIds(IdList queueConstrainerIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a QueueConstrainerList corresponding to the given IdList . In plenary mode, the returned list contains all of the queue constrainer specified in the Id list, in the order of the list, including duplicates, or an error results if a Id in the supplied list is not found or inaccessible. Otherwise, inaccessible QueueConstrainers may be omitted from the list and may present the elements in any order including returning a unique set. In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.
      Parameters:
      queueConstrainerIds - the list of Ids to retrieve
      Returns:
      the returned QueueConstrainer list
      Throws:
      NotFoundException - a Id was not found
      NullArgumentException - queueConstrainerIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainersByGenusType

      QueueConstrainerList getQueueConstrainersByGenusType(Type queueConstrainerGenusType) throws OperationFailedException, PermissionDeniedException
      Gets a QueueConstrainerList corresponding to the given queue constrainer genus Type which does not include queue constrainer of genus types derived from the specified Type . In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session. In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.
      Parameters:
      queueConstrainerGenusType - a queue constrainer genus type
      Returns:
      the returned QueueConstrainer list
      Throws:
      NullArgumentException - queueConstrainerGenusType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainersByParentGenusType

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

    • getQueueConstrainersByRecordType

      QueueConstrainerList getQueueConstrainersByRecordType(Type queueConstrainerRecordType) throws OperationFailedException, PermissionDeniedException
      Gets a QueueConstrainerList containing the given queue constrainer record Type . In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session. In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.
      Parameters:
      queueConstrainerRecordType - a queue constrainer record type
      Returns:
      the returned QueueConstrainer list
      Throws:
      NullArgumentException - queueConstrainerRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getQueueConstrainers

      QueueConstrainerList getQueueConstrainers() throws OperationFailedException, PermissionDeniedException
      Gets all QueueConstrainers . In plenary mode, the returned list contains all known queue constrainer or an error results. Otherwise, the returned list may contain only those queue constrainer that are accessible through this session. In active mode, queue constrainers are returned that are currently active. In any status mode, active and inactive queue constrainers are returned.
      Returns:
      the returned QueueConstrainer list
      Throws:
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.