Back to index

plone3  3.1.7
Public Member Functions | Static Public Attributes
CMFCore.interfaces._tools.ISyndicationTool Class Reference
Inheritance diagram for CMFCore.interfaces._tools.ISyndicationTool:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._tools.ISyndicationTool:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def enableSyndication
def disableSyndication
def getSyndicatableContent
def isSiteSyndicationAllowed
def isSyndicationAllowed
def getUpdatePeriod
def getUpdateFrequency
def getUpdateBase
def getHTML4UpdateBase
def getMaxItems

Static Public Attributes

tuple id

Detailed Description

An object that provides content syndication facilities

Definition at line 1234 of file _tools.py.


Member Function Documentation

Disable syndication for the passed-in object

o raises 'This object does not have Syndication Information' if 
  syndication has already been disabled

Definition at line 1257 of file _tools.py.

01257 
01258     def disableSyndication(obj):
01259         """ Disable syndication for the passed-in object
01260 
01261         o raises 'This object does not have Syndication Information' if 
01262           syndication has already been disabled
01263         """

Enable syndication for the passed-in object

o raises 'Syndication is Disabled' if syndication is now allowed

o raises 'Syndication Information Exists' if used repeatedly

Definition at line 1249 of file _tools.py.

01249 
01250     def enableSyndication(obj):
01251         """ Enable syndication for the passed-in object
01252 
01253         o raises 'Syndication is Disabled' if syndication is now allowed
01254 
01255         o raises 'Syndication Information Exists' if used repeatedly
01256         """

return the HTML-formatted feed publishing base date

o falls back to the site-wide value if no object is passed in

o raises 'Syndication is not Allowed' if the site-wide policy
  does not allow syndication

Definition at line 1310 of file _tools.py.

01310 
01311     def getHTML4UpdateBase(obj=None):
01312         """ return the HTML-formatted feed publishing base date
01313 
01314         o falls back to the site-wide value if no object is passed in
01315 
01316         o raises 'Syndication is not Allowed' if the site-wide policy
01317           does not allow syndication
01318         """
        
Return the number of items published at any one time in the feed

o falls back to the site-wide value if no object is passed in

o raises 'Syndication is not Allowed' if the site-wide policy
  does not allow syndication

Definition at line 1319 of file _tools.py.

01319 
01320     def getMaxItems(obj=None):
01321         """ Return the number of items published at any one time in the feed
01322 
01323         o falls back to the site-wide value if no object is passed in
01324 
01325         o raises 'Syndication is not Allowed' if the site-wide policy
01326           does not allow syndication
01327         """
01328 
01329 #
01330 #   Types tool interfaces
#
Retrieve all syndicatable content from the passed-in object

o will call the hool "synContentValues" if it exists to allow
  individual customization

o falls back to calling contentValues

Definition at line 1264 of file _tools.py.

01264 
01265     def getSyndicatableContent(obj):
01266         """ Retrieve all syndicatable content from the passed-in object
01267 
01268         o will call the hool "synContentValues" if it exists to allow
01269           individual customization
01270 
01271         o falls back to calling contentValues
01272         """

Return the syndication feed base date for the publishing schedule

o falls back to the site-wide value if no object is passed in

o raises 'Syndication is not Allowed' if the site-wide policy
  does not allow syndication

Definition at line 1301 of file _tools.py.

01301 
01302     def getUpdateBase(obj=None):
01303         """ Return the syndication feed base date for the publishing schedule
01304 
01305         o falls back to the site-wide value if no object is passed in
01306 
01307         o raises 'Syndication is not Allowed' if the site-wide policy
01308           does not allow syndication
01309         """

Return the syndicated feed update frequency

o falls back to the site-wide value if no object is passed in

o raises 'Syndication is not Allowed' if the site-wide policy
  does not allow syndication

Definition at line 1292 of file _tools.py.

01292 
01293     def getUpdateFrequency(obj=None):
01294         """ Return the syndicated feed update frequency
01295 
01296         o falls back to the site-wide value if no object is passed in
01297 
01298         o raises 'Syndication is not Allowed' if the site-wide policy
01299           does not allow syndication
01300         """

Return the update period for the syndicated feed

o falls back to the site-wide value if no object is passed in

o raises 'Syndication is not Allowed' if the site-wide policy
  does not allow syndication

Definition at line 1283 of file _tools.py.

01283 
01284     def getUpdatePeriod(obj=None):
01285         """ Return the update period for the syndicated feed
01286 
01287         o falls back to the site-wide value if no object is passed in
01288 
01289         o raises 'Syndication is not Allowed' if the site-wide policy
01290           does not allow syndication
01291         """

Return the site-wide syndication flag

Definition at line 1273 of file _tools.py.

01273 
01274     def isSiteSyndicationAllowed():
01275         """ Return the site-wide syndication flag
01276         """

Here is the caller graph for this function:

Return the syndication flag for the passed-in object

o falls back to retrieving the site-wide syndication flag

Definition at line 1277 of file _tools.py.

01277 
01278     def isSyndicationAllowed(obj=None):
01279         """ Return the syndication flag for the passed-in object
01280 
01281         o falls back to retrieving the site-wide syndication flag
01282         """


Member Data Documentation

Initial value:
Attribute('id',
            """ The ID of the tool.o BBB:  for use in 'getToolByName';  in the future, prefer  'zapi.getUtility(ISyndicationTool)'.o Must be set to "portal_syndication"""",
            )
An object that provides content syndication facilities

Definition at line 1239 of file _tools.py.


The documentation for this class was generated from the following file: