Package wt.ixb.objectset

Interface ObjectSetHandler

All Known Subinterfaces:
ObjectSetFilter, ObjectSetGenerator
All Known Implementing Classes:
wt.ixb.objectset.handlers.navigator.GeneralNavigator, ObjectSetFilterTemplate, ObjectSetGeneratorTemplate, ObjectSetHandlerTemplate, WTTypeDefinitionNavigator
public interface ObjectSetHandler
This interface is the base for object set generators and filters (See ObjectSetGenerator and ObjectSetFilter.

Supported API: true

Extendable: true

  • Method Details

    • initialize

      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

      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

      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

      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

      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

      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

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

      Supported API: true
      Returns:
      String
      Throws:
      WTException

    • getLocalizedDescription

      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