l.s.w.v.IHugeVocabulary(IVocabulary, IVocabularyTokenized) : interface documentation

Part of lp.services.webapp.vocabulary View In Hierarchy

Interface for huge vocabularies.

Items in an IHugeVocabulary should have human readable tokens or the default UI will suck.

Attribute displayname A name for this vocabulary, to be displayed in the picker window.
Attribute step_title The search step title in the picker window.
Method searchForTerms Return a `CountableIterator` of `SimpleTerm`s that match the query.
Method supportedFilters Return the VocabularyFilters supported by searchForTerms.
displayname =
A name for this vocabulary, to be displayed in the picker window.
step_title =
The search step title in the picker window.
def searchForTerms(query=None, vocab_filter=None):
Return a `CountableIterator` of `SimpleTerm`s that match the query.

:param query: a query string used to limit the results.
:param vocab_filter: a VocabularyFilter applied to the results. A
    filter has a specific meaning for each vocabulary implementation
    which supports it's use. Vocabularies which support the use of
    filters should each accept the ALL filter which means the same as
    not applying any filter.
    The parameter value can be a string corresponding to a supported
    filter name, or a filter instance.

Note that what is searched and how the match is the choice of the
IHugeVocabulary implementation.
def supportedFilters():
Return the VocabularyFilters supported by searchForTerms.
API Documentation for Launchpad, generated by pydoctor at 2019-02-17 00:00:04.