Back to index

plone3  3.1.7
Public Member Functions
CMFCore.interfaces._content.IOldstyleDiscussable Class Reference
Inheritance diagram for CMFCore.interfaces._content.IOldstyleDiscussable:
Inheritance graph
[legend]
Collaboration diagram for CMFCore.interfaces._content.IOldstyleDiscussable:
Collaboration graph
[legend]

List of all members.

Public Member Functions

def createReply
def getReplyLocationAndID
def getReplyResults
def getReplies
def quotedContents

Detailed Description

Oldstyle discussable interface.

Definition at line 89 of file _content.py.


Member Function Documentation

def CMFCore.interfaces._content.IOldstyleDiscussable.createReply (   title,
  text,
  REQUEST,
  RESPONSE 
)
Oldstyle discussable interface.
Create a reply in the proper place.

o Returns: HTML (directly or via redirect) # XXX

o Permission: Reply to item

Definition at line 94 of file _content.py.

00094 
00095     def createReply(title, text, REQUEST, RESPONSE):
00096         """ Create a reply in the proper place.
00097 
00098         o Returns: HTML (directly or via redirect) # XXX
00099 
00100         o Permission: Reply to item
00101         """

Return a sequence of the DiscussionResponse objects which are
associated with this Discussable

Permissions: View
Returns: sequence of DiscussionResponses

Definition at line 135 of file _content.py.

00135 
00136     def getReplies():
00137         """
00138         Return a sequence of the DiscussionResponse objects which are
00139         associated with this Discussable
00140 
00141         Permissions: View
00142         Returns: sequence of DiscussionResponses
00143         """

This method determines where a user's reply should be stored, and
what it's ID should be.

You don't really want to force users to have to select a
unique ID each time they want to reply to something.  The
present implementation selects a folder in the Member's home
folder called 'Correspondence' (creating it if it is missing)
and finds a free ID in that folder.

createReply should use this method to determine what the reply
it creates should be called, and where it should be placed.

This method (and createReply, I expect) do not really belong in
this interface.  There should be a DiscussionManager singleton
(probably the portal object itself) which handles this.

Permissions: None assigned
Returns: 2-tuple, containing the container object, and a string ID.

Definition at line 102 of file _content.py.

00102 
00103     def getReplyLocationAndID(REQUEST):
00104         """
00105         This method determines where a user's reply should be stored, and
00106         what it's ID should be.
00107 
00108         You don't really want to force users to have to select a
00109         unique ID each time they want to reply to something.  The
00110         present implementation selects a folder in the Member's home
00111         folder called 'Correspondence' (creating it if it is missing)
00112         and finds a free ID in that folder.
00113 
00114         createReply should use this method to determine what the reply
00115         it creates should be called, and where it should be placed.
00116 
00117         This method (and createReply, I expect) do not really belong in
00118         this interface.  There should be a DiscussionManager singleton
00119         (probably the portal object itself) which handles this.
00120 
00121         Permissions: None assigned
00122         Returns: 2-tuple, containing the container object, and a string ID.
00123         """

Return the ZCatalog results that represent this object's replies.

Often, the actual objects are not needed.  This is less expensive
than fetching the objects.

Permissions: View
Returns: sequence of ZCatalog results representing DiscussionResponses

Definition at line 124 of file _content.py.

00124 
00125     def getReplyResults():
00126         """
00127         Return the ZCatalog results that represent this object's replies.
00128 
00129         Often, the actual objects are not needed.  This is less expensive
00130         than fetching the objects.
00131 
00132         Permissions: View
00133         Returns: sequence of ZCatalog results representing DiscussionResponses
00134         """

Return this object's contents in a form suitable for inclusion
as a quote in a response.  The default implementation returns
an empty string.  It might be overridden to return a '>' quoted
version of the item.

Definition at line 144 of file _content.py.

00144 
00145     def quotedContents():
00146         """
00147         Return this object's contents in a form suitable for inclusion
00148         as a quote in a response.  The default implementation returns
00149         an empty string.  It might be overridden to return a '>' quoted
00150         version of the item.
00151         """
00152 


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