wt.ixb.objectset.handlers.navigator
Class WTTypeDefinitionNavigator

java.lang.Object
  wt.ixb.objectset.ObjectSetHandlerTemplate
      wt.ixb.objectset.ObjectSetGeneratorTemplate
          wt.ixb.objectset.handlers.navigator.GeneralNavigator
              wt.ixb.objectset.handlers.navigator.WTTypeDefinitionNavigator

All Implemented Interfaces:

ObjectSetGenerator, ObjectSetHandler

public class WTTypeDefinitionNavigator
extends wt.ixb.objectset.handlers.navigator.GeneralNavigator

Object set navigator for type definitions (including user defined soft types and hard types). By default all of its parents, including modeled types, will be exported also.

Supported API: true

Extendable: false

Method Summary

boolean	canBeUsedAsTopLevelObject(Persistable obj) Only the LATEST iteration which is checked in can be used as seed objects.
Enumeration	findTopLevelObject(String[] searchParams) Find the type definitions whose names match the search parameter given the array of String.
String	getTopLevelObjectLocalizedImage(Persistable obj) Get the localized String displayable to the client for the given type definition.
static Enumeration	navigateFromWTTypeDefinitionToIBADefinition(Persistable obj) Find the associated IBA definitions which are required for export.

Methods inherited from class wt.ixb.objectset.ObjectSetGeneratorTemplate

getContainerRef, iteratePerPage, setConfigSpec, setContainerRef

Methods inherited from class wt.ixb.objectset.ObjectSetHandlerTemplate

getAppletClassName, getId, getLocalizedName, getLocalizedName

Methods inherited from class java.lang.Object

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

Methods inherited from interface wt.ixb.objectset.ObjectSetHandler

getAppletClassName, getId, getLocalizedName, getLocalizedName

Method Detail

getTopLevelObjectLocalizedImage

public String getTopLevelObjectLocalizedImage(Persistable obj)
                                       throws WTException

Get the localized String displayable to the client for the given type definition.


Supported API: true

Overrides:

getTopLevelObjectLocalizedImage in class wt.ixb.objectset.handlers.navigator.GeneralNavigator

Parameters:

obj -

Returns:

the full path of the type definition.

Throws:

WTException

canBeUsedAsTopLevelObject

public boolean canBeUsedAsTopLevelObject(Persistable obj)
                                  throws WTException

Only the LATEST iteration which is checked in can be used as seed objects. Deleted type definitions can not be used as seed objects. Return true if it can be used as a seed object.

Supported API: true

Overrides:

canBeUsedAsTopLevelObject in class wt.ixb.objectset.handlers.navigator.GeneralNavigator

Parameters:

obj - The heavy object type definition.

Returns:

boolean

Throws:

WTException

findTopLevelObject

public Enumeration findTopLevelObject(String[] searchParams)
                               throws WTException

Find the type definitions whose names match the search parameter given the array of String. The type definitions must be in the source container or its parent containers.

Supported API: true

Overrides:

findTopLevelObject in class wt.ixb.objectset.handlers.navigator.GeneralNavigator

Parameters:

searchParams - The size of the String array should be 1 (for the name of type definitions)

Returns:

Enumeration

Throws:

WTException

navigateFromWTTypeDefinitionToIBADefinition

public static Enumeration navigateFromWTTypeDefinitionToIBADefinition(Persistable obj)
                                                               throws WTException

Find the associated IBA definitions which are required for export.

Supported API: true

Parameters:

obj -

Returns:

Enumeration

Throws:

WTException