org.osid.provisioning

Interface QueueQueryInspector

All Superinterfaces:

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

public interface QueueQueryInspector
extends OsidGovernatorQueryInspector, OsidSubjugateableQueryInspector

This is the query inspector for examning queue 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.
BooleanTerm[]	getCanSpecifyProvisionableTerms() Gets the can request provisionables query terms.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
DurationRangeTerm[]	getEWATerms() Gets the ewa query terms.
QueueQueryInspectorRecord	getQueueQueryInspectorRecord(Type queueRecordType) Gets the queue query inspector record corresponding to the given Queue record Type.
IdTerm[]	getRequestIdTerms() Gets the request Id query terms.
RequestQueryInspector[]	getRequestTerms() Gets the request 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.

getRequestIdTerms

IdTerm[] getRequestIdTerms()

Gets the request Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRequestTerms

RequestQueryInspector[] getRequestTerms()

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

getEWATerms

DurationRangeTerm[] getEWATerms()

Gets the ewa query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getCanSpecifyProvisionableTerms

BooleanTerm[] getCanSpecifyProvisionableTerms()

Gets the can request provisionables 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.

getQueueQueryInspectorRecord

QueueQueryInspectorRecord getQueueQueryInspectorRecord(Type queueRecordType)
                                                       throws OperationFailedException

Gets the queue query inspector record corresponding to the given Queue record Type.

Parameters:

queueRecordType - a queue record type

Returns:

the queue query inspector record

Throws:

NullArgumentException - queueRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(queueRecordType) is false

Compliance:

mandatory - This method must be implemented.