Back to index

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

List of all members.

Public Member Functions

def overrideDiscussionFor
def getDiscussionFor
def isDiscussionAllowedFor

Static Public Attributes

tuple id

Detailed Description

Links content to discussions.

Definition at line 502 of file _tools.py.


Member Function Documentation

Return an IDiscussionItemContainer for 'content'.

o Create the IDC if necessary.

o Raise ValueError if discussion is not allowed on 'content'.

o Permission:  Public

Definition at line 482 of file _tools.py.

00482 
00483     def getDiscussionFor(content):
00484         """ Return an IDiscussionItemContainer for 'content'.
00485 
00486         o Create the IDC if necessary.
00487 
00488         o Raise ValueError if discussion is not allowed on 'content'.
00489 
00490         o Permission:  Public
00491         """

Return True discussion is allowed for 'content', else False.

o Result may be looked up from an object-specific value, or by place,
  or from a site-wide policy.

o Permission:  Public

Definition at line 492 of file _tools.py.

00492 
00493     def isDiscussionAllowedFor(content):
00494         """ Return True discussion is allowed for 'content', else False.
00495 
00496         o Result may be looked up from an object-specific value, or by place,
00497           or from a site-wide policy.
00498 
00499         o Permission:  Public
00500         """
00501 

Here is the caller graph for this function:

def CMFCore.interfaces._tools.IDiscussionTool.overrideDiscussionFor (   content,
  allowDiscussion 
)
Links content to discussions.
Override discussability for the given object or clear the setting.

o 'allowDiscussion' may be True, False, or None.

o If 'allowDiscussion' is None, then clear any overridden setting for
  discussability, letting the site's default policy apply.

o Otherwise, set the override to match 'allowDiscussion'.

o Permission:  PUblic XXX?  Should be ManageContent, or something.

Definition at line 507 of file _tools.py.

00507 
00508     def overrideDiscussionFor(content, allowDiscussion):
00509         """ Override discussability for the given object or clear the setting.
00510 
00511         o 'allowDiscussion' may be True, False, or None.
00512 
00513         o If 'allowDiscussion' is None, then clear any overridden setting for
00514           discussability, letting the site's default policy apply.
00515 
00516         o Otherwise, set the override to match 'allowDiscussion'.
00517 
00518         o Permission:  PUblic XXX?  Should be ManageContent, or something.
00519         """
00520 
00521 
00522 #
00523 #   MemberData tool interfaces
#

Member Data Documentation

Initial value:
Attribute('id',
            """ The tool's ID.o BBB:  for use in 'getToolByName';  in the future, prefer  'zapi.getUtility(IDiscussionTool)'.o Must be set to 'portal_discussion'.""")
Links content to discussions.

Definition at line 473 of file _tools.py.


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