Interface EffortQuery

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

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

  • Method Details

    • matchResourceId

      void matchResourceId(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.

    • clearResourceIdTerms

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

    • supportsResourceQuery

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

    • getResourceQuery

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

    • clearResourceTerms

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

    • matchCommissionId

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

    • clearCommissionIdTerms

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

    • supportsCommissionQuery

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

    • getCommissionQuery

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

    • clearCommissionTerms

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

    • matchTimeSpent

      void matchTimeSpent(Duration start, Duration end, boolean match)
      Matches the time spent between the given durations inclusive.
      Parameters:
      start - start range
      end - end 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.

    • clearTimeSpentTerms

      void clearTimeSpentTerms()
      Clears the time spent query terms.
      Compliance:
      mandatory - This method must be implemented.

    • matchFoundryId

      void matchFoundryId(Id foundryId, boolean match)
      Sets the foundry Id for this query to match efforts assigned to foundries.
      Parameters:
      foundryId - the foundry Id
      match - true for a positive match, false for a negative match
      Throws:
      NullArgumentException - foundryId is null
      Compliance:
      mandatory - This method must be implemented.

    • clearFoundryIdTerms

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

    • supportsFoundryQuery

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

    • getFoundryQuery

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

    • clearFoundryTerms

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

    • getEffortQueryRecord

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