org.osid.provisioning

Interface RequestQueryInspector

All Superinterfaces:

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

public interface RequestQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining request queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
DurationRangeTerm[]	getEWATerms() Gets the ewa query terms.
IdTerm[]	getExchangeProvisionIdTerms() Gets the exchange provision Id query terms.
ProvisionQueryInspector[]	getExchangeProvisionTerms() Gets the exchange provision query terms.
IdTerm[]	getOriginProvisionIdTerms() Gets the origin provision Id query terms.
ProvisionQueryInspector[]	getOriginProvisionTerms() Gets the origin provision query terms.
IdTerm[]	getPoolIdTerms() Gets the pool Id query terms.
PoolQueryInspector[]	getPoolTerms() Gets the pool query terms.
IntegerRangeTerm[]	getPositionTerms() Gets the position query terms.
IdTerm[]	getQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getQueueTerms() Gets the queue query terms.
DateTimeRangeTerm[]	getRequestDateTerms() Gets the request date query terms.
IdTerm[]	getRequestedProvisionableIdTerms() Gets the requested provisionable Id query terms.
ProvisionableQueryInspector[]	getRequestedProvisionableTerms() Gets the requested provisionable query terms.
IdTerm[]	getRequesterIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getRequesterTerms() Gets the resource query terms.
IdTerm[]	getRequestingAgentIdTerms() Gets the agent Id query terms.
AgentQueryInspector[]	getRequestingAgentTerms() Gets the agent query terms.
RequestQueryInspectorRecord	getRequestQueryInspectorRecord(Type requestRecordType) Gets the request query inspector record corresponding to the given Request record Type.
IdTerm[]	getRequestTransactionIdTerms() Gets the request transaction Id query terms.
RequestTransactionQueryInspector[]	getRequestTransactionTerms() Gets the request transaction 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

getRequestTransactionIdTerms

IdTerm[] getRequestTransactionIdTerms()

Gets the request transaction Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestTransactionTerms

RequestTransactionQueryInspector[] getRequestTransactionTerms()

Gets the request transaction query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQueueIdTerms

IdTerm[] getQueueIdTerms()

Gets the queue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQueueTerms

QueueQueryInspector[] getQueueTerms()

Gets the queue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestDateTerms

DateTimeRangeTerm[] getRequestDateTerms()

Gets the request date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequesterIdTerms

IdTerm[] getRequesterIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequesterTerms

ResourceQueryInspector[] getRequesterTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestingAgentIdTerms

IdTerm[] getRequestingAgentIdTerms()

Gets the agent Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestingAgentTerms

AgentQueryInspector[] getRequestingAgentTerms()

Gets the agent query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPoolIdTerms

IdTerm[] getPoolIdTerms()

Gets the pool Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPoolTerms

PoolQueryInspector[] getPoolTerms()

Gets the pool query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestedProvisionableIdTerms

IdTerm[] getRequestedProvisionableIdTerms()

Gets the requested provisionable Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestedProvisionableTerms

ProvisionableQueryInspector[] getRequestedProvisionableTerms()

Gets the requested provisionable query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExchangeProvisionIdTerms

IdTerm[] getExchangeProvisionIdTerms()

Gets the exchange provision Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getExchangeProvisionTerms

ProvisionQueryInspector[] getExchangeProvisionTerms()

Gets the exchange provision query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOriginProvisionIdTerms

IdTerm[] getOriginProvisionIdTerms()

Gets the origin provision Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getOriginProvisionTerms

ProvisionQueryInspector[] getOriginProvisionTerms()

Gets the origin provision query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPositionTerms

IntegerRangeTerm[] getPositionTerms()

Gets the position query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getEWATerms

DurationRangeTerm[] getEWATerms()

Gets the ewa query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDistributorIdTerms

IdTerm[] getDistributorIdTerms()

Gets the distributor Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDistributorTerms

DistributorQueryInspector[] getDistributorTerms()

Gets the distributor query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestQueryInspectorRecord

RequestQueryInspectorRecord getRequestQueryInspectorRecord(Type requestRecordType)
                                                           throws OperationFailedException

Gets the request query inspector record corresponding to the given Request record Type.

Parameters:

requestRecordType - a request record type

Returns:

the request query inspector record

Throws:

NullArgumentException - requestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestRecordType) is false

Compliance:

mandatory - This method must be implemented.