Interface MailboxQueryInspector

All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector
public interface MailboxQueryInspector extends OsidCatalogQueryInspector

This is the query inspector for examining mailbox queries.

  • Method Details

    • getMessageIdTerms

      IdTerm[] getMessageIdTerms()
      Gets the message Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMessageTerms

      MessageQueryInspector[] getMessageTerms()
      Gets the message query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorMailboxIdTerms

      IdTerm[] getAncestorMailboxIdTerms()
      Gets the ancestor mailbox Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getAncestorMailboxTerms

      MailboxQueryInspector[] getAncestorMailboxTerms()
      Gets the ancestor mailbox query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantMailboxIdTerms

      IdTerm[] getDescendantMailboxIdTerms()
      Gets the descendant mailbox Id query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getDescendantMailboxTerms

      MailboxQueryInspector[] getDescendantMailboxTerms()
      Gets the descendant mailbox query terms.
      Returns:
      the query terms
      Compliance:
      mandatory - This method must be implemented.

    • getMailboxQueryInspectorRecord

      MailboxQueryInspectorRecord getMailboxQueryInspectorRecord(Type mailboxRecordType) throws OperationFailedException
      Gets the mailbox query inspector record corresponding to the given Mailbox record Type .
      Parameters:
      mailboxRecordType - a mailbox record type
      Returns:
      the mailbox query inspector record
      Throws:
      NullArgumentException - mailboxRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(mailboxRecordType) is false
      Compliance:
      mandatory - This method must be implemented.