|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--TExportPackageICM.Options | +--TExportPackageICM.ImportOptions
This object specified the matrix of import options. It may be handed off to the import methods and may be modified by the tool as needed. This object is responsible for the full state of import options, including the constants, setting them, checking them, and possibly prompting the user.
Constructor Summary | |
TExportPackageICM.ImportOptions()
Create an ImportOptions object, initializing with defaults. |
|
TExportPackageICM.ImportOptions(java.lang.String iniFileName)
Create an ImportOptions object with the settings specified in the given configuration file. |
Method Summary | |
boolean |
getAnswer_isFileVersionWarning_exception(java.lang.String fileVersion)
Determines whether or not file version warning policy is set to throw exception. |
boolean |
getAnswer_isFileVersionWarning(int policySetting,
java.lang.String fileVersion)
Determines whether or not file version warning policy is set to the specified policy. |
boolean |
getAnswer_overwriteConfirm(com.ibm.mm.sdk.common.DKDDO existingDDO)
Get an answer for Overwrite Confirmation. |
int |
getAnswer_uniqueDetectionPolicy(java.lang.String itemDesc)
Get an answer for the Uniqueness Detection Policy. |
int |
getAnswer_versionGapHandling(java.lang.String itemid,
java.lang.String objectType,
java.lang.String lastVersion,
java.lang.String nextVersion)
Gets the Version Gap Handling Policy. |
int |
getConflictHandling()
Get the Conflict Handling Setting. |
int |
getFileVersionWarning()
Get the File Version Warning Policy. |
boolean |
getOverwriteConfirmEnable()
Determine if Overwrite Confirmation is enabled or not. |
java.lang.String |
getTrackingFileName()
Get the Import Operation Tracking File Name or 'null' if disabled. |
int |
getUniqueDetectionPolicy()
Get the Uniqueness Detection Policy. |
java.lang.String |
getUserSpecifiedUniqueAttr()
Get the User-Specified Unique Attr, if any. |
int |
getVersionGapHandling()
Get the Version Gap Handling Policy. |
int |
prompt_conflictHandling_noneFound(java.lang.String itemDesc)
If no items are found in the target system based on the uniqueness detection policy specified, this will prompt the user with the options available. |
java.lang.String |
prompt_userSpecifiedUniqueAttr(java.lang.String itemDesc,
java.lang.String autoDetectedList)
If no items are found in the target system based on the uniqueness detection policy specified, this will prompt the user with the options available. |
void |
read(java.lang.String iniFileName)
Read in settings in configuration file. |
void |
setConflictHandling(int policySetting)
Set Conflict Handling Setting. |
void |
setFileVersionWarning(int policySetting)
Set File Version Warning Policy. |
void |
setOverwriteConfirmEnable(boolean setting)
Enable or Disable Overwrite Confirmation for existing items upon import. |
void |
setTrackingFileName(java.lang.String trackingFileName)
Set or Disable Import Operation Tracking File Name. |
void |
setUniqueDetectionPolicy(int policySetting)
Set the Uniqueness Detection Policy. |
void |
setUserSpecifiedUniqueAttr(java.lang.String attrName)
Set the User-Specified Unique Attribute to use in the Uniqueness Detection Policy's 'USER_SPECIFIED' setting. |
void |
setVersionGapHandling(int policySetting)
Set Version Gap Handling Policy. |
java.lang.String |
toString()
Returns a string representation of this object. |
void |
write(java.lang.String iniFileName)
Write current settings to configuration file. |
Methods inherited from class TExportPackageICM.Options |
getPrintDebugEnable, getPrintTraceEnable, setPrintDebugEnable, setPrintTraceEnable |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
public TExportPackageICM.ImportOptions()
Create an ImportOptions object, initializing with defaults. For traceEnable and debugEnable defaults, please refer to the javadoc for Options(). Defaults: File Version Warning = TExportPackageICM.OPTION_FILE_VERSION_WARNING_EXCEPTION Version Gap Handling = TExportPackageICM.OPTION_VERSION_GAP_HANDLING_ENFORCE_NO_GAPS Conflict Handling = TExportPackageICM.OPTION_CONFLICTS_UNIQUE_THEN_NEW Unique Detection Policy = TExportPackageICM.OPTION_UNIQUENESS_DETECT_THEN_PROMPT User-Specified Unique Attr = null Overwrite Confirmation = false Tracking File Name = TExportPackageICM.OPTION_TRACKING_FILE_DEFAULT
public TExportPackageICM.ImportOptions(java.lang.String iniFileName) throws java.lang.Exception
iniFileName
- - Name of configuration file.Method Detail |
public int getConflictHandling()
public int getFileVersionWarning()
public java.lang.String getTrackingFileName()
public int getUniqueDetectionPolicy()
public java.lang.String getUserSpecifiedUniqueAttr()
public int getVersionGapHandling()
public boolean getAnswer_overwriteConfirm(com.ibm.mm.sdk.common.DKDDO existingDDO) throws java.io.IOException, java.lang.Exception
existingDDO
- - Existing DDO that is going to be overwritten.public int getAnswer_uniqueDetectionPolicy(java.lang.String itemDesc) throws java.io.IOException, java.lang.Exception
itemDesc
- - Item being imported.public boolean getAnswer_isFileVersionWarning(int policySetting, java.lang.String fileVersion) throws java.io.IOException, java.lang.Exception
policySetting
- - Policy Setting to check for.fileVersion
- - Actual File Version.public boolean getAnswer_isFileVersionWarning_exception(java.lang.String fileVersion) throws java.io.IOException, java.lang.Exception
fileVersion
- - Actual File Version.public int getAnswer_versionGapHandling(java.lang.String itemid, java.lang.String objectType, java.lang.String lastVersion, java.lang.String nextVersion) throws java.io.IOException, java.lang.Exception
itemId
- - Item ID of the item in question.objectType
- - Object Type of the item in question.lastVersion
- - Last Version.nextVersion
- - Next Version Found.public boolean getOverwriteConfirmEnable()
public int prompt_conflictHandling_noneFound(java.lang.String itemDesc) throws java.io.IOException, java.lang.Exception
itemDesc
- - Description of the item being imported.public java.lang.String prompt_userSpecifiedUniqueAttr(java.lang.String itemDesc, java.lang.String autoDetectedList) throws java.io.IOException, java.lang.Exception
itemDesc
- - Description of the item being imported.autoDetectedList
- - (Optional) List of auto-detected attributes that appear as good unique
constraints.public void setConflictHandling(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_CONFLICTS_ALWAYS_NEW:
TExportPackageICM.OPTION_CONFLICTS_UNIQUE_THEN_NEW:
TExportPackageICM.OPTION_CONFLICTS_UNIQUE_THEN_ERROR:
TExportPackageICM.OPTION_CONFLICTS_UNIQUE_THEN_SKIP:
TExportPackageICM.OPTION_CONFLICTS_UNIQUE_THEN_PROMPT:
public void setFileVersionWarning(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_FILE_VERSION_WARNING_EXCEPTION:
TExportPackageICM.OPTION_FILE_VERSION_WARNING_IGNORE:
TExportPackageICM.OPTION_FILE_VERSION_WARNING_PROMPT:
public void setTrackingFileName(java.lang.String trackingFileName) throws java.lang.Exception
trackingFileName
- - Desired import operation tracking file name or 'null'
to disable.public void setOverwriteConfirmEnable(boolean setting) throws java.lang.Exception
setting
- - True to enable Overwrite Confirmation, false to disable.public void setUniqueDetectionPolicy(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_UNIQUENESS_DETECT_THEN_ERROR:
TExportPackageICM.OPTION_UNIQUENESS_DETECT_THEN_PROMPT:
TExportPackageICM.OPTION_UNIQUENESS_USER_SPECIFIED:
TExportPackageICM.OPTION_UNIQUENESS_PROMPT:
public void setUserSpecifiedUniqueAttr(java.lang.String attrName)
attrName
- - Name of attribute on root level that uniquely identifies
items in the target system. It must exist on all Item Types
imported.public void setVersionGapHandling(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_VERSION_GAP_HANDLING_ENFORCE_NO_GAPS:
TExportPackageICM.OPTION_VERSION_GAP_HANDLING_ELIMINATE_GAPS:
TExportPackageICM.OPTION_VERSION_GAP_HANDLING_PROMPT:
public void read(java.lang.String iniFileName) throws java.lang.Exception
read
in class TExportPackageICM.Options
iniFileName
- - Name of configuration file.public java.lang.String toString()
toString
in class TExportPackageICM.Options
public void write(java.lang.String iniFileName) throws java.lang.Exception
write
in class TExportPackageICM.Options
iniFileName
- - Name of configuration file.
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |