wt.ixb.objectset
Class ObjectSetHandlerTemplate

java.lang.Object
  wt.ixb.objectset.ObjectSetHandlerTemplate

All Implemented Interfaces:

ObjectSetHandler

Direct Known Subclasses:

ObjectSetFilterTemplate, ObjectSetGeneratorTemplate

public abstract class ObjectSetHandlerTemplate
extends Object
implements ObjectSetHandler

Class extends ObjectSetHandler interface with trivial implementations for most methods.- It can be used by application to make application less dependent of future extension of ObjectSetHandler interface.

Supported API: true

Extendable: false

Method Summary

String	getAppletClassName() Get the associated java class name which interacts with the client for this ObjectSetHandler type, e.g.
String	getId() Get the identifier of this ObjectSetHandler type.
abstract String	getLocalizedDescription() Get the localized description of this ObjectSetHandler instance.
String	getLocalizedName() Returns the localized name of the ObjectSetHandler type.
String	getLocalizedName(Locale locale) Returns the localized name of the ObjectSetHandler type for the specific Locale.
abstract String	getParametersAsString() This method can be used only after setParametersAsString(String) is called.
void	initialize(IxbElement xmlDescription) Initialize this ObjectSetHandler instance.
abstract void	setParametersAsString(String params) Save the value for this ObjectSetHandler instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

setParametersAsString

public abstract void setParametersAsString(String params)
                                    throws WTException

Save the value for this ObjectSetHandler instance. For example, for ObjectSetGenerator instance, this is the object identifier of the seed object.

Supported API: true

Specified by:

setParametersAsString in interface ObjectSetHandler

Parameters:

params -

Throws:

WTException

getParametersAsString

public abstract String getParametersAsString()
                                      throws WTException

This method can be used only after setParametersAsString(String) is called.

Supported API: true

Specified by:

getParametersAsString in interface ObjectSetHandler

Returns:

String

Throws:

WTException

getLocalizedDescription

public abstract String getLocalizedDescription()
                                        throws WTException

Get the localized description of this ObjectSetHandler instance. Usually it contains the localized information of this ObjectSetHandler type as well as the parameter set from setParametersAsString. The import/export will try to find the locale from the session context for localization purpose.
This method can be used only after setParametersAsString(String) is called.

Supported API: true

Specified by:

getLocalizedDescription in interface ObjectSetHandler

Returns:

String

Throws:

WTException

initialize

public void initialize(IxbElement xmlDescription)
                throws WTException

Initialize this ObjectSetHandler instance. Usually the parameter xmlDescription is corresponding to the XML files from server registry.

Supported API: true

Specified by:

initialize in interface ObjectSetHandler

Parameters:

xmlDescription - The information for initialize this ObjectSetHandler instance.

Throws:

WTException

getId

public String getId()
             throws WTException

Get the identifier of this ObjectSetHandler type. The identifier is specified in the server registry.

Supported API: true

Specified by:

getId in interface ObjectSetHandler

Returns:

String

Throws:

WTException

getLocalizedName

public String getLocalizedName()
                        throws WTException

Returns the localized name of the ObjectSetHandler type.
To get the localized name for the specific Locale, use the method getLocalizedName(Locale locale).

Supported API: true

Specified by:

getLocalizedName in interface ObjectSetHandler

Returns:

String

Throws:

WTException

getLocalizedName

public String getLocalizedName(Locale locale)
                        throws WTException

Returns the localized name of the ObjectSetHandler type for the specific Locale. Refer the server registry file for details.

Supported API: true

Specified by:

getLocalizedName in interface ObjectSetHandler

Parameters:

locale -

Returns:

String

Throws:

WTException

getAppletClassName

public String getAppletClassName()
                          throws WTException

Get the associated java class name which interacts with the client for this ObjectSetHandler type, e.g. wt.clients.ixb.exp.NavigatorSearchDialog. See the registry file for details.

Supported API: true

Specified by:

getAppletClassName in interface ObjectSetHandler

Returns:

String

Throws:

WTException