org.osid.provisioning.rules

Interface QueueConstrainerQueryInspector

All Superinterfaces:

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

public interface QueueConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query inspector for examining queue 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.
QueueConstrainerQueryInspectorRecord	getQueueConstrainerQueryInspectorRecord(Type queueConstrainerRecordType) Gets the queue constrainer query inspector record corresponding to the given QueueConstrainer record Type.
IdTerm[]	getRequiredProvisionPoolIdTerms() Gets the required provision pool Id query terms.
PoolQueryInspector[]	getRequiredProvisionPoolTerms() Gets the required provision pool query terms.
BooleanTerm[]	getRequiresProvisionsTerms() Gets the requires provisions query terms.
IdTerm[]	getRuledQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getRuledQueueTerms() Gets the queue query terms.
CardinalRangeTerm[]	getSizeLimitTerms() Gets the size limit 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

getSizeLimitTerms

CardinalRangeTerm[] getSizeLimitTerms()

Gets the size limit query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequiresProvisionsTerms

BooleanTerm[] getRequiresProvisionsTerms()

Gets the requires provisions query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequiredProvisionPoolIdTerms

IdTerm[] getRequiredProvisionPoolIdTerms()

Gets the required provision pool Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequiredProvisionPoolTerms

PoolQueryInspector[] getRequiredProvisionPoolTerms()

Gets the required provision pool query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledQueueIdTerms

IdTerm[] getRuledQueueIdTerms()

Gets the queue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledQueueTerms

QueueQueryInspector[] getRuledQueueTerms()

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

getQueueConstrainerQueryInspectorRecord

QueueConstrainerQueryInspectorRecord getQueueConstrainerQueryInspectorRecord(Type queueConstrainerRecordType)
                                                                             throws OperationFailedException

Gets the queue constrainer query inspector record corresponding to the given QueueConstrainer record Type.

Parameters:

queueConstrainerRecordType - a queue constrainer record type

Returns:

the queue constrainer query inspector record

Throws:

NullArgumentException - queueConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.