Interface MailboxLookupSession

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

This session provides methods for retrieving Mailbox objects. The Mailbox represents a collection messages.

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

Generally, the comparative view should be used for most applications as it permits operation even if there is data that cannot be accessed. For example, a browsing application may only need to examine the Mailboxes it can access, without breaking execution. However, an administrative application may require all Mailbox elements to be available.

Mailboxes may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Mailbox .

  • Method Details

    • canLookupMailboxes

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

    • useComparativeMailboxView

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

    • usePlenaryMailboxView

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

    • getMailbox

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

    • getMailboxesByIds

      MailboxList getMailboxesByIds(IdList mailboxIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
      Gets a MailboxLidt corresponding to the given IdList . In plenary mode, the returned list contains all of the mailboxes 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 mailboxes may be omitted from the list and may present the elements in any order including returning a unique set.
      Parameters:
      mailboxIds - the list of Ids to retrieve
      Returns:
      the returned Mailbox list
      Throws:
      NotFoundException - an Id was not found
      NullArgumentException - mailboxIds is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMailboxesByGenusType

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

    • getMailboxesByParentGenusType

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

    • getMailboxesByRecordType

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

    • getMailboxesByProvider

      MailboxList getMailboxesByProvider(Id resourceId) throws OperationFailedException, PermissionDeniedException
      Gets a MailboxList for the given provider. In plenary mode, the returned list contains all known mailboxes or an error results. Otherwise, the returned list may contain only those mailboxes that are accessible through this session.
      Parameters:
      resourceId - a resource Id
      Returns:
      the returned Mailbox list
      Throws:
      NullArgumentException - resourceId is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure
      Compliance:
      mandatory - This method must be implemented.

    • getMailboxes

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