org.osid.resourcing

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 Summary

Methods

Modifier and Type	Method and Description
void	clearCommissionIdTerms() Clears the commission Id query terms.
void	clearCommissionTerms() Clears the commission query terms.
void	clearFoundryIdTerms() Clears the foundry Id query terms.
void	clearFoundryTerms() Clears the foundry query terms.
void	clearResourceIdTerms() Clears the resource Id query terms.
void	clearResourceTerms() Clears the resource query terms.
void	clearTimeSpentTerms() Clears the time spent query terms.
CommissionQuery	getCommissionQuery() Gets the query for a commission.
EffortQueryRecord	getEffortQueryRecord(Type effortRecordType) Gets the effort query record corresponding to the given Effort record Type.
FoundryQuery	getFoundryQuery() Gets the query for a foundry.
ResourceQuery	getResourceQuery() Gets the query for a resource.
void	matchCommissionId(Id commissionId, boolean match) Sets the commission Id for this query.
void	matchFoundryId(Id foundryId, boolean match) Sets the foundry Id for this query to match efforts assigned to foundries.
void	matchResourceId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchTimeSpent(Duration start, Duration end, boolean match) Matches the time spent between the given durations inclusive.
boolean	supportsCommissionQuery() Tests if a CommissionQuery is available.
boolean	supportsFoundryQuery() Tests if a FoundryQuery is available.
boolean	supportsResourceQuery() Tests if a ResourceQuery is available.

Methods inherited from interface org.osid.OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Methods inherited from interface org.osid.OsidObjectQuery

clearCommentIdTerms, clearCommentTerms, clearCreditIdTerms, clearCreditTerms, clearDescriptionTerms, clearDisplayNameTerms, clearGenusTypeTerms, clearJournalEntryIdTerms, clearJournalEntryTerms, clearParentGenusTypeTerms, clearRelationshipIdTerms, clearRelationshipPeerIdTerms, clearRelationshipTerms, clearStateIdTerms, clearStateTerms, clearStatisticTerms, clearSubjectIdTerms, clearSubjectRelevancyTerms, clearSubjectTerms, getCommentQuery, getCreditQuery, getJournalEntryQuery, getRelationshipQuery, getStateQuery, getStatisticQuery, getSubjectQuery, getSubjectRelevancyQuery, matchAnyComment, matchAnyCredit, matchAnyDescription, matchAnyDisplayName, matchAnyGenusType, matchAnyJournalEntry, matchAnyRelationship, matchAnyState, matchAnyStatistic, matchAnySubject, matchCommentId, matchCreditId, matchDescription, matchDisplayName, matchGenusType, matchJournalEntryId, matchParentGenusType, matchRelationshipId, matchRelationshipPeerId, matchStateId, matchSubjectId, supportsCommentQuery, supportsCreditQuery, supportsJournalEntryQuery, supportsRelationshipQuery, supportsStateQuery, supportsStatisticQuery, supportsSubjectQuery, supportsSubjectRelevancyQuery

Methods inherited from interface org.osid.OsidIdentifiableQuery

clearIdTerms, matchId

Methods inherited from interface org.osid.OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Methods inherited from interface org.osid.OsidTemporalQuery

clearDateTerms, clearEffectiveTerms, clearEndDateTerms, clearStartDateTerms, matchAnyEndDate, matchAnyStartDate, matchDate, matchEffective, matchEndDate, matchStartDate

Method Detail

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 supportsResourceQuery() is 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 supportsCommissionQuery() is 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 supportsFoundryQuery() is 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.