Interface DispatchQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidGovernatorQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidOperableQuery, OsidQuery, OsidSourceableQuery, Suppliable
public interface DispatchQuery extends OsidGovernatorQuery

This is the query for searching for dispatches. Each method specifies an AND term while multiple invocations of the same method produce a nested OR .

  • Method Details

    • matchEditorId

      void matchEditorId(Id editorId, boolean match)
      Sets a editor Id for this query.
      Parameters:
      editorId - a editor Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - editorId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearEditorIdTerms

      void clearEditorIdTerms()
      Clears the editor Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsEditorQuery

      boolean supportsEditorQuery()
      Tests if a ResourceQuery is available.
      Returns:
      true if a editor query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getEditorQuery

      ResourceQuery getEditorQuery()
      Gets the query for a editor. Multiple retrievals produce a nested OR term.
      Returns:
      the editor query
      Throws:
      UnimplementedException - supportsEditorQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEditorQuery()} is {@code true} .

    • matchAnyEditor

      void matchAnyEditor(boolean match)
      Matches objects with any editor.
      Parameters:
      match - true to match objects with any editor, false to match objects with no editor
      Compliance:
      mandatory - This method must be implemented.

    • clearEditorTerms

      void clearEditorTerms()
      Clears the editor query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchAddressGenusType

      void matchAddressGenusType(Type addressGenusType, boolean match)
      Matches an address genus Type accepted by a dispatch.
      Parameters:
      addressGenusType - an address genus Type
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - addressGenusType is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyAddressGenusType

      void matchAnyAddressGenusType(boolean match)
      Matches dispatches with any address genus type.
      Parameters:
      match - true to match dispatches with any addres sgenus type, false to match dispatches with no address genus types
      Compliance:
      mandatory - This method must be implemented.

    • clearAddressGenusTypeTerms

      void clearAddressGenusTypeTerms()
      Clears the address genus Type terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchSubscriptionId

      void matchSubscriptionId(Id subscriptionId, boolean match)
      Sets the subscription Id for this query to match subscriptions assigned to dispatches.
      Parameters:
      subscriptionId - a subscription Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - subscriptionId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearSubscriptionIdTerms

      void clearSubscriptionIdTerms()
      Clears the subscription Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsSubscriptionQuery

      boolean supportsSubscriptionQuery()
      Tests if a subscription query is available.
      Returns:
      true if a subscription query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSubscriptionQuery

      SubscriptionQuery getSubscriptionQuery()
      Gets the query for a dispatch.
      Returns:
      the subscription query
      Throws:
      UnimplementedException - supportsSubscriptionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsSubscriptionQuery()} is {@code true} .

    • matchAnySubscription

      void matchAnySubscription(boolean match)
      Matches dispatches with any subscription.
      Parameters:
      match - true to match dispatches with any subscription, false to match dispatches with no subscriptions
      Compliance:
      mandatory - This method must be implemented.

    • clearSubscriptionTerms

      void clearSubscriptionTerms()
      Clears the subscription terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchPublisherId

      void matchPublisherId(Id publisherId, boolean match)
      Sets the dispatch Id for this query to match subscriptions assigned to publishers.
      Parameters:
      publisherId - a publisher Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - publisherId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearPublisherIdTerms

      void clearPublisherIdTerms()
      Clears the publisher Id terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsPublisherQuery

      boolean supportsPublisherQuery()
      Tests if a PublisherQuery is available.
      Returns:
      true if a publisher query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getPublisherQuery

      PublisherQuery getPublisherQuery()
      Gets the query for a publisher query. Multiple retrievals produce a nested OR term.
      Returns:
      the publisher query
      Throws:
      UnimplementedException - supportsPublisherQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPublisherQuery()} is {@code true} .

    • clearPublisherTerms

      void clearPublisherTerms()
      Clears the publisher terms.
      Compliance:
      mandatory - This method must be implemented.

    • getDispatchQueryRecord

      DispatchQueryRecord getDispatchQueryRecord(Type dispatchRecordType) throws OperationFailedException
      Gets the dispatch query record corresponding to the given Dispatch record Type .Multiple record retrievals produce a nested boolean OR term.
      Parameters:
      dispatchRecordType - a dispatch record type
      Returns:
      the dispatch query record
      Throws:
      NullArgumentException - dispatchRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(dispatchRecordType) is false
      Compliance:
      mandatory - This method must be implemented.