public interface AccountQueryInspector extends OsidObjectQueryInspector, OsidFederateableQueryInspector
The query inspectors provide a means of accessing the match terms of a
query. These interfaces are used to examine the actual query terms used in
a search or that may be used to create a smart catalog. Query inspectors
may be converted to OsidQuery
interfaces for reuse or
modification in the search sessions.
Modifier and Type | Method and Description |
---|---|
AccountQueryInspectorRecord |
getAccountQueryInspectorRecord(Type accountRecordType)
Gets the account query inspector record corresponding to the given
Account record Type. |
IdTerm[] |
getAncestorAccountIdTerms()
Gets the ancestor account
Id query terms. |
AccountQueryInspector[] |
getAncestorAccountTerms()
Gets the ancestor account query terms.
|
IdTerm[] |
getBusinessIdTerms()
Gets the business
Id query terms. |
BusinessQueryInspector[] |
getBusinessTerms()
Gets the business query terms.
|
StringTerm[] |
getCodeTerms()
Gets the code query terms.
|
BooleanTerm[] |
getCreditBalanceTerms()
Gets the credit balance query terms.
|
IdTerm[] |
getDescendantAccountIdTerms()
Gets the descendant account
Id query terms. |
AccountQueryInspector[] |
getDescendantAccountTerms()
Gets the descendant account query terms.
|
SummaryQueryInspector[] |
getSummaryTerms()
Gets the summary query terms.
|
getCommentIdTerms, getCommentTerms, getCreditIdTerms, getCreditTerms, getDescriptionTerms, getDisplayNameTerms, getGenusTypeTerms, getJournalEntryIdTerms, getJournalEntryTerms, getParentGenusTypeTerms, getRelationshipIdTerms, getRelationshipPeerIdTerms, getRelationshipTerms, getStateIdTerms, getStateTerms, getStatisticTerms, getSubjectIdTerms, getSubjectRelevancyTerms, getSubjectTerms
getIdTerms
getRecordTypeTerms
getRecordTypes, hasRecordType
getAnyTerms, getKeywordTerms
BooleanTerm[] getCreditBalanceTerms()
mandatory
- This method must be implemented. StringTerm[] getCodeTerms()
mandatory
- This method must be implemented. SummaryQueryInspector[] getSummaryTerms()
mandatory
- This method must be implemented. IdTerm[] getAncestorAccountIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. AccountQueryInspector[] getAncestorAccountTerms()
mandatory
- This method must be implemented. IdTerm[] getDescendantAccountIdTerms()
Id
query terms. Id
termsmandatory
- This method must be implemented. AccountQueryInspector[] getDescendantAccountTerms()
mandatory
- This method must be implemented. IdTerm[] getBusinessIdTerms()
Id
query terms. Id
query termsmandatory
- This method must be implemented. BusinessQueryInspector[] getBusinessTerms()
mandatory
- This method must be implemented. AccountQueryInspectorRecord getAccountQueryInspectorRecord(Type accountRecordType) throws OperationFailedException
Account
record Type.
Multiple record
retrievals produce a nested OR
term.accountRecordType
- an account record typeNullArgumentException
- accountRecordType
is null
OperationFailedException
- unable to complete requestUnsupportedException
-
hasRecordType(accountRecordType)
is false
mandatory
- This method must be implemented.