|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--TExportPackageICM.Options | +--TExportPackageICM.ExportOptions
This object specifies the matrix of export options. It may be handed off to the export methods and may be modified by the tool as needed. This object is responsible for the full state of export options, including the constants, setting them, checking them, and possibly prompting the user.
Constructor Summary | |
TExportPackageICM.ExportOptions()
Create an ExportOptions object, initializing with defaults. |
|
TExportPackageICM.ExportOptions(java.lang.String iniFileName)
Create an ExportOptions object with the settings specified in the given configuration file. |
Method Summary | |
int |
getAnswer_folderContentPolicy(java.lang.String folderDesc,
java.lang.String contentItemVersionList)
Get an answer for the folder content export policy. |
boolean |
getAnswer_isSelectedItemPolicy_exportAll(java.lang.String versionList)
Determines whether the selected item export policy is set to the export all version of items directly selected. |
boolean |
getAnswer_isSelectedItemPolicy_exportSelected(java.lang.String versionList)
Determines whether the selected item export policy is set to the export only the latest version. |
boolean |
getAnswer_isSelectedItemPolicy(int policySetting,
java.lang.String versionList)
Determines whether the selected item export policy is set to the specified policy. |
int |
getAnswer_linkedItemsPolicy(java.lang.String mainItemDesc,
java.lang.String otherItemVersionList,
java.lang.String linkItemVersionList)
Get an answer for the linked items export policy. |
int |
getAnswer_refAttrValuePolicy(java.lang.String mainCompDesc,
java.lang.String refAttrName,
java.lang.String valueItemVersionList)
Get an answer for the reference attribute value export policy. |
int |
getFolderContentPolicy()
Get the Policy on exporting versions for folder contents. |
int |
getLinkedItemsPolicy()
Get the Policy on exporting versions for items reference in a link. |
int |
getRefAttrValuePolicy()
Get the Policy on exporting versions for items reference by reference attributes. |
int |
getSelectedItemPolicy()
Get the Policy on exporting versions of the items directly selected. |
boolean |
isFolderContentPolicy_promptAlways()
Determines whether the folder content export policy is set to always prompt the user. |
boolean |
isLinkedItemsPolicy_promptAlways()
Determines whether the linked itemsexport policy is set to always prompt the user. |
boolean |
isRefAttrValuePolicy_promptAlways()
Determines whether the reference attribute value export policy is set to always prompt the user. |
void |
read(java.lang.String iniFileName)
Read in settings in configuration file. |
void |
setFolderContentPolicy(int policySetting)
Set Folder Content Export Policy. |
void |
setLinkedItemsPolicy(int policySetting)
Set Linked Items Export Policy. |
void |
setRefAttrValuePolicy(int policySetting)
Set RefAttr Value Export Policy. |
void |
setSelectedItemPolicy(int policySetting)
Set Selected Item Export 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.ExportOptions()
Create an ExportOptions object, initializing with defaults. For traceEnable and debugEnable defaults, please refer to the javadoc for Options(). Defaults: Selected Item Policy = TExportPackageICM.OPTION_SELECTED_ITEM_EXPORT_ALL_VERSIONS Folder Content Policy = TExportPackageICM.OPTION_FOLDER_CONTENT_EXPORT_ALL_VERSIONS Linked Items Policy = TExportPackageICM.OPTION_LINKED_ITEMS_EXPORT_ALL_VERSIONS RefAttr Value Policy = TExportPackageICM.OPTION_REFATTR_VALUE_EXPORT_ALL_VERSIONS
public TExportPackageICM.ExportOptions(java.lang.String iniFileName) throws java.lang.Exception
iniFileName
- - Name of configuration file.Method Detail |
public int getFolderContentPolicy()
public int getLinkedItemsPolicy()
public int getRefAttrValuePolicy()
public int getSelectedItemPolicy()
public int getAnswer_folderContentPolicy(java.lang.String folderDesc, java.lang.String contentItemVersionList) throws java.io.IOException, java.lang.Exception
folderDesc
- - Description of the folder that contains the content.contentItemVersionList
- - Listing of versions found to display.public int getAnswer_linkedItemsPolicy(java.lang.String mainItemDesc, java.lang.String otherItemVersionList, java.lang.String linkItemVersionList) throws java.io.IOException, java.lang.Exception
mainItemDesc
- - Description of the main item that holds this link.otherItemVersionList
- - Unselected Versions of Other item linked to, source if inbound, target if outbound.linkItemVersionList
- - Unselected Versions of Optional Description Item (Link Item).public int getAnswer_refAttrValuePolicy(java.lang.String mainCompDesc, java.lang.String refAttrName, java.lang.String valueItemVersionList) throws java.io.IOException, java.lang.Exception
mainCompDesc
- - Description of the component containing the reference attribute.refAttrName
- - Reference Attribute namevalueItemVersionList
- - Unselected Versions of the value item of the reference attribute.public boolean getAnswer_isSelectedItemPolicy(int policySetting, java.lang.String versionList) throws java.io.IOException, java.lang.Exception
policySetting
- - Policy Setting to check for.versionList
- - Listing of versions found to display.public boolean getAnswer_isSelectedItemPolicy_exportSelected(java.lang.String versionList) throws java.io.IOException, java.lang.Exception
versionList
- - Listing of versions found to display.public boolean getAnswer_isSelectedItemPolicy_exportAll(java.lang.String versionList) throws java.io.IOException, java.lang.Exception
versionList
- - Listing of versions found to display.public boolean isFolderContentPolicy_promptAlways() throws java.io.IOException, java.lang.Exception
public boolean isLinkedItemsPolicy_promptAlways() throws java.io.IOException, java.lang.Exception
public boolean isRefAttrValuePolicy_promptAlways() throws java.io.IOException, java.lang.Exception
public void setFolderContentPolicy(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_FOLDER_CONTENT_EXPORT_LATEST_VERSION:
TExportPackageICM.OPTION_FOLDER_CONTENT_EXPORT_ALL_VERSIONS:
TExportPackageICM.OPTION_FOLDER_CONTENT_REMOVE_VALUE:
TExportPackageICM.OPTION_FOLDER_CONTENT_PROMPT_IF_VERSIONS:
TExportPackageICM.OPTION_FOLDER_CONTENT_PROMPT_ALWAYS:
public void setLinkedItemsPolicy(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_LINKED_ITEMS_EXPORT_LATEST_VERSION:
TExportPackageICM.OPTION_LINKED_ITEMS_EXPORT_ALL_VERSIONS:
TExportPackageICM.OPTION_LINKED_ITEMS_REMOVE_LINK:
TExportPackageICM.OPTION_LINKED_ITEMS_PROMPT_IF_VERSIONS:
TExportPackageICM.OPTION_LINKED_ITEMS_PROMPT_ALWAYS:
public void setRefAttrValuePolicy(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_REFATTR_VALUE_EXPORT_REFERENCED_VERSION:
TExportPackageICM.OPTION_REFATTR_VALUE_EXPORT_ALL_VERSIONS:
TExportPackageICM.OPTION_REFATTR_VALUE_REMOVE_VALUE:
TExportPackageICM.OPTION_REFATTR_VALUE_PROMPT_IF_VERSIONS:
TExportPackageICM.OPTION_REFATTR_VALUE_PROMPT_ALWAYS:
public void setSelectedItemPolicy(int policySetting) throws java.lang.Exception
policySetting
- - Policy options are: TExportPackageICM.OPTION_SELECTED_ITEM_EXPORT_SELECTED_VERSION:
TExportPackageICM.OPTION_SELECTED_ITEM_EXPORT_ALL_VERSIONS:
TExportPackageICM.OPTION_SELECTED_ITEM_PROMPT_IF_VERSIONS:
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 |