Interface OsidRequestQuery

All Superinterfaces:

Extensible, OsidBrowsableQuery, OsidExtensibleQuery, OsidIdentifiableQuery, OsidObjectQuery, OsidQuery, Suppliable

All Known Subinterfaces:

RegistrationRequestQuery

public interface OsidRequestQuery
extends OsidObjectQuery

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

Method Summary

Modifier and Type	Method	Description
void	clearCanceledTerms()	Clears the canceled query terms.
void	clearErrorIdTerms()	Clears all error state Id terms.
void	clearErrorTerms()	Clears all error terms.
void	clearPostingDateTerms()	Clears the posting date query terms.
void	clearProcessedDateTerms()	Clears the processed date query terms.
void	clearRequesterIdTerms()	Clears all requester Id terms.
void	clearRequesterTerms()	Clears all requsster terms.
void	clearSubmittedDateTerms()	Clears the submitted date query terms.
void	clearSubmittedTerms()	Clears the submitted query terms.
void	clearSubmitterIdTerms()	Clears all submitter Id terms.
void	clearSubmitterTerms()	Clears all submitter terms.
void	clearSubmittingAgentIdTerms()	Clears all submitting agent Id terms.
void	clearSubmittingAgentTerms()	Clears all submitting agent terms.
StateQuery	getErrorQuery(boolean match)	Gets the query for the state.
ResourceQuery	getRequesterQuery(boolean match)	Gets the query for the resource.
ResourceQuery	getSubmitterQuery(boolean match)	Gets the query for the resource.
AgentQuery	getSubmittingAgentQuery(boolean match)	Gets the query for the submitting agent.
void	matchAnyError(boolean match)	Match any error state.
void	matchAnyPostingDate(boolean match)	Matches requests with any posting date set.
void	matchAnyProcessedDate(boolean match)	Matches requests with any processed date set.
void	matchAnyRequester(boolean match)	Match any requester.
void	matchAnySubmittedDate(boolean match)	Matches requests with any submitted date set.
void	matchAnySubmitter(boolean match)	Match any submitter.
void	matchAnySubmittingAgent(boolean match)	Match any submitting agent.
void	matchCanceled(boolean match)	Matches canceled requests.
void	matchErrorId(Id stateId, boolean match)	Match the Id of the error state.
void	matchPostingDate(DateTime start, DateTime end, boolean match)	Matches requests whose posting date falls in between the given dates inclusive.
void	matchProcessedDate(DateTime start, DateTime end, boolean match)	Matches requests whose processed date falls in between the given dates inclusive.
void	matchRequesterId(Id resourceId, boolean match)	Match the Id of the requester.
void	matchSubmitted(boolean match)	Matches submitted requests.
void	matchSubmittedDate(DateTime start, DateTime end, boolean match)	Matches requests whose submitted date falls in between the given dates inclusive.
void	matchSubmitterId(Id resourceId, boolean match)	Match the Id of the submitter.
void	matchSubmittingAgentId(Id agentId, boolean match)	Match the Id of the submitting agent.
boolean	supportsErrorQuery()	Tests if a StateQuery for the submitter is available.
boolean	supportsRequesterQuery()	Tests if a ResourceQuery for the requester is available.
boolean	supportsSubmitterQuery()	Tests if a ResourceQuery for the submitter is available.
boolean	supportsSubmittingAgentQuery()	Tests if an AgentQuery for the submitter is available.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Methods inherited from interface OsidExtensibleQuery

clearRecordTerms, matchAnyRecord, matchRecordType

Modifier and Type	Method	Description
void	clearRecordTerms()	Clears all record Type terms.
void	matchAnyRecord(boolean match)	Matches an object that has any record.
void	matchRecordType(Type recordType, boolean match)	Sets a Type for querying objects having records implementing a given record type.

Methods inherited from interface OsidIdentifiableQuery

clearIdTerms, matchId

Modifier and Type	Method	Description
void	clearIdTerms()	Clears all Id terms.
void	matchId(Id id, boolean match)	Adds an Id to match.

Methods inherited from interface 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

Modifier and Type	Method	Description
void	clearCommentIdTerms()	Clears all comment Id terms.
void	clearCommentTerms()	Clears all comment terms.
void	clearCreditIdTerms()	Clears all credit Id terms.
void	clearCreditTerms()	Clears all credit terms.
void	clearDescriptionTerms()	Clears all description terms.
void	clearDisplayNameTerms()	Clears all display name terms.
void	clearGenusTypeTerms()	Clears all genus type terms.
void	clearJournalEntryIdTerms()	Clears all journal entry Id terms.
void	clearJournalEntryTerms()	Clears all journal entry terms.
void	clearParentGenusTypeTerms()	Clears all genus type terms.
void	clearRelationshipIdTerms()	Clears all relationship Id terms.
void	clearRelationshipPeerIdTerms()	Clears all relationship Id terms.
void	clearRelationshipTerms()	Clears all relationship terms.
void	clearStateIdTerms()	Clears all state Id terms.
void	clearStateTerms()	Clears all state terms.
void	clearStatisticTerms()	Clears all statistic terms.
void	clearSubjectIdTerms()	Clears all subject Id terms.
void	clearSubjectRelevancyTerms()	Clears all subject relevancy terms.
void	clearSubjectTerms()	Clears all subject terms.
CommentQuery	getCommentQuery()	Gets the query for a comment.
CreditQuery	getCreditQuery()	Gets the query for an ackowledgement credit.
JournalEntryQuery	getJournalEntryQuery()	Gets the query for a journal entry.
RelationshipQuery	getRelationshipQuery()	Gets the query for relationship.
StateQuery	getStateQuery()	Gets the query for a state.
StatisticQuery	getStatisticQuery()	Gets the query for a statistic.
SubjectQuery	getSubjectQuery()	Gets the query for a subject.
RelevancyQuery	getSubjectRelevancyQuery()	Gets the query for a subject relevancy.
void	matchAnyComment(boolean match)	Matches an object that has any Comment in the given Book .
void	matchAnyCredit(boolean match)	Matches an object that has any Credit .
void	matchAnyDescription(boolean match)	Matches a description that has any value.
void	matchAnyDisplayName(boolean match)	Matches any object with a display name.
void	matchAnyGenusType(boolean match)	Matches an object that has any genus type.
void	matchAnyJournalEntry(boolean match)	Matches an object that has any JournalEntry in the given Journal .
void	matchAnyRelationship(boolean match)	Matches an object that has any Relationship .
void	matchAnyState(boolean match)	Matches an object that has any mapping to a State in the given Process .
void	matchAnyStatistic(boolean match)	Matches an object that has any Statistic .
void	matchAnySubject(boolean match)	Matches an object that has any relationship to a Subject .
void	matchCommentId(Id commentId, boolean match)	Matches an object that has the given comment.
void	matchCreditId(Id creditId, boolean match)	Matches an object that has the given credit.
void	matchDescription(String description, Type stringMatchType, boolean match)	Adds a description name to match.
void	matchDisplayName(String displayName, Type stringMatchType, boolean match)	Adds a display name to match.
void	matchGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchJournalEntryId(Id journalEntryId, boolean match)	Matches an object that has the given journal entry.
void	matchParentGenusType(Type genusType, boolean match)	Sets a Type for querying objects of a given genus.
void	matchRelationshipId(Id relationshipId, boolean match)	Matches an object that has the given relationship.
void	matchRelationshipPeerId(Id peerId, boolean match)	Matches an object that has a relationship to the given peer Id .
void	matchStateId(Id stateId, boolean match)	Matches an object mapped to the given state.
void	matchSubjectId(Id subjectId, boolean match)	Matches an object with a relationship to the given subject.
boolean	supportsCommentQuery()	Tests if a CommentQuery is available.
boolean	supportsCreditQuery()	Tests if a CreditQuery is available to provide queries of related acknowledgements.
boolean	supportsJournalEntryQuery()	Tests if a JournalEntry is available to provide queries of journaled OsidObjects .
boolean	supportsRelationshipQuery()	Tests if a RelationshipQuery is available.
boolean	supportsStateQuery()	Tests if a StateQuery is available to provide queries of processed objects.
boolean	supportsStatisticQuery()	Tests if a StatisticQuery is available to provide statistical queries.
boolean	supportsSubjectQuery()	Tests if a SubjectQuery is available.
boolean	supportsSubjectRelevancyQuery()	Tests if a RelevancyQuery is available to provide queries about the relationships to Subjects .

Methods inherited from interface OsidQuery

clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType

Modifier and Type	Method	Description
void	clearAnyTerms()	Clears the match any terms.
void	clearKeywordTerms()	Clears all keyword terms.
TypeList	getStringMatchTypes()	Gets the string matching types supported.
void	matchAny(boolean match)	Matches any object.
void	matchKeyword(String keyword, Type stringMatchType, boolean match)	Adds a keyword to match.
boolean	supportsStringMatchType(Type stringMatchType)	Tests if the given string matching type is supported.

Method Details

matchPostingDate

void matchPostingDate(DateTime start,
 DateTime end,
 boolean match)

Matches requests whose posting date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyPostingDate

void matchAnyPostingDate(boolean match)

Matches requests with any posting date set.

Parameters:

match - true to match any posting date, false to match no posting date

Compliance:

mandatory - This method must be implemented.

clearPostingDateTerms

void clearPostingDateTerms()

Clears the posting date query terms.

Compliance:

mandatory - This method must be implemented.

matchRequesterId

void matchRequesterId(Id resourceId,
 boolean match)

Match the Id of the requester.

Parameters:

resourceId - Id to match

match - true if 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 all requester Id terms.

Compliance:

mandatory - This method must be implemented.

supportsRequesterQuery

boolean supportsRequesterQuery()

Tests if a ResourceQuery for the requester is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getRequesterQuery

ResourceQuery getRequesterQuery(boolean match)

Gets the query for the resource. Each retrieval performs a boolean OR .

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the resource query

Throws:

UnimplementedException - supportsRequesterQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsRequesterQuery()} is {@code true} .

matchAnyRequester

void matchAnyRequester(boolean match)

Match any requester.

Parameters:

match - true to match any requester, false to match no requesters

Compliance:

mandatory - This method must be implemented.

clearRequesterTerms

void clearRequesterTerms()

Clears all requsster terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitted

void matchSubmitted(boolean match)

Matches submitted requests.

Parameters:

match - true to match submitted requests, false to match unsubmitted requests

Compliance:

mandatory - This method must be implemented.

clearSubmittedTerms

void clearSubmittedTerms()

Clears the submitted query terms.

Compliance:

mandatory - This method must be implemented.

matchSubmittedDate

void matchSubmittedDate(DateTime start,
 DateTime end,
 boolean match)

Matches requests whose submitted date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnySubmittedDate

void matchAnySubmittedDate(boolean match)

Matches requests with any submitted date set.

Parameters:

match - true to match any submitted date, false to match no submitted date

Compliance:

mandatory - This method must be implemented.

clearSubmittedDateTerms

void clearSubmittedDateTerms()

Clears the submitted date query terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitterId

void matchSubmitterId(Id resourceId,
 boolean match)

Match the Id of the submitter.

Parameters:

resourceId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - resourceId is null

Compliance:

mandatory - This method must be implemented.

clearSubmitterIdTerms

void clearSubmitterIdTerms()

Clears all submitter Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmitterQuery

boolean supportsSubmitterQuery()

Tests if a ResourceQuery for the submitter is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmitterQuery

ResourceQuery getSubmitterQuery(boolean match)

Gets the query for the resource. Each retrieval performs a boolean OR .

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the resource query

Throws:

UnimplementedException - supportsSubmitterQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubmitterQuery()} is {@code true} .

matchAnySubmitter

void matchAnySubmitter(boolean match)

Match any submitter.

Parameters:

match - true to match any submitter, false to match no submitters

Compliance:

mandatory - This method must be implemented.

clearSubmitterTerms

void clearSubmitterTerms()

Clears all submitter terms.

Compliance:

mandatory - This method must be implemented.

matchSubmittingAgentId

void matchSubmittingAgentId(Id agentId,
 boolean match)

Match the Id of the submitting agent.

Parameters:

agentId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - agentId is null

Compliance:

mandatory - This method must be implemented.

clearSubmittingAgentIdTerms

void clearSubmittingAgentIdTerms()

Clears all submitting agent Id terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmittingAgentQuery

boolean supportsSubmittingAgentQuery()

Tests if an AgentQuery for the submitter is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentQuery

AgentQuery getSubmittingAgentQuery(boolean match)

Gets the query for the submitting agent. Each retrieval performs a boolean OR .

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the agent query

Throws:

UnimplementedException - supportsSubmittingAgentQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsSubmittingAgentQuery()} is {@code true} .

matchAnySubmittingAgent

void matchAnySubmittingAgent(boolean match)

Match any submitting agent.

Parameters:

match - true to match any submitting agent, false to match no submitting agents

Compliance:

mandatory - This method must be implemented.

clearSubmittingAgentTerms

void clearSubmittingAgentTerms()

Clears all submitting agent terms.

Compliance:

mandatory - This method must be implemented.

matchCanceled

void matchCanceled(boolean match)

Matches canceled requests.

Parameters:

match - true to match canceled requests, false to match not canceled requests

Compliance:

mandatory - This method must be implemented.

clearCanceledTerms

void clearCanceledTerms()

Clears the canceled query terms.

Compliance:

mandatory - This method must be implemented.

matchProcessedDate

void matchProcessedDate(DateTime start,
 DateTime end,
 boolean match)

Matches requests whose processed date falls in between the given dates inclusive.

Parameters:

start - start of date range

end - end of date range

match - true if a positive match, false for a negative match

Throws:

InvalidArgumentException - start is less than end

NullArgumentException - start or end is null

Compliance:

mandatory - This method must be implemented.

matchAnyProcessedDate

void matchAnyProcessedDate(boolean match)

Matches requests with any processed date set.

Parameters:

match - true to match any processed date, false to match no processed date

Compliance:

mandatory - This method must be implemented.

clearProcessedDateTerms

void clearProcessedDateTerms()

Clears the processed date query terms.

Compliance:

mandatory - This method must be implemented.

matchErrorId

void matchErrorId(Id stateId,
 boolean match)

Match the Id of the error state.

Parameters:

stateId - Id to match

match - true if for a positive match, false for a negative match

Throws:

NullArgumentException - stateId is null

Compliance:

mandatory - This method must be implemented.

clearErrorIdTerms

void clearErrorIdTerms()

Clears all error state Id terms.

Compliance:

mandatory - This method must be implemented.

supportsErrorQuery

boolean supportsErrorQuery()

Tests if a StateQuery for the submitter is available.

Returns:

true if a state query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getErrorQuery

StateQuery getErrorQuery(boolean match)

Gets the query for the state. Each retrieval performs a boolean OR .

Parameters:

match - true if for a positive match, false for a negative match

Returns:

the state query

Throws:

UnimplementedException - supportsErrorQuery() is false

Compliance:

optional - This method must be implemented if {@code supportsErrorQuery()} is {@code true} .

matchAnyError

void matchAnyError(boolean match)

Match any error state.

Parameters:

match - true to match any error, false to match no requests with no errors

Compliance:

mandatory - This method must be implemented.

clearErrorTerms

void clearErrorTerms()

Clears all error terms.

Compliance:

mandatory - This method must be implemented.