Interface ControllerQueryInspector
- All Superinterfaces:
Extensible, OsidBrowsableQueryInspector, OsidExtensibleQueryInspector, OsidIdentifiableQueryInspector, OsidObjectQueryInspector, OsidOperableQueryInspector, OsidQueryInspector
public interface ControllerQueryInspector
extends OsidObjectQueryInspector, OsidOperableQueryInspector
This is the query inspector for examning controller queries.
-
Method Summary
Modifier and TypeMethodDescriptionGets the address query terms.getControllerQueryInspectorRecord(Type controllerRecordType) Gets the controller query inspector record corresponding to the givenControllerrecordType.IdTerm[]Gets the stateIdquery terms.Gets the discreet query terms.Gets the state query terms.IdTerm[]Gets the modelIdquery terms.Gets the model query terms.IdTerm[]Gets the systemIdquery terms.Gets the system query terms.Gets the toggle query terms.Gets the variable percentage query terms.Gets the variable maximum query terms.Gets the variable minimum query terms.Gets the variable query terms.Gets the version since query terms.Gets the version 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.
-
Method Details
-
getAddressTerms
StringTerm[] getAddressTerms()Gets the address query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getModelIdTerms
IdTerm[] getModelIdTerms()Gets the modelIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getModelTerms
ModelQueryInspector[] getModelTerms()Gets the model query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVersionTerms
VersionTerm[] getVersionTerms()Gets the version query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVersionSinceTerms
VersionTerm[] getVersionSinceTerms()Gets the version since query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getToggleableTerms
BooleanTerm[] getToggleableTerms()Gets the toggle query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVariableTerms
BooleanTerm[] getVariableTerms()Gets the variable query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVariableByPercentageTerms
BooleanTerm[] getVariableByPercentageTerms()Gets the variable percentage query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVariableMinimumTerms
DecimalRangeTerm[] getVariableMinimumTerms()Gets the variable minimum query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getVariableMaximumTerms
DecimalRangeTerm[] getVariableMaximumTerms()Gets the variable maximum query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDiscreetStatesTerms
BooleanTerm[] getDiscreetStatesTerms()Gets the discreet query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDiscreetStateIdTerms
IdTerm[] getDiscreetStateIdTerms()Gets the stateIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getDiscreetStateTerms
StateQueryInspector[] getDiscreetStateTerms()Gets the state query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getSystemIdTerms
IdTerm[] getSystemIdTerms()Gets the systemIdquery terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getSystemTerms
SystemQueryInspector[] getSystemTerms()Gets the system query terms.- Returns:
- the query terms
- Compliance:
mandatory- This method must be implemented.
-
getControllerQueryInspectorRecord
ControllerQueryInspectorRecord getControllerQueryInspectorRecord(Type controllerRecordType) throws OperationFailedException Gets the controller query inspector record corresponding to the givenControllerrecordType.- Parameters:
controllerRecordType- a controller record type- Returns:
- the controller query inspector record
- Throws:
NullArgumentException-controllerRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(controllerRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-