Back to index

plone3  3.1.7
interfaces.py
Go to the documentation of this file.
00001 from zope.interface import Interface
00002 from zope.schema import Bool
00003 
00004 class INextPreviousProvider(Interface):
00005     """A folderish component capable of describing the next and previous 
00006     item relative to a particular id.
00007     """
00008 
00009     enabled = Bool(title=u"True if next/previous behaviour is enabled")
00010     
00011     def getNextItem(obj):
00012         """Returns information about next item in the container relative to 
00013         the given object.
00014         
00015         This is a dict with the following keys:
00016         
00017             - id, the id of the object
00018             - url, the url of the object
00019             - title, the title of the object
00020             - description, a description of the object
00021             - portal_type, the object's portal type
00022         """
00023 
00024     def getPreviousItem(obj):
00025         """Returns the previous item in the container relative to the given 
00026         object
00027         """
00028