org.osid.provisioning.rules

Interface BrokerProcessorQueryInspector

All Superinterfaces:

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

public interface BrokerProcessorQueryInspector
extends OsidProcessorQueryInspector

This is the query inspector for examining broker processor queries.

Method Summary

Methods

Modifier and Type	Method and Description
BooleanTerm[]	getAllowsCompoundRequestsTerms() Gets the allows compound requests query terms.
BooleanTerm[]	getAllowsProvisionExchangeTerms() Gets the allows provision exchange query terms.
BrokerProcessorQueryInspectorRecord	getBrokerProcessorQueryInspectorRecord(Type brokerProcessorRecordType) Gets the broker processor query inspector record corresponding to the given BrokerProcessor record Type.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
DurationRangeTerm[]	getFixedLeaseDurationTerms() Gets the fixed lease duration query terms.
BooleanTerm[]	getLeasingTerms() Gets the leasing query terms.
BooleanTerm[]	getMustReturnProvisionsTerms() Gets the must return provisions query terms.
IdTerm[]	getRuledBrokerIdTerms() Gets the broker Id query terms.
BrokerQueryInspector[]	getRuledBrokerTerms() Gets the broker 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

getLeasingTerms

BooleanTerm[] getLeasingTerms()

Gets the leasing query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getFixedLeaseDurationTerms

DurationRangeTerm[] getFixedLeaseDurationTerms()

Gets the fixed lease duration query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getMustReturnProvisionsTerms

BooleanTerm[] getMustReturnProvisionsTerms()

Gets the must return provisions query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAllowsProvisionExchangeTerms

BooleanTerm[] getAllowsProvisionExchangeTerms()

Gets the allows provision exchange query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAllowsCompoundRequestsTerms

BooleanTerm[] getAllowsCompoundRequestsTerms()

Gets the allows compound requests query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledBrokerIdTerms

IdTerm[] getRuledBrokerIdTerms()

Gets the broker Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getRuledBrokerTerms

BrokerQueryInspector[] getRuledBrokerTerms()

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

getBrokerProcessorQueryInspectorRecord

BrokerProcessorQueryInspectorRecord getBrokerProcessorQueryInspectorRecord(Type brokerProcessorRecordType)
                                                                           throws OperationFailedException

Gets the broker processor query inspector record corresponding to the given BrokerProcessor record Type.

Parameters:

brokerProcessorRecordType - a broker processor record type

Returns:

the broker processor query inspector record

Throws:

NullArgumentException - brokerProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.