wt.ixb.objectset
Interface ObjectSetGenerator

All Superinterfaces:

ObjectSetHandler

All Known Implementing Classes:

ObjectSetGeneratorTemplate

public interface ObjectSetGenerator

extends ObjectSetHandler

This interface is the base for all object set generators. They will be used to compute the product structure for the given object. See the server registry for details.

Supported API: true

Extendable: true

Field Summary

Fields inherited from interface wt.ixb.objectset.ObjectSetHandler

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

Method Summary

WTContainerRef	getContainerRef() A convenient method to get the WTContainerRef context where the export is launched.
Enumeration	iterate() Iterate the product structure for export.
void	iterate(ObjectVisitor visitor) Iterate the product structure for export.
boolean	iteratePerPage(ObjectVisitor visitor, int pageSize) Iterate the product structure for export.
void	setConfigSpec(ConfigSpec configSpec) Set ConfigSpec for this object set generator.
void	setContainerRef(WTContainerRef containerRef) A convenient method to set the WTContainerRef context where the export is launched.

Methods inherited from interface wt.ixb.objectset.ObjectSetHandler

getAppletClassName, getId, getLocalizedDescription, getLocalizedName, getLocalizedName, getParametersAsString, initialize, setParametersAsString

Method Detail

iterate

public void iterate(ObjectVisitor visitor)
             throws WTException

Iterate the product structure for export.

Supported API: true

Parameters:

visitor -

Throws:

WTException

iterate

public Enumeration iterate()
                    throws WTException

Iterate the product structure for export.

Supported API: true

Returns:

Enumeration

Throws:

WTException

iteratePerPage

public boolean iteratePerPage(ObjectVisitor visitor,
                              int pageSize)
                       throws WTException

Iterate the product structure for export. If the number of objects iterated reaches the limit pageSize, do nothing and return.
This method returns true if the number of objects iterated is less than or equal to pageSize and does not need to iterate furthmore.

Supported API: true

Parameters:

visitor -

pageSize -

Returns:

boolean

Throws:

WTException

setContainerRef

public void setContainerRef(WTContainerRef containerRef)

A convenient method to set the WTContainerRef context where the export is launched.

Supported API: true

Parameters:

containerRef -

getContainerRef

public WTContainerRef getContainerRef()

A convenient method to get the WTContainerRef context where the export is launched.

Supported API: true

Returns:

WTContainerRef

setConfigSpec

public void setConfigSpec(ConfigSpec configSpec)

Set ConfigSpec for this object set generator. This is useful for some cases, especially when the ConfigSpec is not persisted and passed from client directly. Individual implementations of this interface are recommended to implement this method to satisfy their needs.

Supported API: true

Parameters:

configSpec -