Package wt.ixb.clientAccess
Class ObjectImportParameters
java.lang.Object
wt.ixb.clientAccess.ExportImportParameters
wt.ixb.clientAccess.ObjectImportParameters
- All Implemented Interfaces:
Externalizable,Serializable
Import parameters used as parameter to perform import operation using Windchill Import/Export framework.
This object acts as encapsulated information required for execution of import.
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
Supported API: true
Extendable: true
- See Also:
-
Constructor Summary
ConstructorsConstructorDescriptionInitialize the import parameters with default ImportContextData
Supported API: true -
Method Summary
Modifier and TypeMethodDescriptionGets the value of the attribute: containerMappingFile.* Gets the value of the attribute: dataFile; The data file (generally in *.jar format) containing meta data files and content data files for import.wt.facade.ixb.staging.IxbReadRepositoryGets the value of the attribute: repository;
Supported API: truebooleanGets the value of the attribute: lightPreviewOnly;
If this parameter is set to true, the preview will be done with common_attributes.booleanGets the value of the attribute: needContextMapping; check if context mapping is needed during import process.booleanGets the value of the attribute: overrideConflicts; Specify the overrideable conflicts will be overrided or not.voidsetContainerMappingFile(IXBCommonStreamer aContainerMappingFile) Sets the value of the attribute: containerMappingFile.voidsetDataFile(IXBCommonStreamer aDataFile) Sets the value of the attribute: dataFile; The data file (generally in *.jar format) containing meta data files and content data files for import.voidsetLightPreviewOnly(boolean aLightPreviewOnly) Sets the value of the attribute: lightPreviewOnly;
If this parameter is set to true, the preview will be done with common_attributes.voidsetNeedContextMapping(boolean needContextMapping) Sets the value of the attribute: needContextMapping; check if context mapping is needed during import process.voidsetOverrideConflicts(boolean aOverrideConflicts) Sets the value of the attribute: overrideConflicts; Specify the overrideable conflicts will be overrided or not.voidsetRepository(wt.facade.ixb.staging.IxbReadRepository repository) Sets the value of the attribute: repository;
Supported API: trueMethods inherited from class wt.ixb.clientAccess.ExportImportParameters
getActionName, getContextData, getDtd, getFormatType, getGuiId, getPolicyFile, getRuleFile, isPreviewOnly, isValidation, setActionName, setContainer, setDetailedLog, setDtd, setFormatType, setGuiId, setIXFormatType, setLocale, setPolicyFile, setPreviewOnly, setRuleFile, setValidation
-
Constructor Details
-
ObjectImportParameters
Initialize the import parameters with default ImportContextData
Supported API: true- Throws:
WTException
-
-
Method Details
-
getContainerMappingFile
Gets the value of the attribute: containerMappingFile.
Supported API: true- Returns:
- IXBCommonStreamer
-
setContainerMappingFile
public void setContainerMappingFile(IXBCommonStreamer aContainerMappingFile) throws WTPropertyVetoException Sets the value of the attribute: containerMappingFile.
Supported API: true- Parameters:
aContainerMappingFile-- Throws:
WTPropertyVetoException
-
isOverrideConflicts
public boolean isOverrideConflicts()Gets the value of the attribute: overrideConflicts; Specify the overrideable conflicts will be overrided or not.
Supported API: true- Returns:
-
setOverrideConflicts
Sets the value of the attribute: overrideConflicts; Specify the overrideable conflicts will be overrided or not.
Supported API: true- Parameters:
aOverrideConflicts-- Throws:
WTPropertyVetoException
-
getDataFile
* Gets the value of the attribute: dataFile; The data file (generally in *.jar format) containing meta data files and content data files for import.
Supported API: true- Returns:
-
setDataFile
Sets the value of the attribute: dataFile; The data file (generally in *.jar format) containing meta data files and content data files for import.
Supported API: true- Parameters:
aDataFile-- Throws:
WTPropertyVetoException
-
isNeedContextMapping
public boolean isNeedContextMapping()Gets the value of the attribute: needContextMapping; check if context mapping is needed during import process.
Supported API: true- Returns:
- IXBCommonStreamer
-
setNeedContextMapping
Sets the value of the attribute: needContextMapping; check if context mapping is needed during import process.
Supported API: true- Parameters:
needContextMapping-- Throws:
WTPropertyVetoException
-
setLightPreviewOnly
Sets the value of the attribute: lightPreviewOnly;
If this parameter is set to true, the preview will be done with common_attributes.
Supported API: true- Parameters:
aLightPreviewOnly-- Throws:
WTPropertyVetoException
-
isLightPreviewOnly
public boolean isLightPreviewOnly()Gets the value of the attribute: lightPreviewOnly;
If this parameter is set to true, the preview will be done with common_attributes.
Supported API: true- Returns:
- boolean
-
getRepository
public wt.facade.ixb.staging.IxbReadRepository getRepository()Gets the value of the attribute: repository;
Supported API: true- Returns:
- IxbReadRepository
-
setRepository
public void setRepository(wt.facade.ixb.staging.IxbReadRepository repository) Sets the value of the attribute: repository;
Supported API: true- Parameters:
repository-
-