com.filenet.wcm.apps.server.util
Class EProcessMultilingualUtil

java.lang.Object
  extended bycom.filenet.wcm.apps.server.util.EProcessMultilingualUtil

public class EProcessMultilingualUtil
extends java.lang.Object


Constructor Summary
EProcessMultilingualUtil(com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider eProcessDataProvider, java.util.Locale locale)
           
 
Method Summary
 java.lang.Object doCreateWorkflowTranslated(java.lang.String workflowIdentifier, java.lang.String subject, java.lang.String attachmentId)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's doCreateWorkflow method.
 java.lang.String[] fetchMapNamesTranslated(java.lang.String queueName, java.lang.String wobNum, boolean refresh)
           
 java.lang.String[] fetchUserQueueNamesTranslated(boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's fetchQueueNames method.
 org.w3c.dom.Document getDocumentFormTemplateAttachmentsXML(com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil, java.lang.String attachmentName)
          Get the list of document form template attachment items for the specified attachment name.
 java.lang.Object getLaunchedWorkflowsTranslated(boolean containsMilestones, boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getLaunchedWorkflows method.
 java.lang.String getLocalzedSubjectValue()
           
 java.lang.Object getMilestonesTranslated(int workSpaceId, int workClassId, java.lang.String workflowNumber, int level, boolean lastOnly, boolean reachedOnly)
           
 java.lang.Object getMilestonesTranslated(java.lang.String queueName, java.lang.String wobNum, int level, boolean lastOnly, boolean reachedOnly, boolean refresh)
           
 java.lang.Object getPublicQueuesTranslated(boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getPublicQueues method.
 java.lang.String getQueueAuthoredName(java.lang.String queueName)
           
 java.lang.Object getQueueElementsTranslated(java.lang.String queueName, java.lang.String queueType, int maxCount, java.lang.String[] dataFields, boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method.
 java.lang.Object getQueueElementsTranslated(java.lang.String queueName, java.lang.String queueType, java.lang.String indexName, java.lang.String filter, java.lang.Object[] substitutionVars, int maxCount, java.lang.String[] dataFields, boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method.
 java.lang.Object getQueueElementsTranslated(java.lang.String queueName, java.lang.String queueType, java.lang.String indexName, java.lang.String filter, java.lang.Object[] substitutionVars, int maxCount, java.lang.String[] dataFields, boolean refresh, java.lang.String stepName, java.lang.String operator)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method.
 filenet.vw.api.VWExposedFieldDefinition[] getQueueFieldDefinitionsTranslated(java.lang.String inboxName)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueFieldDefinitions method.
 java.lang.String getQueueLocalizeddName(java.lang.String authoredQueueName)
           
 java.lang.String getStepElementMapNameTranslated(java.lang.String queueName, java.lang.String wobNum)
           
 java.lang.Object getStepElementTranslated(boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getStepElement method.
 java.lang.Object getStepElementTranslated(java.lang.String queueName, java.lang.String wobNum, boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getPublicQueues method.
 java.lang.Object getStepElementTranslated(java.lang.String queueName, java.lang.String wobNum, boolean refresh, boolean lockItem)
           
 java.lang.Object getStepHistoryTranslated(java.lang.String queueName, java.lang.String wobNum, java.lang.String mapName, boolean refresh)
           
 java.lang.Object getStepProcessorInfoTranslated(boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getStepProcessorInfo method.
 java.lang.Object getUserQueuesTranslated(boolean refresh)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getUserQueues method.
 boolean setParameterValues(org.w3c.dom.Document xmlDoc, java.lang.String paramName, java.lang.String[] values)
           
 boolean setSelectedResponseTranslated(org.w3c.dom.Document xmlDoc, java.lang.String response)
          Set selected response in XML document.
 void setStepElementAttachmentsTranslated(boolean doSave)
          Set the modified attachment information into the StepElement parameters and save to the server.
 void setStepElementGeneralInfoTranslated(int processorType)
          Sets step element general info on workflow server.
 void setStepElementParametersTranslated(java.lang.String paramType)
          Set step element parameter values on workflow server
 void setTranslatedStepElementAttachments(org.w3c.dom.Document stepAttachmentsXML, boolean doSave)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementAttachments method.
 void setTranslatedStepElementGeneralInfo(int processorType)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementGeneralInfo method.
 void setTranslatedStepElementParameters(java.lang.String paramType)
          Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementParameters method.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

EProcessMultilingualUtil

public EProcessMultilingualUtil(com.filenet.wcm.toolkit.server.dp.WcmEProcessDataProvider eProcessDataProvider,
                                java.util.Locale locale)
Method Detail

getQueueFieldDefinitionsTranslated

public filenet.vw.api.VWExposedFieldDefinition[] getQueueFieldDefinitionsTranslated(java.lang.String inboxName)
                                                                             throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueFieldDefinitions method. After retrieval is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
inboxName - - the name of the queue from which to retrieve the VWQueueFieldDefinition objects.
Returns:
- an array of VWExposedFieldDefinition objects.
Throws:
java.lang.Exception

getStepProcessorInfoTranslated

public java.lang.Object getStepProcessorInfoTranslated(boolean refresh)
                                                throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getStepProcessorInfo method. After call to getStepProcessorInfo is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
refresh - - boolean argument specifying whether to retrieve fresh data (true) or attempt to use cached data (false)
Returns:
- An Object holding the XML string containing the collection information..
Throws:
java.lang.Exception

getQueueElementsTranslated

public java.lang.Object getQueueElementsTranslated(java.lang.String queueName,
                                                   java.lang.String queueType,
                                                   java.lang.String indexName,
                                                   java.lang.String filter,
                                                   java.lang.Object[] substitutionVars,
                                                   int maxCount,
                                                   java.lang.String[] dataFields,
                                                   boolean refresh)
                                            throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
queueName - String holding the queue name to retrive elements from.
queueType - String holding the queue type, User or Process.
indexName - String holding the index names used for sorting the query result.
filter - String Containins a SQL statement that specifies a filter conditions(used with values input to the substitutionVars parameter).
substitutionVars - An array of objects that contain the values to substitute for the variable names to the right of the colons in the SQL statement you passed to the filter parameter.
maxCount - Int holding how many elements must be retrieved into the element cache.
dataFields - String array holding the list of data fields to be returned as part of the queue element data.
refresh - Boolean flag that specifies the data retrival location.
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getQueueElementsTranslated

public java.lang.Object getQueueElementsTranslated(java.lang.String queueName,
                                                   java.lang.String queueType,
                                                   java.lang.String indexName,
                                                   java.lang.String filter,
                                                   java.lang.Object[] substitutionVars,
                                                   int maxCount,
                                                   java.lang.String[] dataFields,
                                                   boolean refresh,
                                                   java.lang.String stepName,
                                                   java.lang.String operator)
                                            throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
queueName - String holding the queue name to retrive elements from.
queueType - String holding the queue type, User or Process.
indexName - String holding the index names used for sorting the query result.
filter - String Containins a SQL statement that specifies a filter conditions(used with values input to the substitutionVars parameter).
substitutionVars - An array of objects that contain the values to substitute for the variable names to the right of the colons in the SQL statement you passed to the filter parameter.
maxCount - Int holding how many elements must be retrieved into the element cache.
dataFields - String array holding the list of data fields to be returned as part of the queue element data.
refresh - Boolean flag that specifies the data retrival location.
stepName - String holding the name of the step on which to apply a filter
operator - String holding the operator used by the stepName filter
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getQueueElementsTranslated

public java.lang.Object getQueueElementsTranslated(java.lang.String queueName,
                                                   java.lang.String queueType,
                                                   int maxCount,
                                                   java.lang.String[] dataFields,
                                                   boolean refresh)
                                            throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getQueueElements method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
queueName - String holding the queue name to retrive elements from.
queueType - String holding the queue type, User or Process.
maxCount - Int holding how many elements must be retrieved into the element cache.
dataFields - String array holding the list of data fields to be returned as part of the queue element data.
refresh - Boolean flag that specifies the data retrival location.
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getLaunchedWorkflowsTranslated

public java.lang.Object getLaunchedWorkflowsTranslated(boolean containsMilestones,
                                                       boolean refresh)
                                                throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getLaunchedWorkflows method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
containsMilestones - True to get workflows containing milestones; False to get workflows with or without milestones.
refresh - True to retrieve launched workflow XML from API; otherwise, fetch the in-memory copy.
Returns:
document object
Throws:
java.lang.Exception

fetchUserQueueNamesTranslated

public java.lang.String[] fetchUserQueueNamesTranslated(boolean refresh)
                                                 throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's fetchQueueNames method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
refresh - - boolean argument where true means to retrieve a fresh copy and false means attempt to retrieve cached data.
Returns:
string array of user queue names
Throws:
java.lang.Exception

getUserQueuesTranslated

public java.lang.Object getUserQueuesTranslated(boolean refresh)
                                         throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getUserQueues method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
refresh - - boolean argument where true means to retrieve a fresh copy and false means attempt to retrieve cached data.
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getPublicQueuesTranslated

public java.lang.Object getPublicQueuesTranslated(boolean refresh)
                                           throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getPublicQueues method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
refresh - - boolean argument where true means to retrieve a fresh copy and false means attempt to retrieve cached data.
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getStepElementTranslated

public java.lang.Object getStepElementTranslated(java.lang.String queueName,
                                                 java.lang.String wobNum,
                                                 boolean refresh)
                                          throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getPublicQueues method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
queueName - Queue Name
wobNum - Workflow object number
refresh - True to retrieve step element XML from VWStepElement; otherwise, fetch the in-memory copy
Returns:
document object
Throws:
java.lang.Exception

doCreateWorkflowTranslated

public java.lang.Object doCreateWorkflowTranslated(java.lang.String workflowIdentifier,
                                                   java.lang.String subject,
                                                   java.lang.String attachmentId)
                                            throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's doCreateWorkflow method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
workflowIdentifier - Visual WorkFlo version string
subject - Workflow subject from linker
attachmentId - Main workflow attachment
Returns:
XML document object
Throws:
java.lang.Exception

setTranslatedStepElementGeneralInfo

public void setTranslatedStepElementGeneralInfo(int processorType)
                                         throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementGeneralInfo method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
processorType - int the type of processor LAUNCH_PROCESSOR or STEP_PROCESSOR
Throws:
java.lang.Exception

setTranslatedStepElementParameters

public void setTranslatedStepElementParameters(java.lang.String paramType)
                                        throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementParameters method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
paramType - Specifies what type (alltypes, boolean, int, float, string, time, attachment, participant) of parameters to save
Throws:
java.lang.Exception

setTranslatedStepElementAttachments

public void setTranslatedStepElementAttachments(org.w3c.dom.Document stepAttachmentsXML,
                                                boolean doSave)
                                         throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that a reverse lookup is performed within the call to the data provider's setStepElementAttachments method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
stepAttachmentsXML - Document object holding the attachments information as XML
doSave - Boolean value indicates whether VWStepElement doSave method should be called. True only when in the Step Processor.
Throws:
java.lang.Exception

getStepElementTranslated

public java.lang.Object getStepElementTranslated(boolean refresh)
                                          throws java.lang.Exception
Sets the operating locale of the VWSession object within the eProcessDataProvider member variable to ensure that translated data is returned from the call to the data provider's getStepElement method. After call to getQueueElements is made, the operating locale of the VWSession is set back to null (no tranlsation). VWSession locale also set to null if an exception is encountered.

Parameters:
refresh - - boolean argument where true means to retrieve a fresh copy and false means attempt to retrieve cached data.
Returns:
Object holding the XML string containing the collection information.
Throws:
java.lang.Exception

getLocalzedSubjectValue

public java.lang.String getLocalzedSubjectValue()
                                         throws java.lang.Exception
Throws:
java.lang.Exception

getMilestonesTranslated

public java.lang.Object getMilestonesTranslated(java.lang.String queueName,
                                                java.lang.String wobNum,
                                                int level,
                                                boolean lastOnly,
                                                boolean reachedOnly,
                                                boolean refresh)
                                         throws java.lang.Exception
Throws:
java.lang.Exception

getMilestonesTranslated

public java.lang.Object getMilestonesTranslated(int workSpaceId,
                                                int workClassId,
                                                java.lang.String workflowNumber,
                                                int level,
                                                boolean lastOnly,
                                                boolean reachedOnly)
                                         throws java.lang.Exception
Throws:
java.lang.Exception

getStepElementMapNameTranslated

public java.lang.String getStepElementMapNameTranslated(java.lang.String queueName,
                                                        java.lang.String wobNum)
                                                 throws java.lang.Exception
Throws:
java.lang.Exception

getStepElementTranslated

public java.lang.Object getStepElementTranslated(java.lang.String queueName,
                                                 java.lang.String wobNum,
                                                 boolean refresh,
                                                 boolean lockItem)
                                          throws java.lang.Exception
Throws:
java.lang.Exception

fetchMapNamesTranslated

public java.lang.String[] fetchMapNamesTranslated(java.lang.String queueName,
                                                  java.lang.String wobNum,
                                                  boolean refresh)
                                           throws java.lang.Exception
Throws:
java.lang.Exception

getStepHistoryTranslated

public java.lang.Object getStepHistoryTranslated(java.lang.String queueName,
                                                 java.lang.String wobNum,
                                                 java.lang.String mapName,
                                                 boolean refresh)
                                          throws java.lang.Exception
Throws:
java.lang.Exception

setParameterValues

public boolean setParameterValues(org.w3c.dom.Document xmlDoc,
                                  java.lang.String paramName,
                                  java.lang.String[] values)
                           throws java.lang.Exception
Throws:
java.lang.Exception

setSelectedResponseTranslated

public boolean setSelectedResponseTranslated(org.w3c.dom.Document xmlDoc,
                                             java.lang.String response)
                                      throws java.lang.Exception
Set selected response in XML document.

Parameters:
xmlDoc - Document object
response - Selected response.
Returns:
boolean Whether the response has been changed (True = yes; current response is different that previous setting)
Throws:
java.lang.Exception - If there are problems retrieving data.

getQueueLocalizeddName

public java.lang.String getQueueLocalizeddName(java.lang.String authoredQueueName)
                                        throws java.lang.Exception
Throws:
java.lang.Exception

setStepElementAttachmentsTranslated

public void setStepElementAttachmentsTranslated(boolean doSave)
                                         throws java.lang.Exception
Set the modified attachment information into the StepElement parameters and save to the server.

Parameters:
doSave - Boolean value indicates whether VWStepElement doSave method should be called. True only when in the Step Processor.
Throws:
java.lang.Exception - If there are problems retrieving data.

setStepElementGeneralInfoTranslated

public void setStepElementGeneralInfoTranslated(int processorType)
                                         throws java.lang.Exception
Sets step element general info on workflow server.

Parameters:
processorType - int the type of processor LAUNCH_PROCESSOR or STEP_PROCESSOR
Throws:
java.lang.Exception - If there are problems retrieving data.

setStepElementParametersTranslated

public void setStepElementParametersTranslated(java.lang.String paramType)
                                        throws java.lang.Exception
Set step element parameter values on workflow server

Parameters:
paramType - Specifies what type (alltypes, boolean, int, float, string, time, attachment, participant) of parameters to save
Throws:
java.lang.Exception - If there are problems retrieving data.

getQueueAuthoredName

public java.lang.String getQueueAuthoredName(java.lang.String queueName)
                                      throws java.lang.Exception
Throws:
java.lang.Exception

getDocumentFormTemplateAttachmentsXML

public org.w3c.dom.Document getDocumentFormTemplateAttachmentsXML(com.filenet.wcm.toolkit.server.util.WcmEProcessUtil eProcessUtil,
                                                                  java.lang.String attachmentName)
                                                           throws java.lang.Exception
Get the list of document form template attachment items for the specified attachment name. The set of attachments are returned as XML using the Content Engine Java API namespace.

Parameters:
attachmentName - The Attachment name.
Returns:
Document The attachment items as XML loaded into org.w3c.dom.Document.
Throws:
java.lang.Exception - Thrown when there are errors.


© Copyright IBM Corp. 2002, 2007. All Rights Reserved.