Back to index

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

List of all members.

Public Member Functions

def getCatalogVariablesFor
def updateRoleMappingsFor
def listObjectActions
def listGlobalActions
def isActionSupported
def doActionFor
def isInfoSupported
def getInfoFor
def notifyCreated
def notifyBefore
def notifySuccess
def notifyException

Detailed Description

Plugin interface for workflow definitions managed by IWorkflowTool.

Definition at line 1798 of file _tools.py.


Member Function Documentation

def CMFCore.interfaces._tools.IWorkflowDefinition.doActionFor (   ob,
  action,
  comment = '' 
)
Perform the requested workflow action on a content object.

o 'ob' is the content object.

o 'action' is the ID of the requested workflow action.

o 'comment' is passed to the method corresponding to 'action'.

o Invoked by the portal_workflow tool.

o Allows the user to request a workflow action.

o This method must perform its own security checks.

o Permission:  Private (Python only)

Definition at line 1864 of file _tools.py.

01864 
01865     def doActionFor(ob, action, comment=''):
01866         """ Perform the requested workflow action on a content object.
01867 
01868         o 'ob' is the content object.
01869 
01870         o 'action' is the ID of the requested workflow action.
01871 
01872         o 'comment' is passed to the method corresponding to 'action'.
01873 
01874         o Invoked by the portal_workflow tool.
01875 
01876         o Allows the user to request a workflow action.
01877 
01878         o This method must perform its own security checks.
01879 
01880         o Permission:  Private (Python only)
01881         """

Plugin interface for workflow definitions managed by IWorkflowTool.
Return a mapping of attributes relevant to this workflow.

o Invoked by the workflow tool.

o Allows workflows to add variables to the catalog based on workflow
  status, making it possible to implement queues.

o Permission:  Private (Python only)

Definition at line 1803 of file _tools.py.

01803 
01804     def getCatalogVariablesFor(ob):
01805         """ Return a mapping of attributes relevant to this workflow.
01806 
01807         o Invoked by the workflow tool.
01808 
01809         o Allows workflows to add variables to the catalog based on workflow
01810           status, making it possible to implement queues.
01811 
01812         o Permission:  Private (Python only)
01813         """

Here is the caller graph for this function:

def CMFCore.interfaces._tools.IWorkflowDefinition.getInfoFor (   ob,
  name,
  default 
)
Return the requested workflow information for a content object.

o 'ob' is the content object.

o 'name' is the name of the requested workflow information.

o 'default' is returned if 'name' is not found.

o Invoked by the portal_workflow tool.

o This method must perform its own security checks.

o Permission:  Private (Python only)

Definition at line 1895 of file _tools.py.

01895 
01896     def getInfoFor(ob, name, default):
01897         """ Return the requested workflow information for a content object.
01898 
01899         o 'ob' is the content object.
01900 
01901         o 'name' is the name of the requested workflow information.
01902 
01903         o 'default' is returned if 'name' is not found.
01904 
01905         o Invoked by the portal_workflow tool.
01906 
01907         o This method must perform its own security checks.
01908 
01909         o Permission:  Private (Python only)
01910         """

Return True if the given workflow action is supported by this
    workfow for a content object, else False.

o 'ob' is the content object.

o 'action' is the ID of the requested workflow action.

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1851 of file _tools.py.

01851 
01852     def isActionSupported(ob, action, **kw):
01853         """ Return True if the given workflow action is supported by this
01854             workfow for a content object, else False.
01855 
01856         o 'ob' is the content object.
01857 
01858         o 'action' is the ID of the requested workflow action.
01859 
01860         o Invoked by the portal_workflow tool.
01861 
01862         o Permission:  Private (Python only)
01863         """

Return True if the given info name is supported by this workflow
    for a given content object, else False.

o 'ob' is the content object.

o 'name' is the name of the requested workflow information.

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1882 of file _tools.py.

01882 
01883     def isInfoSupported(ob, name):
01884         """ Return True if the given info name is supported by this workflow
01885             for a given content object, else False.
01886 
01887         o 'ob' is the content object.
01888 
01889         o 'name' is the name of the requested workflow information.
01890 
01891         o Invoked by the portal_workflow tool.
01892 
01893         o Permission:  Private (Python only)
01894         """

Return a sequence of IActionInformation defining workflow actions.

o 'info' is an ObjectActionInformation structure. XXX?

o Returned actions are "global", i.e. relevant to the user and  the
  site, rather than to any particular content object (this method is
  generally called on every request!)

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1837 of file _tools.py.

01837 
01838     def listGlobalActions(info):
01839         """ Return a sequence of IActionInformation defining workflow actions.
01840 
01841         o 'info' is an ObjectActionInformation structure. XXX?
01842 
01843         o Returned actions are "global", i.e. relevant to the user and  the
01844           site, rather than to any particular content object (this method is
01845           generally called on every request!)
01846 
01847         o Invoked by the portal_workflow tool.
01848 
01849         o Permission:  Private (Python only)
01850         """

Return a sequence of IActionInformation defining workflow actions.

o 'info' is an ObjectActionInformation structure. XXX?

o Returned actions are relevant to 'info.content' (this method is
  called only when this workflow is applicable to 'info.content').

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1824 of file _tools.py.

01824 
01825     def listObjectActions(info):
01826         """ Return a sequence of IActionInformation defining workflow actions.
01827 
01828         o 'info' is an ObjectActionInformation structure. XXX?
01829 
01830         o Returned actions are relevant to 'info.content' (this method is
01831           called only when this workflow is applicable to 'info.content').
01832 
01833         o Invoked by the portal_workflow tool.
01834 
01835         o Permission:  Private (Python only)
01836         """

Notification of a workflow action before it happens.

o 'ob' is the target object of the action.

o 'action' is a string identifying the impending action;
  usually it corresponds to a method name.

o This workflow may veto by raising WorkflowException.

o Unless some workflow raises WorkflowException is thrown,
  the workflow tool will emit either 'notifySuccess' or
  'notifyException' after the action.

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1924 of file _tools.py.

01924 
01925     def notifyBefore(ob, action):
01926         """ Notification of a workflow action before it happens.
01927 
01928         o 'ob' is the target object of the action.
01929 
01930         o 'action' is a string identifying the impending action;
01931           usually it corresponds to a method name.
01932 
01933         o This workflow may veto by raising WorkflowException.
01934 
01935         o Unless some workflow raises WorkflowException is thrown,
01936           the workflow tool will emit either 'notifySuccess' or
01937           'notifyException' after the action.
01938 
01939         o Invoked by the portal_workflow tool.
01940 
01941         o Permission:  Private (Python only)
01942         """

Notification that an object has been created and put in its place.

o 'ob' is the newly-created object.

o Invoked by the portal_workflow tool.

o The workflow may set initial workflow state, etc. for the new
  object.

o Permission:  Private (Python only)

Definition at line 1911 of file _tools.py.

01911 
01912     def notifyCreated(ob):
01913         """ Notification that an object has been created and put in its place.
01914 
01915         o 'ob' is the newly-created object.
01916 
01917         o Invoked by the portal_workflow tool.
01918 
01919         o The workflow may set initial workflow state, etc. for the new
01920           object.
01921 
01922         o Permission:  Private (Python only)
01923         """

Notifies this workflow that an action failed.

o 'ob' is the target object of the action.

o 'action' is a string identifying the failed action;
  usually it corresponds to a method name.

o 'exc' is the 'sys.exc_info' triple for the exception.

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1958 of file _tools.py.

01958 
01959     def notifyException(ob, action, exc):
01960         """ Notifies this workflow that an action failed.
01961 
01962         o 'ob' is the target object of the action.
01963 
01964         o 'action' is a string identifying the failed action;
01965           usually it corresponds to a method name.
01966 
01967         o 'exc' is the 'sys.exc_info' triple for the exception.
01968 
01969         o Invoked by the portal_workflow tool.
01970 
01971         o Permission:  Private (Python only)
01972         """
def CMFCore.interfaces._tools.IWorkflowDefinition.notifySuccess (   ob,
  action,
  result 
)
Notification that a workflow action has taken place.

o 'ob' is the target object of the action.

o 'action' is a string identifying the succesful action;
  usually it corresponds to a method name.

o 'result' is the return value from the method called.

o Invoked by the portal_workflow tool.

o Permission:  Private (Python only)

Definition at line 1943 of file _tools.py.

01943 
01944     def notifySuccess(ob, action, result):
01945         """ Notification that a workflow action has taken place.
01946 
01947         o 'ob' is the target object of the action.
01948 
01949         o 'action' is a string identifying the succesful action;
01950           usually it corresponds to a method name.
01951 
01952         o 'result' is the return value from the method called.
01953 
01954         o Invoked by the portal_workflow tool.
01955 
01956         o Permission:  Private (Python only)
01957         """

Here is the caller graph for this function:

Update the object permissions according to the current workflow
    state of 'ob'.

o Note that having the same permission(s) controlled by more than one
  workflow defintiion for an object results in undefined behavior.

o Permission:  Private (Python only)

Definition at line 1814 of file _tools.py.

01814 
01815     def updateRoleMappingsFor(ob):
01816         """ Update the object permissions according to the current workflow
01817             state of 'ob'.
01818 
01819         o Note that having the same permission(s) controlled by more than one
01820           workflow defintiion for an object results in undefined behavior.
01821 
01822         o Permission:  Private (Python only)
01823         """

Here is the caller graph for this function:


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