org.osid.provisioning

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

Methods

Modifier and Type	Method and 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 org.osid.OsidObjectQueryInspector

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

Methods inherited from interface org.osid.OsidIdentifiableQueryInspector

getIdTerms

Methods inherited from interface org.osid.OsidExtensibleQueryInspector

getRecordTypeTerms

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidQueryInspector

getAnyTerms, getKeywordTerms

Method Detail

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.