Interface ProvisionQuery

All Superinterfaces:
Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, OsidRelationshipQuery, OsidTemporalQuery, Suppliable
public interface ProvisionQuery extends OsidRelationshipQuery

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

  • Method Details

    • matchBrokerId

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

    • clearBrokerIdTerms

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

    • supportsBrokerQuery

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

    • getBrokerQuery

      BrokerQuery getBrokerQuery()
      Gets the query for a Broker . Multiple retrievals produce a nested OR term.
      Returns:
      the broker query
      Throws:
      UnimplementedException - supportsBrokerQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportBrokerQuery()} is {@code true} .

    • clearBrokerTerms

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

    • matchProvisionableId

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

    • clearProvisionableIdTerms

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

    • supportsProvisionableQuery

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

    • getProvisionableQuery

      ProvisionableQuery getProvisionableQuery()
      Gets the query for a Provisionable . Multiple retrievals produce a nested OR term.
      Returns:
      the provisionable query
      Throws:
      UnimplementedException - supportsProvisionableQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionableQuery()} is {@code true} .

    • clearProvisionableTerms

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

    • matchRecipientId

      void matchRecipientId(Id resourceId, boolean match)
      Sets the recipient Id for this query.
      Parameters:
      resourceId - the resource Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - resourceId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearRecipientIdTerms

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

    • supportsRecipientQuery

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

    • getRecipientQuery

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

    • clearRecipientTerms

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

    • matchRequestId

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

    • clearRequestIdTerms

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

    • supportsRequestQuery

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

    • getRequestQuery

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

    • matchAnyRequest

      void matchAnyRequest(boolean match)
      Matches provisions with any request.
      Parameters:
      match - true to match provisions with a request, false to match provisions with no requests
      Compliance:
      mandatory - This method must be implemented.

    • clearRequestTerms

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

    • matchProvisionDate

      void matchProvisionDate(DateTime from, DateTime to, boolean match)
      Matches provisions with a provision date in the given range inclusive.
      Parameters:
      from - the range start
      to - the range end
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • clearProvisionDateTerms

      void clearProvisionDateTerms()
      Clears the provision date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchLeased

      void matchLeased(boolean match)
      Matches provisions that are leases.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearLeasedTerms

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

    • matchMustReturn

      void matchMustReturn(boolean match)
      Matches provisions that must be returned.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearMustReturnTerms

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

    • matchDueDate

      void matchDueDate(DateTime from, DateTime to, boolean match)
      Matches leased provisions with a due date within the given range inclusive.
      Parameters:
      from - the range start
      to - the range end
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyDueDate

      void matchAnyDueDate(boolean match)
      Matches provisions with any due date.
      Parameters:
      match - true to match provisions with a due date, false to match provisions with no due date
      Compliance:
      mandatory - This method must be implemented.

    • clearDueDateTerms

      void clearDueDateTerms()
      Clears the due date query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchCost

      void matchCost(Currency from, Currency to, boolean match)
      Matches leased provisions with a cost within the given range inclusive.
      Parameters:
      from - the range start
      to - the range end
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyCost

      void matchAnyCost(boolean match)
      Matches provisions with any cost.
      Parameters:
      match - true to match provisions with a cost, false to match provisions with no cost
      Compliance:
      mandatory - This method must be implemented.

    • clearCostTerms

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

    • matchRateAmount

      void matchRateAmount(Currency from, Currency to, boolean match)
      Matches leased provisions with a rate amount within the given range inclusive.
      Parameters:
      from - the range start
      to - the range end
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyRateAmount

      void matchAnyRateAmount(boolean match)
      Matches provisions with any rate amount.
      Parameters:
      match - true to match provisions with a rate, false to match provisions with no rate
      Compliance:
      mandatory - This method must be implemented.

    • clearRateAmountTerms

      void clearRateAmountTerms()
      Clears the rate amount query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchRatePeriod

      void matchRatePeriod(Duration from, Duration to, boolean match)
      Matches leased provisions with a rate period within the given range inclusive.
      Parameters:
      from - the range start
      to - the range end
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - from is greater than to
      NullArgumentException - from or to is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyRatePeriod

      void matchAnyRatePeriod(boolean match)
      Matches provisions with any rate period.
      Parameters:
      match - true to match provisions with a rate period, false to match provisions with no rate period
      Compliance:
      mandatory - This method must be implemented.

    • clearRatePeriodTerms

      void clearRatePeriodTerms()
      Clears the rate period query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsProvisionReturnQuery

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

    • getProvisionReturnQuery

      ProvisionReturnQuery getProvisionReturnQuery()
      Gets the query for a provision return. Multiple retrievals produce a nested OR term.
      Returns:
      the provision return query
      Throws:
      UnimplementedException - supportsProvisionReturnQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsProvisionReturnQuery()} is {@code true} .

    • matchAnyProvisionReturn

      void matchAnyProvisionReturn(boolean match)
      Matches provisions with any provision return.
      Parameters:
      match - true to match provisions with a provision return, false to match provisions with no provision return
      Compliance:
      mandatory - This method must be implemented.

    • clearProvisionReturnTerms

      void clearProvisionReturnTerms()
      Clears the provision return query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchDistributorId

      void matchDistributorId(Id distributorId, boolean match)
      Sets the distributor Id for this query to match provisions assigned to distributors.
      Parameters:
      distributorId - the distributor Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - distributorId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearDistributorIdTerms

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

    • supportsDistributorQuery

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

    • getDistributorQuery

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

    • clearDistributorTerms

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

    • getProvisionQueryRecord

      ProvisionQueryRecord getProvisionQueryRecord(Type provisionRecordType) throws OperationFailedException
      Gets the provision query record corresponding to the given Provision record Type . Multiple record retrievals produce a nested OR term.
      Parameters:
      provisionRecordType - a provision record type
      Returns:
      the provision query record
      Throws:
      NullArgumentException - provisionRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(provisionRecordType) is false
      Compliance:
      mandatory - This method must be implemented.