Back to index

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

List of all members.

Public Member Functions

def listActionProviders
def addActionProvider
def deleteActionProvider
def listFilteredActionsFor

Static Public Attributes

tuple id

Detailed Description

Generate the list of "actions" which the user is allowed to perform.

o Synthesize this list from the actions managed by a set of "action
  providers".

Definition at line 27 of file _tools.py.


Member Function Documentation

Register an IActionProvider to the set queried by this tool.

o 'provider_name' is appended to the set of names already registered
  with the tool.

o Raise ComponentLookupError if no utility of that name is registered
  for IActionProvider.

o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
  (presuming either that ordering either doesn't matter or that
  ordering is supported by the utility registry).

o Permission:  Manage portal

Definition at line 57 of file _tools.py.

00057 
00058     def addActionProvider(provider_name):
00059         """ Register an IActionProvider to the set queried by this tool.
00060 
00061         o 'provider_name' is appended to the set of names already registered
00062           with the tool.
00063 
00064         o Raise ComponentLookupError if no utility of that name is registered
00065           for IActionProvider.
00066 
00067         o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
00068           (presuming either that ordering either doesn't matter or that
00069           ordering is supported by the utility registry).
00070 
00071         o Permission:  Manage portal
00072         """

Remove an IActionProvider from the set queried by this tool.

o Return silently if 'provider_name' is not already registered with
  the tool.

o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
  (presuming either that ordering either doesn't matter or that
  ordering is supported by the utility registry).

o Permission:  Manage portal

Definition at line 73 of file _tools.py.

00073 
00074     def deleteActionProvider(provider_name):
00075         """ Remove an IActionProvider from the set queried by this tool.
00076 
00077         o Return silently if 'provider_name' is not already registered with
00078           the tool.
00079 
00080         o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
00081           (presuming either that ordering either doesn't matter or that
00082           ordering is supported by the utility registry).
00083 
00084         o Permission:  Manage portal
00085         """

Return a sequence of names of all IActionProvider utilities
    registered with this tool.

o The returned list of names will be a subset of the set available
  via 'zapi.getUtilitiesFor(IActionProvider)' (which returns
  '(name, value)' tuples).

o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
  (presuming either that ordering either doesn't matter or that
  ordering is supported by the utility registry).

o Permission:  Manage portal

Definition at line 42 of file _tools.py.

00042 
00043     def listActionProviders():
00044         """ Return a sequence of names of all IActionProvider utilities
00045             registered with this tool.
00046 
00047         o The returned list of names will be a subset of the set available
00048           via 'zapi.getUtilitiesFor(IActionProvider)' (which returns
00049           '(name, value)' tuples).
00050 
00051         o Deprecated: In the future, expect to use 'getUtilitiesFor' instead
00052           (presuming either that ordering either doesn't matter or that
00053           ordering is supported by the utility registry).
00054 
00055         o Permission:  Manage portal
00056         """

Here is the caller graph for this function:

Map actions available to the user by category.

o Returned mapping will have category IDs as keys, and sequences
  of IActionInformation objects as the corresponding values for each
  category.

o Categories may be arbitrarily extended.

o Permission:  Public

Definition at line 86 of file _tools.py.

00086 
00087     def listFilteredActionsFor(object=None):
00088         """ Map actions available to the user by category.
00089 
00090         o Returned mapping will have category IDs as keys, and sequences
00091           of IActionInformation objects as the corresponding values for each
00092           category.
00093 
00094         o Categories may be arbitrarily extended.
00095 
00096         o Permission:  Public
00097         """
00098 


Member Data Documentation

Initial value:
Attribute('id',
            """ The ID of the tool.o Must be set to "portal_actions"""",
            )

Definition at line 35 of file _tools.py.


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