org.osid.provisioning.rules

Interface PoolConstrainerQueryInspector

All Superinterfaces:

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

public interface PoolConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query interface for examining pool constrainer 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.
PoolConstrainerQueryInspectorRecord	getPoolConstrainerQueryInspectorRecord(Type poolConstrainerRecordType) Gets the pool constrainer query inspector record corresponding to the given PoolConstrainer 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

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.

getPoolConstrainerQueryInspectorRecord

PoolConstrainerQueryInspectorRecord getPoolConstrainerQueryInspectorRecord(Type poolConstrainerRecordType)
                                                                           throws OperationFailedException

Gets the pool constrainer query inspector record corresponding to the given PoolConstrainer record Type.

Parameters:

poolConstrainerRecordType - a pool constrainer record type

Returns:

the pool constrainer query inspector record

Throws:

NullArgumentException - poolConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.