org.osid.provisioning.rules

Interface PoolProcessorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector

public interface PoolProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining pool processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getAllocatesByLeastCostTerms() Gets the allocates by least cost query terms.
BooleanTerm[]	getAllocatesByLeastUseTerms() Gets the allocates by least use query terms.
BooleanTerm[]	getAllocatesByMostCostTerms() Gets the allocates by most cost query terms.
BooleanTerm[]	getAllocatesByMostUseTerms() Gets the allocates by most use query terms.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
PoolProcessorQueryInspectorRecord	getPoolProcessorQueryInspectorRecord(Type poolProcessorRecordType) Gets the pool processor query inspector record corresponding to the given PoolProcessor record Type.
IdTerm[]	getRuledPoolIdTerms() Gets the pool Id query terms.
PoolQueryInspector[]	getRuledPoolTerms() Gets the pool query terms.

Methods inherited from interface org.osid.OsidRuleQueryInspector

getRuleIdTerms, getRuleTerms

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

Method Detail

getAllocatesByLeastUseTerms

BooleanTerm[] getAllocatesByLeastUseTerms()

Gets the allocates by least use query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAllocatesByMostUseTerms

BooleanTerm[] getAllocatesByMostUseTerms()

Gets the allocates by most use query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAllocatesByLeastCostTerms

BooleanTerm[] getAllocatesByLeastCostTerms()

Gets the allocates by least cost query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAllocatesByMostCostTerms

BooleanTerm[] getAllocatesByMostCostTerms()

Gets the allocates by most cost query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledPoolIdTerms

IdTerm[] getRuledPoolIdTerms()

Gets the pool Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledPoolTerms

PoolQueryInspector[] getRuledPoolTerms()

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.

getPoolProcessorQueryInspectorRecord

PoolProcessorQueryInspectorRecord getPoolProcessorQueryInspectorRecord(Type poolProcessorRecordType)
                                                                       throws OperationFailedException

Gets the pool processor query inspector record corresponding to the given PoolProcessor record Type.

Parameters:

poolProcessorRecordType - a pool processor record type

Returns:

the pool processor query inspector record

Throws:

NullArgumentException - poolProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.