org.osid.provisioning

Interface DistributorQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidCatalogQueryInspector, OsidExtensibleQueryInspector, OsidFederateableQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector

public interface DistributorQueryInspector
extends OsidCatalogQueryInspector

This is the query inspector for examining distributor queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getAncestorDistributorIdTerms() Gets the ancestor distributor Id query terms.
DistributorQueryInspector[]	getAncestorDistributorTerms() Gets the ancestor distributor query terms.
IdTerm[]	getBrokerIdTerms() Gets the broker Id query terms.
BrokerQueryInspector[]	getBrokerTerms() Gets the broker query terms.
IdTerm[]	getDescendantDistributorIdTerms() Gets the descendant distributor Id query terms.
DistributorQueryInspector[]	getDescendantDistributorTerms() Gets the descendant distributor query terms.
DistributorQueryInspectorRecord	getDistributorQueryInspectorRecord(Type distributorRecordType) Gets the distributor query inspector record corresponding to the given Distributor record Type.
IdTerm[]	getPoolIdTerms() Gets the pool Id query terms.
PoolQueryInspector[]	getPoolTerms() Gets the pool query terms.
IdTerm[]	getProvisionIdTerms() Gets the provision Id query terms.
ProvisionQueryInspector[]	getProvisionTerms() Gets the provision query terms.
IdTerm[]	getQueueIdTerms() Gets the queue Id query terms.
QueueQueryInspector[]	getQueueTerms() Gets the queue 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.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.

getQueueIdTerms

IdTerm[] getQueueIdTerms()

Gets the queue Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getQueueTerms

QueueQueryInspector[] getQueueTerms()

Gets the queue query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPoolIdTerms

IdTerm[] getPoolIdTerms()

Gets the pool Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getPoolTerms

PoolQueryInspector[] getPoolTerms()

Gets the pool query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProvisionIdTerms

IdTerm[] getProvisionIdTerms()

Gets the provision Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getProvisionTerms

ProvisionQueryInspector[] getProvisionTerms()

Gets the provision query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDistributorIdTerms

IdTerm[] getAncestorDistributorIdTerms()

Gets the ancestor distributor Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getAncestorDistributorTerms

DistributorQueryInspector[] getAncestorDistributorTerms()

Gets the ancestor distributor query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDistributorIdTerms

IdTerm[] getDescendantDistributorIdTerms()

Gets the descendant distributor Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDescendantDistributorTerms

DistributorQueryInspector[] getDescendantDistributorTerms()

Gets the descendant distributor query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getDistributorQueryInspectorRecord

DistributorQueryInspectorRecord getDistributorQueryInspectorRecord(Type distributorRecordType)
                                                                   throws OperationFailedException

Gets the distributor query inspector record corresponding to the given Distributor record Type.

Parameters:

distributorRecordType - a distributor record type

Returns:

the distributor query inspector record

Throws:

NullArgumentException - distributorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(distributorRecordType) is false

Compliance:

mandatory - This method must be implemented.