Interface PoolQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidGovernatorQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector, OsidSourceableQueryInspector, OsidSubjugateableQueryInspector
public interface PoolQueryInspector
extends OsidGovernatorQueryInspector, OsidSubjugateableQueryInspector
This is the query inspector for examining pool queries.
-
Method Summary
Modifier and TypeMethodDescriptionIdTerm[]Gets the brokerIdquery terms.Gets the broker query terms.IdTerm[]Gets the distributorIdquery terms.Gets the distributor query terms.getPoolQueryInspectorRecord(Type poolRecordType) Gets the pool query inspector record corresponding to the givenPoolrecordType.IdTerm[]Gets the provisionableIdquery terms.Gets the provisionable query terms.Gets the size query terms.IdTerm[]Gets the supplierIdquery terms.Gets the supplier query terms.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface OsidExtensibleQueryInspector
getRecordTypeTermsMethods inherited from interface OsidIdentifiableQueryInspector
getIdTermsMethods inherited from interface OsidObjectQueryInspector
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTermsModifier and TypeMethodDescriptionIdTerm[]Gets the commentIdquery terms.Gets the comment query terms.IdTerm[]Gets the creditIdquery terms.Gets the credit query terms.Gets the description query terms.Gets the display name query terms.TypeTerm[]Gets the genus type query terms.IdTerm[]Gets the journal entryIdquery terms.Gets the journal entry query terms.TypeTerm[]Gets the parent genus type query terms.IdTerm[]Gets the relationshipIdquery terms.IdTerm[]Gets the relationship peerIdquery terms.Gets the relationship query terms.IdTerm[]Gets the stateIdquery terms.Gets the state query terms.Gets the statistic query terms.IdTerm[]Gets the subjectIdquery terms.Gets the subject relevancy query terms.Gets the subject query terms.Methods inherited from interface OsidOperableQueryInspector
getActiveTerms, getDisabledTerms, getEnabledTerms, getOperationalTermsModifier and TypeMethodDescriptionGets the active query terms.Gets the administratively disabled query terms.Gets the administratively enabled query terms.Gets the operational query terms.Methods inherited from interface OsidQueryInspector
getAnyTerms, getKeywordTermsModifier and TypeMethodDescriptionGets the any query terms.Gets the keyword query terms.Methods inherited from interface OsidSourceableQueryInspector
getBrandingIdTerms, getBrandingTerms, getLicenseTerms, getProviderIdTerms, getProviderTerms
-
Method Details
-
getBrokerIdTerms
IdTerm[] getBrokerIdTerms()Gets the brokerIdquery 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.
-
getSupplierIdTerms
IdTerm[] getSupplierIdTerms()Gets the supplierIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getSupplierTerms
ResourceQueryInspector[] getSupplierTerms()Gets the supplier query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getProvisionableIdTerms
IdTerm[] getProvisionableIdTerms()Gets the provisionableIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getProvisionableTerms
ProvisionableQueryInspector[] getProvisionableTerms()Gets the provisionable 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.
-
getDistributorIdTerms
IdTerm[] getDistributorIdTerms()Gets the distributorIdquery 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.
-
getPoolQueryInspectorRecord
PoolQueryInspectorRecord getPoolQueryInspectorRecord(Type poolRecordType) throws OperationFailedException Gets the pool query inspector record corresponding to the givenPoolrecordType.- Parameters:
poolRecordType- a pool record type- Returns:
- the pool query inspector record
- Throws:
NullArgumentException-poolRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(poolRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-