org.osid.provisioning.rules

Interface QueueProcessorQueryInspector

All Superinterfaces:

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

public interface QueueProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examning queue processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getAutomaticTerms() Gets the automatic query terms.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
BooleanTerm[]	getFifoTerms() Gets the fifo query terms.
QueueProcessorQueryInspectorRecord	getQueueProcessorQueryInspectorRecord(Type queueProcessorRecordType) Gets the queue processor query inspector record corresponding to the given QueueProcessor record Type.
BooleanTerm[]	getRemovesProcessedQueueEntriesTerms() Gets the removes processed queue entries terms.
IdTerm[]	getRuledQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getRuledQueueTerms() Gets the queue 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

getAutomaticTerms

BooleanTerm[] getAutomaticTerms()

Gets the automatic query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFifoTerms

BooleanTerm[] getFifoTerms()

Gets the fifo query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRemovesProcessedQueueEntriesTerms

BooleanTerm[] getRemovesProcessedQueueEntriesTerms()

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

getQueueProcessorQueryInspectorRecord

QueueProcessorQueryInspectorRecord getQueueProcessorQueryInspectorRecord(Type queueProcessorRecordType)
                                                                         throws OperationFailedException

Gets the queue processor query inspector record corresponding to the given QueueProcessor record Type.

Parameters:

queueProcessorRecordType - a queue processor record type

Returns:

the queue processor query inspector record

Throws:

NullArgumentException - queueProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.