org.osid.provisioning

Interface BrokerQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface BrokerQueryInspector
extends OsidGovernatorQueryInspector

This is the query inspector for examining broker queries.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerQueryInspectorRecord	getBrokerQueryInspectorRecord(Type brokerRecordType) Gets the broker query inspector record corresponding to the given Broker record Type.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
IdTerm[]	getPoolIdTerms() Gets the pool Id query terms.
PoolQueryInspector[]	getPoolTerms() Gets the pool query terms.
IdTerm[]	getQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getQueueTerms() Gets the queue 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

Methods inherited from interface org.osid.OsidOperableQueryInspector

getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTerms

Methods inherited from interface org.osid.OsidSourceableQueryInspector

getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms

Method Detail

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.

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.

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.

getBrokerQueryInspectorRecord

BrokerQueryInspectorRecord getBrokerQueryInspectorRecord(Type brokerRecordType)
                                                         throws OperationFailedException

Gets the broker query inspector record corresponding to the given Broker record Type.

Parameters:

brokerRecordType - a broker record type

Returns:

the broker query inspector record

Throws:

NullArgumentException - brokerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerRecordType) is false

Compliance:

mandatory - This method must be implemented.