|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface WorklistSystemMBean
Defines management facilities for an instance of the Worklist system. This instance may be deployed as a system service or as an application module and be managed in the same way.
Method Summary | |
---|---|
void |
discardEditSession()
Discard any edits you've made since the previous call to startEditSession. |
void |
endEditSession()
Save any edits to a deployment plan, and redeploy the app to make the changes take effect. |
String |
getDefaultReportingDataSourceJndiName()
Get the JNDI name of the DataSource that hosts the database tables for the default reporting store for Worklist. |
Interval |
getDefaultTerminalTaskRetentionTime()
The length of time, expressed as a business calendar interval definition, that terminal tasks will be retained in the runtime store before they can be purged). |
EventHandler |
getEventHandler(String handlerName)
Get the EventHandler corresponding to a given name returned from a prior call to getEventHandlerNames. |
long |
getEventHandlerCount()
|
String[] |
getEventHandlerNames()
Get an array of names for all the event handlers being managed by this WorklistSystemMBean instance. |
String |
getHostApplicationName()
Get the name of the application that hosts this Worklist system instance. |
String |
getJavaMailSessionJndiName()
Gets the JNDI name of the JavaMail session to use by default for this Worklist system instance. |
long |
getPurgeInterval()
Get the number of seconds between automatic runs of the Worklist purge process. |
String |
getPurgeServerName()
Get the name of the server that is responsible for automatic runs of the Worklist purge process. |
String |
getRuntimeDataSourceJndiName()
Get the JNDI Name of the runtime data store for this Worklist system instance. |
TaskPlan |
getTaskPlan(String taskPlanId)
Get the TaskPlan corresponding to a given TaskPlanId returned from a prior call to getTaskPlanIds. |
long |
getTaskPlanCount()
|
TaskPlanId[] |
getTaskPlanIds()
Get an array of TaskPlanId for all the task plans being managed by this WorklistSystemMBean instance. |
long |
getVisibleTaskPlanHostApplicationNameCount()
|
String[] |
getVisibleTaskPlanHostApplicationNames()
Get an array of Strings representing the names of applications that host one or more task plans that have been deployed to this Worklist system instance. |
boolean |
isDefaultReportingStoreEnabled()
Get an indication of whether the Worklist default reporting store is enabled for this Worklist system instance. |
boolean |
isDirty()
Get an indication of whether any edits have been made to this MBean during the current edit session. |
boolean |
isEditSessionActive()
Check if a call to startEditSession has been made more recently than a call to either discardEditSession or endEditSession. |
boolean |
isRuntimeAccessAllowed()
Get an indication of whether runtime operations allowed. |
void |
purgeTasks()
Force an immediate run of the purge process for this Worklist system instance. |
void |
reassignWork(String oldUserId,
String newUserId,
boolean permanent)
Reassign the work for a given user to another designated user. |
void |
setDefaultReportingDataSourceJndiName(String jndiName)
Set the JNDI name of the DataSource that hosts the database tables for the default reporting store for Worklist. |
void |
setDefaultReportingStoreEnabled(boolean enabled)
Enable or disable the Worklist default reporting store. |
void |
setDefaultTerminalTaskRetentionTime(Interval interval)
Set the default length of time that terminal tasks will be retained in the runtime store before they can be purged. |
void |
setJavaMailSessionJndiName(String sessionJndiName)
Sets the JNDI name of the JavaMail session to use by default for this Worklist system instance. |
void |
setPurgeInterval(long seconds)
Set the number of seconds between automatic runs of the Worklist purge process. |
void |
setPurgeServerName(String serverName)
Set the server that is responsible for automatic runs of the Worklist purge process. |
void |
setRuntimeDataSourceJndiName(String jndiName)
Set the JNDI Name of the runtime data store for this Worklist system instance. |
void |
startEditSession()
Start a session in which you can edit Worklist system configuration, task plan configuration, etc. |
void |
updateEventHandler(String handlerXML)
Apply any edits made to a EventHandler between its being fetched from a call to getEventHandler() and the call to this method. |
void |
updateTaskPlan(String taskPlanId,
String taskPlanXML)
Apply any edits made to a TaskPlan between its being fetched from a call to getTaskPlan() and the call to this method. |
Method Detail |
---|
String getHostApplicationName()
String[] getVisibleTaskPlanHostApplicationNames() throws ManagementException
ManagementException
long getPurgeInterval()
void setPurgeInterval(long seconds)
seconds
- startEditSession()
String getPurgeServerName()
void setPurgeServerName(String serverName)
serverName
- startEditSession()
Interval getDefaultTerminalTaskRetentionTime()
void setDefaultTerminalTaskRetentionTime(Interval interval)
interval
- An Interval, or null to clear the default.String getJavaMailSessionJndiName()
setJavaMailSessionJndiName(String)
void setJavaMailSessionJndiName(String sessionJndiName)
startEditSession()
String getDefaultReportingDataSourceJndiName()
void setDefaultReportingDataSourceJndiName(String jndiName) throws ManagementException
jndiName
-
ManagementException
startEditSession()
String getRuntimeDataSourceJndiName()
startEditSession()
void setRuntimeDataSourceJndiName(String jndiName) throws ManagementException
ManagementException
startEditSession()
TaskPlanId[] getTaskPlanIds() throws ManagementException
ManagementException
startEditSession()
TaskPlan getTaskPlan(String taskPlanId) throws ManagementException
NOTE: You cannot add or remove child objects within the task plan via this method. This method is intended to allow the modification of environment specific information in the task plan, and not for wholesale editing of a task plan that has already been deployed. The supported edits are listed below.
taskPlanId
- The String value of the TaskPlanId taken from the
modified TaskPlan instance (via TaskPlanId.getStringValue())
before calling this method.
ManagementException
updateTaskPlan(String, String)
,
startEditSession()
void updateTaskPlan(String taskPlanId, String taskPlanXML) throws ManagementException
taskPlanId
- The String value of the TaskPlanId taken from the
modified TaskPlan instance (via TaskPlanId.getStringValue())
before calling this method.taskPlanXML
- The XML content for the TaskPlan that has been edited
and is now going to be applied to the running state of the
Worklist system instance. You can obtain this XML by calling
TaskPlan.writeToDescriptorStream() and then wrapping the
resulting bytes in a String. Make sure to use the same encoding
in both calls.
ManagementException
startEditSession()
,
TaskPlan.writeToDescriptorStream(java.io.OutputStream, String)
,
getTaskPlan(String)
String[] getEventHandlerNames() throws ManagementException
ManagementException
startEditSession()
EventHandler getEventHandler(String handlerName) throws ManagementException
handlerName
- The name of the handler to return.
ManagementException
updateEventHandler(String)
,
startEditSession()
void updateEventHandler(String handlerXML) throws ManagementException
handlerXML
- The XML content for the EventHandler
that has been edited and is now going to be applied to the running
state of the Worklist system instance. You can obtain this XML by
calling EventHandler.writeToDescriptorStream() and then wrapping
the resulting bytes in a String. Make sure to use the same
encoding in both calls.
ManagementException
startEditSession()
,
EventHandler.writeToDescriptorStream(java.io.OutputStream, String)
boolean isDefaultReportingStoreEnabled() throws ManagementException
ManagementException
void setDefaultReportingStoreEnabled(boolean enabled) throws ManagementException
enabled
- If true, the default reporting store will receive events
when tasks being managed by this Worklist system instance are
changed.
ManagementException
startEditSession()
boolean isRuntimeAccessAllowed() throws ManagementException
ManagementException
void reassignWork(String oldUserId, String newUserId, boolean permanent) throws ManagementException
ManagementException
startEditSession()
,
isRuntimeAccessAllowed()
void purgeTasks() throws ManagementException
ManagementException
isRuntimeAccessAllowed()
boolean isDirty()
void startEditSession() throws ManagementException
ManagementException
discardEditSession()
,
endEditSession()
boolean isEditSessionActive()
startEditSession()
void discardEditSession() throws ManagementException
ManagementException
startEditSession()
void endEditSession() throws ManagementException
ManagementException
startEditSession()
long getTaskPlanCount() throws ManagementException
ManagementException
long getEventHandlerCount() throws ManagementException
ManagementException
long getVisibleTaskPlanHostApplicationNameCount() throws ManagementException
ManagementException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |