Interface RequestTransactionQuery

All Superinterfaces:

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

public interface RequestTransactionQuery
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 Summary

Modifier and Type	Method	Description
void	clearBrokerIdTerms()	Clears the broker Id query terms.
void	clearBrokerTerms()	Clears the broker query terms.
void	clearRequestIdTerms()	Clears the request Id query terms.
void	clearRequestTerms()	Clears the request query terms.
void	clearSubmitDateTerms()	Clears the submit date query terms.
void	clearSubmitterIdTerms()	Clears the submitter Id query terms.
void	clearSubmitterTerms()	Clears the submitter query terms.
void	clearSubmittingAgentIdTerms()	Clears the submitting agent Id query terms.
void	clearSubmittingAgentTerms()	Clears the submitting agent query terms.
BrokerQuery	getBrokerQuery()	Gets the query for a broker.
RequestQuery	getRequestQuery()	Gets the query for a request.
RequestTransactionQueryRecord	getRequestTransactionQueryRecord(Type requesttransactionRecordType)	Gets the request transaction query record corresponding to the given Requesttrsnaction record Type .
ResourceQuery	getSubmitterQuery()	Gets the query for a submitter.
AgentQuery	getSubmittingAgentQuery()	Gets the query for a submitting agent.
void	matchAnyRequest(boolean match)	Matches transactions with any request.
void	matchBrokerId(Id brokerId, boolean match)	Sets the broker Id for this query.
void	matchRequestId(Id requestId, boolean match)	Sets the request Id for this query.
void	matchSubmitDate(DateTime from, DateTime to, boolean match)	Matches transactions with a submit date in the given range inclusive.
void	matchSubmitterId(Id resourceId, boolean match)	Sets the submitter Id for this query.
void	matchSubmittingAgentId(Id agentId, boolean match)	Sets the submitting agent Id for this query.
boolean	supportsBrokerQuery()	Tests if a BrokerQuery is available.
boolean	supportsRequestQuery()	Tests if a RequestQuery is available.
boolean	supportsSubmitterQuery()	Tests if a ResourceQuery is available.
boolean	supportsSubmittingAgentQuery()	Tests if an AgentQuery 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.

Methods inherited from interface OsidRelationshipQuery

clearEndReasonIdTerms, clearEndReasonTerms, getEndReasonQuery, matchAnyEndReason, matchEndReasonId, supportsEndReasonQuery

Modifier and Type	Method	Description
void	clearEndReasonIdTerms()	Clears all state Id terms.
void	clearEndReasonTerms()	Clears all end reason state terms.
StateQuery	getEndReasonQuery(boolean match)	Gets the query for the end reason state.
void	matchAnyEndReason(boolean match)	Match any end reason state.
void	matchEndReasonId(Id stateId, boolean match)	Match the Id of the end reason state.
boolean	supportsEndReasonQuery()	Tests if a StateQuery for the end reason is available.

Methods inherited from interface OsidTemporalQuery

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

Modifier and Type	Method	Description
void	clearDateTerms()	Clears the date query terms.
void	clearEffectiveTerms()	Clears the effective query terms.
void	clearEndDateTerms()	Clears the end date query terms.
void	clearStartDateTerms()	Clears the start date query terms.
void	matchAnyEndDate(boolean match)	Matches temporals with any end date set.
void	matchAnyStartDate(boolean match)	Matches temporals with any start date set.
void	matchDate(DateTime from, DateTime to, boolean match)	Matches temporals where the given date range falls entirely between the start and end dates inclusive.
void	matchEffective(boolean match)	Match effective objects where the current date falls within the start and end dates inclusive.
void	matchEndDate(DateTime start, DateTime end, boolean match)	Matches temporals whose effective end date falls in between the given dates inclusive.
void	matchStartDate(DateTime start, DateTime end, boolean match)	Matches temporals whose start date falls in between the given dates inclusive.

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 supportsBrokerQuery()} is {@code true} .

clearBrokerTerms

void clearBrokerTerms()

Clears the broker query terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitDate

void matchSubmitDate(DateTime from,
 DateTime to,
 boolean match)

Matches transactions with a submit 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.

clearSubmitDateTerms

void clearSubmitDateTerms()

Clears the submit date query terms.

Compliance:

mandatory - This method must be implemented.

matchSubmitterId

void matchSubmitterId(Id resourceId,
 boolean match)

Sets the submitter 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.

clearSubmitterIdTerms

void clearSubmitterIdTerms()

Clears the submitter Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmitterQuery

boolean supportsSubmitterQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmitterQuery

ResourceQuery getSubmitterQuery()

Gets the query for a submitter. Multiple retrievals produce a nested OR term.

Returns:

the resource query

Throws:

UnimplementedException - supportsSubmitterQuery() is false

Compliance:

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

clearSubmitterTerms

void clearSubmitterTerms()

Clears the submitter query terms.

Compliance:

mandatory - This method must be implemented.

matchSubmittingAgentId

void matchSubmittingAgentId(Id agentId,
 boolean match)

Sets the submitting 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.

clearSubmittingAgentIdTerms

void clearSubmittingAgentIdTerms()

Clears the submitting agent Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsSubmittingAgentQuery

boolean supportsSubmittingAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentQuery

AgentQuery getSubmittingAgentQuery()

Gets the query for a submitting agent. Multiple retrievals produce a nested OR term.

Returns:

the agent query

Throws:

UnimplementedException - supportsSubmittingAgentQuery() is false

Compliance:

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

clearSubmittingAgentTerms

void clearSubmittingAgentTerms()

Clears the submitting agent 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 transactions with any request.

Parameters:

match - true for to match transactions with any request, match, false to match transaction 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.

getRequestTransactionQueryRecord

RequestTransactionQueryRecord getRequestTransactionQueryRecord(Type requesttransactionRecordType)
                                                        throws OperationFailedException

Gets the request transaction query record corresponding to the given Requesttrsnaction record Type . Multiple record retrievals produce a nested OR term.

Parameters:

requesttransactionRecordType - a request transaction record type

Returns:

the request transaction query record

Throws:

NullArgumentException - requestTransactionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionRecordType) is false

Compliance:

mandatory - This method must be implemented.