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.
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. |
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
clearIdTerms, matchId
clearRecordTerms, matchAnyRecord, matchRecordType
getRecordTypes, hasRecordType
clearAnyTerms, clearKeywordTerms, getStringMatchTypes, matchAny, matchKeyword, supportsStringMatchType
void matchReturnDate(DateTime from, DateTime to, boolean match)
from
- the range startto
- the range endmatch
- true
for a positive match, false
for a negative matchInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
mandatory
- This method must be implemented. void clearReturnDateTerms()
mandatory
- This method must be implemented. void matchReturnerId(Id resourceId, boolean match)
Id
for this query.resourceId
- the resource Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- resourceId
is
null
mandatory
- This method must be implemented. void clearReturnerIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsReturnerQuery()
ResourceQuery
is available. true
if a resource query is available,
false
otherwisemandatory
- This method must be implemented. ResourceQuery getReturnerQuery()
OR
term.UnimplementedException
- supportsReturnerQuery()
is false
optional
- This method must be implemented if
supportsReturnerQuery()
is true.
void clearReturnerTerms()
mandatory
- This method must be implemented. void matchReturningAgentId(Id agentId, boolean match)
Id
for this query.agentId
- the agent Id
match
- true
for a positive match, false
for a negative matchNullArgumentException
- agentId
is
null
mandatory
- This method must be implemented. void clearReturningAgentIdTerms()
Id
query terms.mandatory
- This method must be implemented. boolean supportsReturningAgentQuery()
AgentQuery
is available. true
if an agent query is available,
false
otherwisemandatory
- This method must be implemented. AgentQuery getReturningAgentQuery()
OR
term.UnimplementedException
-
supportsReturningAgentQuery()
is false
optional
- This method must be implemented if
supportsReturningAgentQuery()
is true.
void clearReturningAgentTerms()
mandatory
- This method must be implemented. ProvisionReturnQueryRecord getProvisionReturnQueryRecord(Type provisionReturnRecordType) throws OperationFailedException
ProvisionReturn
record Type.
Multiple
record retrievals produce a nested OR
term.provisionReturnRecordType
- a provision return record typeNullArgumentException
-
provisionReturnRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(provisionReturnRecordType)
is
false
mandatory
- This method must be implemented.