Back to index

plone3  3.1.7
interfaces.py
Go to the documentation of this file.
00001 from zope.interface import Interface, Attribute
00002 
00003 class ITermWithDescription(Interface):
00004     """A term which carries an additional description
00005     """
00006     
00007     description = Attribute(
00008         "description",
00009         """Description of the term, which will be displayed to distinguish
00010            between terms with similar labels.
00011         """)
00012 
00013 class IBrowsableTerm(Interface):
00014     """A term which may be browsed. This interface is only applied to
00015     terms which are actually browsable (e.g. those representing folders).
00016     """
00017 
00018     browse_token = Attribute(
00019         "browse_token",
00020         """Token which can be used to get contents of browsable terms in
00021            queryable sources.
00022 
00023         The value of this attribute must be a non-empty 7-bit string.
00024         Control characters are not allowed.
00025         """)
00026 
00027     parent_token = Attribute(
00028         "parent_token",
00029         """Token which can be used to get contents of the parent of browsable
00030            terms in queryable sources.
00031 
00032         The value of this attribute must be a non-empty 7-bit string.
00033         Control characters are not allowed.
00034         """)