org.osid.provisioning

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

Methods

Modifier and Type	Method and 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 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

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 supportsBrokerQuery() is 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 supportsSubmitterQuery() is 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 supportsSubmittingAgentQuery() is 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 supportsRequestQuery() is 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.