Interface ProvisionReturnQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSubjugateableQueryInspector

public interface ProvisionReturnQueryInspector
extends OsidObjectQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining provision return queries.

Method Summary

Modifier and Type	Method	Description
ProvisionReturnQueryInspectorRecord	getProvisionReturnQueryInspectorRecord(Type provisionReturnRecordType)	Gets the provision return query inspector record corresponding to the given ProvisionReturn record Type .
DateTimeRangeTerm[]	getReturnDateTerms()	Gets the return date query terms.
IdTerm[]	getReturnerIdTerms()	Gets the returner Id query terms.
ResourceQueryInspector[]	getReturnerTerms()	Gets the returner query terms.
IdTerm[]	getReturningAgentIdTerms()	Gets the agent Id query terms.
AgentQueryInspector[]	getReturningAgentTerms()	Gets the agent query terms.

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 OsidExtensibleQueryInspector

getRecordTypeTerms

Modifier and Type	Method	Description
TypeTerm[]	getRecordTypeTerms()	Gets the record type query terms.

Methods inherited from interface OsidIdentifiableQueryInspector

getIdTerms

Modifier and Type	Method	Description
IdTerm[]	getIdTerms()	Gets the Id query terms.

Methods inherited from interface OsidObjectQueryInspector

getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms

Modifier and Type	Method	Description
IdTerm[]	getCommentIdTerms()	Gets the comment Id query terms.
CommentQueryInspector[]	getCommentTerms()	Gets the comment query terms.
IdTerm[]	getCreditIdTerms()	Gets the credit Id query terms.
CreditQueryInspector[]	getCreditTerms()	Gets the credit query terms.
StringTerm[]	getDescriptionTerms()	Gets the description query terms.
StringTerm[]	getDisplayNameTerms()	Gets the display name query terms.
TypeTerm[]	getGenusTypeTerms()	Gets the genus type query terms.
IdTerm[]	getJournalEntryIdTerms()	Gets the journal entry Id query terms.
JournalEntryQueryInspector[]	getJournalEntryTerms()	Gets the journal entry query terms.
TypeTerm[]	getParentGenusTypeTerms()	Gets the parent genus type query terms.
IdTerm[]	getRelationshipIdTerms()	Gets the relationship Id query terms.
IdTerm[]	getRelationshipPeerIdTerms()	Gets the relationship peer Id query terms.
RelationshipQueryInspector[]	getRelationshipTerms()	Gets the relationship query terms.
IdTerm[]	getStateIdTerms()	Gets the state Id query terms.
StateQueryInspector[]	getStateTerms()	Gets the state query terms.
StatisticQueryInspector[]	getStatisticTerms()	Gets the statistic query terms.
IdTerm[]	getSubjectIdTerms()	Gets the subject Id query terms.
RelevancyQueryInspector[]	getSubjectRelevancyTerms()	Gets the subject relevancy query terms.
SubjectQueryInspector[]	getSubjectTerms()	Gets the subject query terms.

Methods inherited from interface OsidQueryInspector

getAnyTerms, getKeywordTerms

Modifier and Type	Method	Description
BooleanTerm[]	getAnyTerms()	Gets the any query terms.
StringTerm[]	getKeywordTerms()	Gets the keyword query terms.

Method Details

getReturnDateTerms

DateTimeRangeTerm[] getReturnDateTerms()

Gets the return date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReturnerIdTerms

IdTerm[] getReturnerIdTerms()

Gets the returner Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReturnerTerms

ResourceQueryInspector[] getReturnerTerms()

Gets the returner query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReturningAgentIdTerms

IdTerm[] getReturningAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getReturningAgentTerms

AgentQueryInspector[] getReturningAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProvisionReturnQueryInspectorRecord

ProvisionReturnQueryInspectorRecord getProvisionReturnQueryInspectorRecord(Type provisionReturnRecordType)
                                                                    throws OperationFailedException

Gets the provision return query inspector record corresponding to the given ProvisionReturn record Type .

Parameters:

provisionReturnRecordType - a provision return record type

Returns:

the provision return query inspector record

Throws:

NullArgumentException - provisionReturnRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionReturnRecordType) is false

Compliance:

mandatory - This method must be implemented.