org.osid.provisioning

Interface RequestTransactionQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface RequestTransactionQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining request transaction queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getBrokerIdTerms() Gets the broker Id query terms.
BrokerQueryInspector[]	getBrokerTerms() Gets the broker query terms.
IdTerm[]	getRequestIdTerms() Gets the request Id query terms.
RequestQueryInspector[]	getRequestTerms() Gets the request query terms.
RequestTransactionQueryInspectorRecord	getRequestTransactionQueryInspectorRecord(Type requestTransactionRecordType) Gets the request transaction query inspector record corresponding to the given RequestTransaction record Type.
DateTimeRangeTerm[]	getSubmitDateTerms() Gets the submit date query terms.
IdTerm[]	getSubmitterIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getSubmitterTerms() Gets the resource query terms.
IdTerm[]	getSubmittingAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getSubmittingAgentTerms() Gets the agent query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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

Methods inherited from interface org.osid.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

getBrokerIdTerms

IdTerm[] getBrokerIdTerms()

Gets the broker Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getBrokerTerms

BrokerQueryInspector[] getBrokerTerms()

Gets the broker query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubmitDateTerms

DateTimeRangeTerm[] getSubmitDateTerms()

Gets the submit date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubmitterIdTerms

IdTerm[] getSubmitterIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubmitterTerms

ResourceQueryInspector[] getSubmitterTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentIdTerms

IdTerm[] getSubmittingAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getSubmittingAgentTerms

AgentQueryInspector[] getSubmittingAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestIdTerms

IdTerm[] getRequestIdTerms()

Gets the request Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestTerms

RequestQueryInspector[] getRequestTerms()

Gets the request query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestTransactionQueryInspectorRecord

RequestTransactionQueryInspectorRecord getRequestTransactionQueryInspectorRecord(Type requestTransactionRecordType)
                                                                                 throws OperationFailedException

Gets the request transaction query inspector record corresponding to the given RequestTransaction record Type.

Parameters:

requestTransactionRecordType - a request transaction record type

Returns:

the request transaction query inspector record

Throws:

NullArgumentException - requestTransactionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestTransactionRecordType) is false

Compliance:

mandatory - This method must be implemented.