org.osid.provisioning.rules

Interface BrokerConstrainerQueryInspector

All Superinterfaces:

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

public interface BrokerConstrainerQueryInspector
extends OsidConstrainerQueryInspector

This is the query inspector for examining broker constrainer queries.

Method Summary

Methods

Modifier and Type	Method and Description
BrokerConstrainerQueryInspectorRecord	getBrokerConstrainerQueryInspectorRecord(Type brokerConstrainerRecordType) Gets the broker constrainer query inspector record corresponding to the given BrokerConstrainer record Type.
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor 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

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.

getBrokerConstrainerQueryInspectorRecord

BrokerConstrainerQueryInspectorRecord getBrokerConstrainerQueryInspectorRecord(Type brokerConstrainerRecordType)
                                                                               throws OperationFailedException

Gets the broker constrainer query inspector record corresponding to the given BrokerConstrainer record Type.

Parameters:

brokerConstrainerRecordType - a broker constrainer record type

Returns:

the broker constrainer query inspector record

Throws:

NullArgumentException - brokerConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(brokerConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.