org.osid.provisioning

Interface ProvisionableQueryInspector

All Superinterfaces:

Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidQueryInspector, OsidRelationshipQueryInspector, OsidTemporalQueryInspector

public interface ProvisionableQueryInspector
extends OsidRelationshipQueryInspector

This is the query inspector for examining provisionable queries.

Method Summary

Methods

Modifier and Type	Method and Description
IdTerm[]	getDistributorIdTerms() Gets the distributor Id query terms.
DistributorQueryInspector[]	getDistributorTerms() Gets the distributor query terms.
IdTerm[]	getPoolIdTerms() Gets the pool Id query terms.
PoolQueryInspector[]	getPoolTerms() Gets the pool query terms.
ProvisionableQueryInspectorRecord	getProvisionableQueryInspectorRecord(Type provisionableRecordType) Gets the provisionable query inspector record corresponding to the given Provisionable record Type.
IdTerm[]	getResourceIdTerms() Gets the resource Id query terms.
ResourceQueryInspector[]	getResourceTerms() Gets the resource query terms.
CardinalRangeTerm[]	getUseTerms() Gets the use query terms.

Methods inherited from interface org.osid.OsidRelationshipQueryInspector

getEndReasonIdTerms, getEndReasonTerms

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.OsidTemporalQueryInspector

getDateTerms, getEffectiveTerms, getEndDateTerms, getStartDateTerms

Method Detail

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.

getResourceIdTerms

IdTerm[] getResourceIdTerms()

Gets the resource Id query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getResourceTerms

ResourceQueryInspector[] getResourceTerms()

Gets the resource query terms.

Returns:

the query terms

Compliance:

mandatory - This method must be implemented.

getUseTerms

CardinalRangeTerm[] getUseTerms()

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

getProvisionableQueryInspectorRecord

ProvisionableQueryInspectorRecord getProvisionableQueryInspectorRecord(Type provisionableRecordType)
                                                                       throws OperationFailedException

Gets the provisionable query inspector record corresponding to the given Provisionable record Type.

Parameters:

provisionableRecordType - a provisionable record type

Returns:

the provisionable query inspector record

Throws:

NullArgumentException - provisionableRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(provisionableRecordType) is false

Compliance:

mandatory - This method must be implemented.