osworkflow / docs / Utility_Functions.html

<html><head><title>OSWorkflow Utility Functions</title></head><body>
<ul class="star">
<li>Up to <a href="Documentation.html">Documentation</a></li>
<li>Back to <a href="BSF_Functions.html">BSF Functions</a></li>
<li>Forward to <a href="Validators.html">Validators</a></li>
</ul><p class="paragraph"></p>OSWorkflow comes with several very useful utility functions, all implementing the interface <i class="italic">com.opensymphony.workflow.FunctionProvider</i>. For more detailed information, please see the javadocs for these utility functions. Below is only a brief description of each utility function. All classes are found in the <i class="italic">com.opensymphony.workflow.util</i> package. 
<h3 class="heading-1">Caller
</h3><p class="paragraph"></p>Sets the persistent variable caller with the username of the person doing the current action.
<h3 class="heading-1">WebWorkExecutor
</h3><p class="paragraph"></p>Executes a WebWork function and restores the old ActionContext when finished.
<h3 class="heading-1">EJBInvoker
</h3><p class="paragraph"></p>Invokes an EJB session bean method. Please see the javadocs for more information about expected arguments and EJB restrictions.
<h3 class="heading-1">JMSMessage
</h3><p class="paragraph"></p>Sends a TextMessage to a JMS topic or queue.
<h3 class="heading-1">MostRecentOwner
</h3><p class="paragraph"></p>Sets the persistent variable <b class="bold">mostRecentOwner</b> with the username of the owner of the most recent step specified. Optional features allow for the variable be set to nothing if no owner is found, or to return with an internal error.
<h3 class="heading-1">ScheduleJob
</h3><p class="paragraph"></p>Schedules a <a href="trigger_function.html">trigger function</a> to be executed at some time later. Supports both <b class="bold">cron expressions</b> and <b class="bold">simple repeat/delay counts</b>. 
<h3 class="heading-1">UnschduleJob
</h3><p class="paragraph"></p>Deletes a scheduled job and all triggers associated with that job. This is useful in the case where the workflow state has changed such that you no longer wish for scheduled jobs to occur.
<h3 class="heading-1">SendEmail
</h3><p class="paragraph"></p>Sends out an email to one or more users.</body></html>
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.