wt.ixb.objectset
Interface ObjectSetHandler

All Known Subinterfaces:

ObjectSetFilter, ObjectSetGenerator

All Known Implementing Classes:

ObjectSetFilterTemplate, ObjectSetGeneratorTemplate, ObjectSetHandlerTemplate

public interface ObjectSetHandler

This interface is the base for object set generators and filters (See ObjectSetGenerator and ObjectSetFilter.

Supported API: true

Extendable: true

Field Summary

static String	XML_TAG_DISPLAY
static String	XML_TAG_OBJECT_CREATOR_NAME
static String	XML_TAG_OBJECT_SET_CREATOR
static String	XML_TAG_OBJECT_SET_DIALOG_CLASS_NAME
static String	XML_TAG_OBJECT_SET_HANDLER_CREATOR
static String	XML_TAG_OBJECT_SET_HANDLER_FILTER
static String	XML_TAG_OBJECT_SET_HANDLER_GENERATOR
static String	XML_TAG_OBJECT_SET_HANDLER_HANDLER
static String	XML_TAG_OBJECT_SET_HANDLER_ID
static String	XML_TAG_OBJECT_SET_HANDLER_PARAMETERS
static String	XML_TAG_OBJECT_SET_LOCALIZED_DESCR
static String	XML_TAG_OBJECT_SET_LOCALIZED_MSG_CLASS
static String	XML_TAG_OBJECT_SET_LOCALIZED_MSG_KEY
static String	XML_TAG_OBJECT_SET_LOCALIZED_NAME

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.
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.
String	getParametersAsString() This method can be used only after setParametersAsString(String) is called.
void	initialize(IxbElement xmlDescription) Initialize this ObjectSetHandler instance.
void	setParametersAsString(String params) Save the value for this ObjectSetHandler instance.

Field Detail

XML_TAG_OBJECT_SET_HANDLER_ID

public static final String XML_TAG_OBJECT_SET_HANDLER_ID

See Also:

Constant Field Values

XML_TAG_DISPLAY

public static final String XML_TAG_DISPLAY

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_HANDLER_HANDLER

public static final String XML_TAG_OBJECT_SET_HANDLER_HANDLER

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_HANDLER_GENERATOR

public static final String XML_TAG_OBJECT_SET_HANDLER_GENERATOR

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_HANDLER_FILTER

public static final String XML_TAG_OBJECT_SET_HANDLER_FILTER

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_HANDLER_PARAMETERS

public static final String XML_TAG_OBJECT_SET_HANDLER_PARAMETERS

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_DIALOG_CLASS_NAME

public static final String XML_TAG_OBJECT_SET_DIALOG_CLASS_NAME

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_LOCALIZED_NAME

public static final String XML_TAG_OBJECT_SET_LOCALIZED_NAME

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_LOCALIZED_MSG_CLASS

public static final String XML_TAG_OBJECT_SET_LOCALIZED_MSG_CLASS

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_LOCALIZED_MSG_KEY

public static final String XML_TAG_OBJECT_SET_LOCALIZED_MSG_KEY

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_LOCALIZED_DESCR

public static final String XML_TAG_OBJECT_SET_LOCALIZED_DESCR

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_HANDLER_CREATOR

public static final String XML_TAG_OBJECT_SET_HANDLER_CREATOR

See Also:

Constant Field Values

XML_TAG_OBJECT_SET_CREATOR

public static final String XML_TAG_OBJECT_SET_CREATOR

See Also:

Constant Field Values

XML_TAG_OBJECT_CREATOR_NAME

public static final String XML_TAG_OBJECT_CREATOR_NAME

See Also:

Constant Field Values

Method Detail

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

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

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

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

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

Returns:

String

Throws:

WTException

setParametersAsString

public 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

Parameters:

params -

Throws:

WTException

getParametersAsString

public String getParametersAsString()
                             throws WTException

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

Supported API: true

Returns:

String

Throws:

WTException

getLocalizedDescription

public 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

Returns:

String

Throws:

WTException