Package wt.ixb.clientAccess

Class ObjectExportParameters

java.lang.Object

wt.ixb.clientAccess.ExportImportParameters

wt.ixb.clientAccess.ObjectExportParameters

All Implemented Interfaces:

Externalizable, Serializable

public class ObjectExportParameters
extends ExportImportParameters

Export parameters used as parameter to perform export operation using Windchill Import/Export framework. This object acts as encapsulated information required for execution of export. It contains many APIs which are internal to framework. Use only those APIs which are explicitly marked as supported for customization.

Supported API: true

Extendable: true

See Also:

• Serialized Form

Field Summary

Fields inherited from class wt.ixb.clientAccess.ExportImportParameters

X10_EXTERNALIZATION_VERSION_UID

Constructor Summary

Constructors

Constructor	Description
ObjectExportParameters()

Method Summary

Modifier and Type	Method	Description
String	getClientFileName()	Gets the value of the attribute: clientFileName; The file name (including its path) for storing export results.
ObjectSetFilterInfo[]	getFilters()	Gets the value of the attribute: filters;
ObjectSetGeneratorInfo[]	getGenerators()	Gets the value of the attribute: generators;
WTKeyedMap	getSelectedObjContentFilterMap()	Returns the collection of content filter of ObjectReference to ContentFilter.
void	setClientFileName(String aClientFileName)	Sets the value of the attribute: clientFileName; The file name (including its path) for storing export results.
void	setCollection(WTCollection collection)	WTCollection to be exported
void	setFilters(ObjectSetFilterInfo[] aFilters)	Sets the value of the attribute: filters;
void	setGenerators(ObjectSetGeneratorInfo[] aGenerators)	Sets the value of the attribute: generators;
void	setJarInJarFlag(boolean aJarInJarFlag)	Sets the value of the attribute: jarInJarFlag; Clients of IXStandard service should set this flag, if jar in jar functionality is required.
void	setSelectedObjContentFilterMap(WTKeyedMap selectedObjContentFilterMap)	Sets the collection of content filter which needs to be applied while exporting objects.

Methods inherited from class wt.ixb.clientAccess.ExportImportParameters

getActionName, getContainer, getContextData, getDtd, getFormatType, getGuiId, getIXFormatType, getLocale, getPolicyFile, getRuleFile, isDetailedLog, isPreviewOnly, isValidation, readVersion, setActionName, setContainer, setContextData, setDetailedLog, setDtd, setFormatType, setGuiId, setIXFormatType, setLocale, setPolicyFile, setPreviewOnly, setRuleFile, setValidation

Methods inherited from class java.lang.Object

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

Constructor Details

ObjectExportParameters

public ObjectExportParameters()
                       throws WTException

Throws:

WTException -
Supported API: true

Method Details

getClientFileName

public String getClientFileName()

Gets the value of the attribute: clientFileName; The file name (including its path) for storing export results.

Supported API: true

Returns:

setClientFileName

public void setClientFileName(String aClientFileName)
                       throws WTPropertyVetoException

Sets the value of the attribute: clientFileName; The file name (including its path) for storing export results.

Supported API: true

Parameters:

aClientFileName -

Throws:

WTPropertyVetoException

getGenerators

public ObjectSetGeneratorInfo[] getGenerators()

Gets the value of the attribute: generators;

Returns:

setGenerators

public void setGenerators(ObjectSetGeneratorInfo[] aGenerators)
                   throws WTPropertyVetoException

Sets the value of the attribute: generators;

Parameters:

aGenerators -

Throws:

WTPropertyVetoException

getFilters

public ObjectSetFilterInfo[] getFilters()

Gets the value of the attribute: filters;

Returns:

setFilters

public void setFilters(ObjectSetFilterInfo[] aFilters)
                throws WTPropertyVetoException

Sets the value of the attribute: filters;

Parameters:

aFilters -

Throws:

WTPropertyVetoException

setJarInJarFlag

public void setJarInJarFlag(boolean aJarInJarFlag)
                     throws WTPropertyVetoException

Sets the value of the attribute: jarInJarFlag; Clients of IXStandard service should set this flag, if jar in jar functionality is required. If the flag is set i.e. true, all top level objects will be exported in separate jars. Client will get a jar which includes jars of all the top level objects.

Supported API: true

Parameters:

aJarInJarFlag -

Throws:

WTPropertyVetoException

setCollection

public void setCollection(WTCollection collection)
                   throws WTPropertyVetoException

WTCollection to be exported

Parameters:

collection -

Throws:

WTPropertyVetoException - Supported API: true

getSelectedObjContentFilterMap

public WTKeyedMap getSelectedObjContentFilterMap()

Returns the collection of content filter of ObjectReference to ContentFilter. This provided the granularity of filtering content per object while export.

Supported API: true

Returns:

WTKeyedMap Collection of ObjectReference-to-ContentFilter

setSelectedObjContentFilterMap

public void setSelectedObjContentFilterMap(WTKeyedMap selectedObjContentFilterMap)

Sets the collection of content filter which needs to be applied while exporting objects. This provides the granularity to filter off or restrict export of content per object. This would take precedence over setGlobleContentFilter(GlobalContentFilterIfc).

Supported API: true

Parameters:

selectedObjContentFilterMap - Collection of ObjectReference-to-ContentFilter