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

java.lang.Object
  extended byjava.lang.Throwable
      extended byjava.lang.Exception
          extended bycom.filenet.wcm.toolkit.util.WcmException
              extended bycom.filenet.wcm.apps.server.util.WorkplaceException
All Implemented Interfaces:
java.io.Serializable

public class WorkplaceException
extends com.filenet.wcm.toolkit.util.WcmException

WorkplaceException is a utility class to facilitate globalization by retrieving a localized error message from the resource file using the given key. This class extents WcmException object with additional attributes to identify which field causing problem.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class com.filenet.wcm.toolkit.util.WcmException
args, defaultLocale, key, returnUrl, rootException, status, STATUS_ERROR, STATUS_WARNING, targetException
 
Constructor Summary
WorkplaceException(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object[] arguments, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.util.Locale locale, java.lang.String aKey, java.lang.String engString, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.lang.String aKey, java.lang.String engString, java.lang.Object[] arguments, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.Object arg2, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.Object arg1, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.lang.String aKey, java.lang.String engString, java.lang.Object arg0, java.lang.String symName, java.lang.String propName)
          Constructor
WorkplaceException(java.lang.String aKey, java.lang.String engString, java.lang.String symName, java.lang.String propName)
          Constructor
 
Method Summary
 java.lang.String getPropertyName()
           
 java.lang.String getPropertySymName()
           
static java.lang.String getXML(java.util.List exceptions)
          return registered portlet list in XML format.
 void setPropertyName(java.lang.String propName)
           
 void setPropertySymName(java.lang.String symName)
           
 
Methods inherited from class com.filenet.wcm.toolkit.util.WcmException
getKey, getLocalizedMessage, getLocalizedMessage, getMessage, getReturnUrl, getStatus, getTargetException, loadResource, loadResource, printStackTrace, printStackTrace, printStackTrace, setReturnUrl, setStatus, setTargetException, toString, toString
 
Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getStackTrace, initCause, setStackTrace
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

WorkplaceException

public WorkplaceException(java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up a resource in the reource file.
engString - English version of resource string the application uses to generate the resource file.

WorkplaceException

public WorkplaceException(java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.Object arg1,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.
arg1 - Second argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.Object arg1,
                          java.lang.Object arg2,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.
arg1 - Second argument to apply when formatting the resource string.
arg2 - Third argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object[] arguments,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.

WorkplaceException

public WorkplaceException(java.util.Locale locale,
                          java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up a resource in the reource file.
engString - English version of resource string the application uses to generate the resource file.

WorkplaceException

public WorkplaceException(java.util.Locale locale,
                          java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.util.Locale locale,
                          java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.Object arg1,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.
arg1 - Second argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.util.Locale locale,
                          java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object arg0,
                          java.lang.Object arg1,
                          java.lang.Object arg2,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
arg0 - First argument to apply when formatting the resource string.
arg1 - Second argument to apply when formatting the resource string.
arg2 - Third argument to apply when formatting the resource string.

WorkplaceException

public WorkplaceException(java.util.Locale locale,
                          java.lang.String aKey,
                          java.lang.String engString,
                          java.lang.Object[] arguments,
                          java.lang.String symName,
                          java.lang.String propName)
Constructor

Parameters:
aKey - Key to use in looking up the specified resource string.
engString - English version of resource string the application uses to generate the resource file.
Method Detail

setPropertySymName

public void setPropertySymName(java.lang.String symName)

getPropertySymName

public java.lang.String getPropertySymName()

setPropertyName

public void setPropertyName(java.lang.String propName)

getPropertyName

public java.lang.String getPropertyName()

getXML

public static java.lang.String getXML(java.util.List exceptions)
                               throws java.lang.Exception
return registered portlet list in XML format.

Returns:
String registered portlet list in XML format.
Throws:
java.lang.Exception


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