org.osid.provisioning

Interface PoolQueryInspector

All Superinterfaces:

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

public interface PoolQueryInspector
extends OsidGovernatorQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examining pool 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[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
PoolQueryInspectorRecord	getPoolQueryInspectorRecord(Type poolRecordType) Gets the pool query inspector record corresponding to the given Pool record Type.
IdTerm[]	getProvisionableIdTerms() Gets the provisionable Id query terms.
ProvisionableQueryInspector[]	getProvisionableTerms() Gets the provisionable query terms.
CardinalRangeTerm[]	getSizeTerms() Gets the size 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

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.

getSizeTerms

CardinalRangeTerm[] getSizeTerms()

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

getPoolQueryInspectorRecord

PoolQueryInspectorRecord getPoolQueryInspectorRecord(Type poolRecordType)
                                                     throws OperationFailedException

Gets the pool query inspector record corresponding to the given Pool record Type.

Parameters:

poolRecordType - a pool record type

Returns:

the pool query inspector record

Throws:

NullArgumentException - poolRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolRecordType) is false

Compliance:

mandatory - This method must be implemented.