org.osid.provisioning

Interface ProvisionReturnQuery

All Superinterfaces:

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

public interface ProvisionReturnQuery
extends OsidObjectQuery, OsidSubjugateableQuery

This is the query for searching provision returns. 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	clearReturnDateTerms() Clears the return date query terms.
void	clearReturnerIdTerms() Clears the resource Id query terms.
void	clearReturnerTerms() Clears the resource query terms.
void	clearReturningAgentIdTerms() Clears the agent Id query terms.
void	clearReturningAgentTerms() Clears the agent query terms.
ProvisionReturnQueryRecord	getProvisionReturnQueryRecord(Type provisionReturnRecordType) Gets the provision return query record corresponding to the given ProvisionReturn record Type.
ResourceQuery	getReturnerQuery() Gets the query for a resource.
AgentQuery	getReturningAgentQuery() Gets the query for an agent.
void	matchReturnDate(DateTime from, DateTime to, boolean match) Matches provisions with a return date in the given range inclusive.
void	matchReturnerId(Id resourceId, boolean match) Sets the resource Id for this query.
void	matchReturningAgentId(Id agentId, boolean match) Sets the agent Id for this query.
boolean	supportsReturnerQuery() Tests if a ResourceQuery is available.
boolean	supportsReturningAgentQuery() Tests if an AgentQuery is available.

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

Method Detail

matchReturnDate

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

Matches provisions with a return 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.

clearReturnDateTerms

void clearReturnDateTerms()

Clears the return date query terms.

Compliance:

mandatory - This method must be implemented.

matchReturnerId

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

clearReturnerIdTerms

void clearReturnerIdTerms()

Clears the resource Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsReturnerQuery

boolean supportsReturnerQuery()

Tests if a ResourceQuery is available.

Returns:

true if a resource query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReturnerQuery

ResourceQuery getReturnerQuery()

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

Returns:

the resource query

Throws:

UnimplementedException - supportsReturnerQuery() is false

Compliance:

optional - This method must be implemented if supportsReturnerQuery() is true.

clearReturnerTerms

void clearReturnerTerms()

Clears the resource query terms.

Compliance:

mandatory - This method must be implemented.

matchReturningAgentId

void matchReturningAgentId(Id agentId,
                         boolean match)

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

clearReturningAgentIdTerms

void clearReturningAgentIdTerms()

Clears the agent Id query terms.

Compliance:

mandatory - This method must be implemented.

supportsReturningAgentQuery

boolean supportsReturningAgentQuery()

Tests if an AgentQuery is available.

Returns:

true if an agent query is available, false otherwise

Compliance:

mandatory - This method must be implemented.

getReturningAgentQuery

AgentQuery getReturningAgentQuery()

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

Returns:

the agent query

Throws:

UnimplementedException - supportsReturningAgentQuery() is false

Compliance:

optional - This method must be implemented if supportsReturningAgentQuery() is true.

clearReturningAgentTerms

void clearReturningAgentTerms()

Clears the agent query terms.

Compliance:

mandatory - This method must be implemented.

getProvisionReturnQueryRecord

ProvisionReturnQueryRecord getProvisionReturnQueryRecord(Type provisionReturnRecordType)
                                                         throws OperationFailedException

Gets the provision return query record corresponding to the given ProvisionReturn record Type. Multiple record retrievals produce a nested OR term.

Parameters:

provisionReturnRecordType - a provision return record type

Returns:

the provision return query record

Throws:

NullArgumentException - provisionReturnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionReturnRecordType) is false

Compliance:

mandatory - This method must be implemented.