Interface RequestQuery

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

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

  • Method Details

    • matchRequestTransactionId

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

    • clearRequestTransactionIdTerms

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

    • supportsRequestTransactionQuery

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

    • getRequestTransactionQuery

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

    • clearRequestTransactionTerms

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

    • matchQueueId

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

    • clearQueueIdTerms

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

    • supportsQueueQuery

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

    • getQueueQuery

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

    • clearQueueTerms

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

    • matchRequestDate

      void matchRequestDate(DateTime from, DateTime to, boolean match)
      Matches requests with a 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.

    • clearRequestDateTerms

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

    • matchRequesterId

      void matchRequesterId(Id resourceId, boolean match)
      Sets the resource 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.

    • clearRequesterIdTerms

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

    • supportsRequesterQuery

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

    • getRequesterQuery

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

    • clearRequesterTerms

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

    • matchRequestingAgentId

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

    • clearRequestingAgentIdTerms

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

    • supportsRequestingAgentQuery

      boolean supportsRequestingAgentQuery()
      Tests if an AgentQuery is available.
      Returns:
      true if an agent query is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getRequestingAgentQuery

      AgentQuery getRequestingAgentQuery()
      Gets the query for an agent. Multiple retrievals produce a nested OR term.
      Returns:
      the agent query
      Throws:
      UnimplementedException - supportsRequestingAgentQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRequestingAgentQuery()} is {@code true} .

    • clearRequestingAgentTerms

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

    • matchPoolId

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

    • clearPoolIdTerms

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

    • supportsPoolQuery

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

    • getPoolQuery

      PoolQuery getPoolQuery()
      Gets the query for a pool. Multiple retrievals produce a nested OR term.
      Returns:
      the pool query
      Throws:
      UnimplementedException - supportsPoolQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceQuery()} is {@code true} .

    • matchAnyPool

      void matchAnyPool(boolean match)
      Matches requests with any pool.
      Parameters:
      match - true to match requests with any poo, false to match requests with no pool
      Compliance:
      mandatory - This method must be implemented.

    • clearPoolTerms

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

    • matchRequestedProvisionableId

      void matchRequestedProvisionableId(Id provisionableId, boolean match)
      Sets the requested 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.

    • clearRequestedProvisionableIdTerms

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

    • supportsRequestedProvisionableQuery

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

    • getRequestedProvisionableQuery

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

    • matchAnyRequestedProvisionable

      void matchAnyRequestedProvisionable(boolean match)
      Matches requests with any requested provisionable.
      Parameters:
      match - true to match requests with any requested provisionable, false to match requests with no requested provisionables
      Compliance:
      mandatory - This method must be implemented.

    • clearRequestedProvisionableTerms

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

    • matchExchangeProvisionId

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

    • clearExchangeProvisionIdTerms

      void clearExchangeProvisionIdTerms()
      Clears the exchange provision Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsExchangeProvisionQuery

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

    • getExchangeProvisionQuery

      ProvisionQuery getExchangeProvisionQuery()
      Gets the query for an exchange provision. Multiple retrievals produce a nested OR term.
      Returns:
      the provision query
      Throws:
      UnimplementedException - supportsExchangeProvisionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsExchangeProvisionQuery()} is {@code true} .

    • matchAnyExchangeProvision

      void matchAnyExchangeProvision(boolean match)
      Matches requests with any exchange provision.
      Parameters:
      match - true to match requests with any exchange provision, false to match requests with no exchange provision
      Compliance:
      mandatory - This method must be implemented.

    • clearExchangeProvisionTerms

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

    • matchOriginProvisionId

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

    • clearOriginProvisionIdTerms

      void clearOriginProvisionIdTerms()
      Clears the origin provision Id query terms.
      Compliance:
      mandatory - This method must be implemented.

    • supportsOriginProvisionQuery

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

    • getOriginProvisionQuery

      ProvisionQuery getOriginProvisionQuery()
      Gets the query for an origin provision. Multiple retrievals produce a nested OR term.
      Returns:
      the provision query
      Throws:
      UnimplementedException - supportsOriginProvisionQuery() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOriginProvisionQuery()} is {@code true} .

    • matchAnyOriginProvision

      void matchAnyOriginProvision(boolean match)
      Matches requests with any originating provision.
      Parameters:
      match - true to match requests with any originating provision, false to match requests with no origininating provision
      Compliance:
      mandatory - This method must be implemented.

    • clearOriginProvisionTerms

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

    • matchPosition

      void matchPosition(long start, long end, boolean match)
      Matches requests whose position is in the given range inclusive,.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is greater than end
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyPosition

      void matchAnyPosition(boolean match)
      Matches requests with any position.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearPositionTerms

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

    • matchEWA

      void matchEWA(Duration start, Duration end, boolean match)
      Matches requests whose estimated waiting time is in the given range inclusive,.
      Parameters:
      start - start of range
      end - end of range
      match - true for a positive match, false for a negative match
      Throws:
      InvalidArgumentException - start is greater than end
      NullArgumentException - start or end is null
      Compliance:
      mandatory - This method must be implemented.

    • matchAnyEWA

      void matchAnyEWA(boolean match)
      Matches requests with any ewa.
      Parameters:
      match - true for a positive match, false for a negative match
      Compliance:
      mandatory - This method must be implemented.

    • clearEWATerms

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

    • matchDistributorId

      void matchDistributorId(Id distributorId, boolean match)
      Sets the distributor Id for this query.
      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 - supportDistributorQuery() 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.

    • getRequestQueryRecord

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