Interface PoolProcessorQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidProcessorQueryInspector, OsidQueryInspector, OsidRuleQueryInspector
This is the query inspector for examining pool processor queries.
-
Method Summary
Modifier and TypeMethodDescriptionGets the allocates by least cost query terms.Gets the allocates by least use query terms.Gets the allocates by most cost query terms.Gets the allocates by most use query terms.IdTerm[]Gets the distributorIdquery terms.Gets the distributor query terms.getPoolProcessorQueryInspectorRecord(Type poolProcessorRecordType) Gets the pool processor query inspector record corresponding to the givenPoolProcessorrecordType.IdTerm[]Gets the poolIdquery terms.Gets the pool 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 OsidRuleQueryInspector
getConditionRecordTypeTerms, getRuleIdTerms, getRuleTerms
-
Method Details
-
getAllocatesByLeastUseTerms
BooleanTerm[] getAllocatesByLeastUseTerms()Gets the allocates by least use query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getAllocatesByMostUseTerms
BooleanTerm[] getAllocatesByMostUseTerms()Gets the allocates by most use query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getAllocatesByLeastCostTerms
BooleanTerm[] getAllocatesByLeastCostTerms()Gets the allocates by least cost query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getAllocatesByMostCostTerms
BooleanTerm[] getAllocatesByMostCostTerms()Gets the allocates by most cost query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRuledPoolIdTerms
IdTerm[] getRuledPoolIdTerms()Gets the poolIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getRuledPoolTerms
PoolQueryInspector[] getRuledPoolTerms()Gets the pool 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.
-
getPoolProcessorQueryInspectorRecord
PoolProcessorQueryInspectorRecord getPoolProcessorQueryInspectorRecord(Type poolProcessorRecordType) throws OperationFailedException Gets the pool processor query inspector record corresponding to the givenPoolProcessorrecordType.- Parameters:
poolProcessorRecordType- a pool processor record type- Returns:
- the pool processor query inspector record
- Throws:
NullArgumentException-poolProcessorRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(poolProcessorRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-