org.osid.provisioning

Interface ProvisionQueryInspector

All Superinterfaces:

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

public interface ProvisionQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining provision 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.
CurrencyRangeTerm[]	getCostTerms() Gets the cost query terms.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
DateTimeRangeTerm[]	getDueDateTerms() Gets the due date query terms.
BooleanTerm[]	getLeasedTerms() Gets the leased query terms.
BooleanTerm[]	getMustReturnTerms() Gets the must return query terms.
IdTerm[]	getProvisionableIdTerms() Gets the provisionable Id query terms.
ProvisionableQueryInspector[]	getProvisionableTerms() Gets the provisionable query terms.
DateTimeRangeTerm[]	getProvisionDateTerms() Gets the provision date query terms.
ProvisionQueryInspectorRecord	getProvisionQueryInspectorRecord(Type provisionRecordType) Gets the provision query inspector record corresponding to the given Provision record Type.
ProvisionReturnQueryInspector[]	getProvisionReturnTerms() Gets the provision return query terms.
CurrencyRangeTerm[]	getRateAmountTerms() Gets the rate amount query terms.
DurationRangeTerm[]	getRatePeriodTerms() Gets the rate period query terms.
IdTerm[]	getRecipientIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getRecipientTerms() Gets the resource query terms.
IdTerm[]	getRequestIdTerms() Gets the request Id query terms.
RequestQueryInspector[]	getRequestTerms() Gets the request 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.

getProvisionableIdTerms

IdTerm[] getProvisionableIdTerms()

Gets the provisionable Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProvisionableTerms

ProvisionableQueryInspector[] getProvisionableTerms()

Gets the provisionable query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRecipientIdTerms

IdTerm[] getRecipientIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRecipientTerms

ResourceQueryInspector[] getRecipientTerms()

Gets the resource 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.

getProvisionDateTerms

DateTimeRangeTerm[] getProvisionDateTerms()

Gets the provision date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getLeasedTerms

BooleanTerm[] getLeasedTerms()

Gets the leased query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMustReturnTerms

BooleanTerm[] getMustReturnTerms()

Gets the must return query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDueDateTerms

DateTimeRangeTerm[] getDueDateTerms()

Gets the due date query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCostTerms

CurrencyRangeTerm[] getCostTerms()

Gets the cost query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRateAmountTerms

CurrencyRangeTerm[] getRateAmountTerms()

Gets the rate amount query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRatePeriodTerms

DurationRangeTerm[] getRatePeriodTerms()

Gets the rate period query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProvisionReturnTerms

ProvisionReturnQueryInspector[] getProvisionReturnTerms()

Gets the provision return 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.

getProvisionQueryInspectorRecord

ProvisionQueryInspectorRecord getProvisionQueryInspectorRecord(Type provisionRecordType)
                                                               throws OperationFailedException

Gets the provision query inspector record corresponding to the given Provision record Type.

Parameters:

provisionRecordType - a provision record type

Returns:

the provision query inspector record

Throws:

NullArgumentException - provisionRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionRecordType) is false

Compliance:

mandatory - This method must be implemented.