l.a.i.f.IFAQCollection(Interface) : interface documentation

Part of lp.answers.interfaces.faqcollection View In Hierarchy

Known subclasses: lp.answers.interfaces.faq.IFAQSet, lp.answers.interfaces.webservice.IFAQTarget

Interface provided by collection of FAQs.

This interface allows for retrieving and searching for FAQs. The more specific IFAQTarget interface is used for objects that directly contain the FAQ.

Method getFAQ Return the IFAQ in this collection with the requested id.
Method searchFAQs Return the FAQs in the collection that matches the search criteria.
def getFAQ(id):
Return the IFAQ in this collection with the requested id.
ReturnsThe IFAQ with the requested id or None if there is no document with that id.
def searchFAQs(search_text=None, owner=None, sort=None):
Return the FAQs in the collection that matches the search criteria.
Parameterssearch_textA string that is matched against the FAQ title, keywords and content. If None, the search_text is not included as a filter criteria.
ownerA person that is matched against the owner of the FAQ. If None, owner is not included as a filter criteria.
sortOne value from the FAQSort enumeration. If None, a default value is used. When there is a search_text value, the default is to sort by RELEVANCY, otherwise results are sorted NEWEST_FIRST.
API Documentation for Launchpad, generated by pydoctor at 2020-10-27 00:00:07.