Back to index

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

List of all members.

Public Member Functions

def listActions
def listActionInfos
def getActionInfo

Detailed Description

Objects that can be queried for actions.

Definition at line 99 of file _tools.py.


Member Function Documentation

def CMFCore.interfaces._tools.IActionProvider.getActionInfo (   action_chain,
  object = None,
  check_visibility = False,
  check_condition = False 
)
Return the first IActionInformation matching the given criteria.

o If no action is found matching the criteria, raise ValueError.

o 'action_chain' is a sequence of one or more action paths
  (e.g. 'object/view');  each path is formatted as
  'category_id/action_id'.  If specified, only matching actions will
  be returned, and in the given order (paths with no matches are
  ignored silently).

o If 'check_visibility' is True, return only actions whos "visible"
  flag is set.

o If 'check_condition' is True, return only actions whose condition
  expression evaluates True.

o Permission:  Public

Definition at line 141 of file _tools.py.

00141 
00142                       check_condition=False):
00143         """ Return the first IActionInformation matching the given criteria.
00144 
00145         o If no action is found matching the criteria, raise ValueError.
00146 
00147         o 'action_chain' is a sequence of one or more action paths
00148           (e.g. 'object/view');  each path is formatted as
00149           'category_id/action_id'.  If specified, only matching actions will
00150           be returned, and in the given order (paths with no matches are
00151           ignored silently).
00152 
00153         o If 'check_visibility' is True, return only actions whos "visible"
00154           flag is set.
00155 
00156         o If 'check_condition' is True, return only actions whose condition
00157           expression evaluates True.
00158 
00159         o Permission:  Public
00160         """
00161 

Here is the caller graph for this function:

def CMFCore.interfaces._tools.IActionProvider.listActionInfos (   action_chain = None,
  object = None,
  check_visibility = True,
  check_permissions = True,
  check_condition = True,
  max = None 
)
Return a sequence of IActionInformation matching the given criteria.

o 'action_chain' is a sequence of one or more action paths
  (e.g. 'object/view');  each path is formatted as
  'category_id/action_id'.  If specified, only matching actions will
  be returned, and in the given order (paths with no matches are
  ignored silently).

o If 'object' is specified, only actions specific to that object
  are included.

o If 'check_visibility' is True, return only actions whos "visible"
  flag is set.

o If 'check_permissions' is True, return only actions for whose
  permissions the current user is authorized.

o If 'check_condition' is True, return only actions whose condition
  expression evaluates True.

o If 'max' is specified, return only the first 'max' Actions.

o Permission:  Public (but not URL-publishable)

Definition at line 114 of file _tools.py.

00114 
00115                         check_permissions=True, check_condition=True, max=None):
00116         """ Return a sequence of IActionInformation matching the given criteria.
00117 
00118         o 'action_chain' is a sequence of one or more action paths
00119           (e.g. 'object/view');  each path is formatted as
00120           'category_id/action_id'.  If specified, only matching actions will
00121           be returned, and in the given order (paths with no matches are
00122           ignored silently).
00123 
00124         o If 'object' is specified, only actions specific to that object
00125           are included.
00126 
00127         o If 'check_visibility' is True, return only actions whos "visible"
00128           flag is set.
00129 
00130         o If 'check_permissions' is True, return only actions for whose
00131           permissions the current user is authorized.
00132 
00133         o If 'check_condition' is True, return only actions whose condition
00134           expression evaluates True.
00135 
00136         o If 'max' is specified, return only the first 'max' Actions.
00137 
00138         o Permission:  Public (but not URL-publishable)
00139         """

Here is the call graph for this function:

def CMFCore.interfaces._tools.IActionProvider.listActions (   info = None,
  object = None 
)
Objects that can be queried for actions.
List known action informations.

o Return a sequence of IActionInformation intances.

o Both the 'object' and the 'info' arguments are deprecated and
  ignored (use 'listActionInfos' to filter actions by context).

Definition at line 104 of file _tools.py.

00104 
00105     def listActions(info=None, object=None):
00106         """ List known action informations.
00107 
00108         o Return a sequence of IActionInformation intances.
00109 
00110         o Both the 'object' and the 'info' arguments are deprecated and
00111           ignored (use 'listActionInfos' to filter actions by context).
00112         """

Here is the caller graph for this function:


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