public interface OptionsManager extends Remote
Session
Modifier and Type | Interface and Description |
---|---|
static class |
OptionsManager.ReorderSelectableStringListValueData
This class holds the data returned from
getReorderSelectableStringListValue(java.lang.String) |
Modifier and Type | Method and Description |
---|---|
String[] |
getAllOptions()
Gets the names of all available options.
|
int |
getIntValue(String name)
Gets the value of an
OptionType.INT option. |
int |
getIntValue(String name,
LevelType level)
Gets the value of an
OptionType.INT option at the specified level. |
boolean |
getLogicalValue(String name)
Gets the value of a
OptionType.LOGICAL option. |
boolean |
getLogicalValue(String name,
LevelType level)
Gets the value of a
OptionType.LOGICAL option at the specified level. |
OptionType |
getOptionType(String name)
Returns an option's type.
|
double |
getRealValue(String name)
Gets the value of a
OptionType.REAL option. |
double |
getRealValue(String name,
LevelType level)
Gets the value of a
OptionType.REAL option at the specified level. |
OptionsManager.ReorderSelectableStringListValueData |
getReorderSelectableStringListValue(String name)
Gets the value of a
OptionType.REORDER_SEL_LIST option. |
OptionsManager.ReorderSelectableStringListValueData |
getReorderSelectableStringListValue(String name,
LevelType level)
Gets the value of a
OptionType.REORDER_SEL_LIST option at the specified level. |
OptionsScope |
getScope(String name)
Returns scope of an option.
|
String[] |
getStringListValue(String name)
Gets the value of a
OptionType.STRING_LIST option. |
String[] |
getStringListValue(String name,
LevelType level)
Gets the value of a
OptionType.STRING_LIST option at the specified level. |
String |
getStringValue(String name)
Gets the value of a
OptionType.STRING option. |
String |
getStringValue(String name,
LevelType level)
Gets the value of a
OptionType.STRING option at the specified level. |
String |
getUserComment(String name,
LevelType level)
Returns then user comment at the specified level.
|
String |
getUtf8stringValue(String name)
Gets the value of a
OptionType.UTF8STRING option. |
String |
getUtf8stringValue(String name,
LevelType level)
Gets the value of a
OptionType.UTF8STRING option at the specified level. |
boolean |
isLevelLockedByDefault(LevelType level)
Returns true if the option's values at the specified level are locked by default.
|
boolean |
isValueLocked(String name,
LevelType level)
Returns true if the option value is locked at the specified level.
|
boolean |
isValueSet(String name,
LevelType level)
Returns true if the option value exists at the specified level.
|
ChangeList |
newOptionsChangeList(LevelType level,
LevelLockedByDefault lockedByDefault)
Creates an instance of
ChangeList class, in order to edit a set of options. |
DraftingStandardChangeList |
newOptionsDraftingStandardChangeList(LevelType level,
String filename)
Creates an instance of
DraftingStandardChangeList class, in order to edit a set of options. |
int getIntValue(String name) throws NXException, RemoteException
OptionType.INT
option.
Throws an error if option type is not OptionType.INT
.
name
- Option name.NXException
RemoteException
double getRealValue(String name) throws NXException, RemoteException
OptionType.REAL
option.
Throws an error if the option is not of type OptionType.REAL
.
name
- Option name.NXException
RemoteException
String getStringValue(String name) throws NXException, RemoteException
OptionType.STRING
option.
Throws an error if the option is not of type OptionType.STRING
.
name
- Option name.NXException
RemoteException
String getUtf8stringValue(String name) throws NXException, RemoteException
OptionType.UTF8STRING
option.
Throws an error if the option is not of type OptionType.UTF8STRING
.
name
- Option name.NXException
RemoteException
String[] getStringListValue(String name) throws NXException, RemoteException
OptionType.STRING_LIST
option.
Throws an error if the option is not of type OptionType.STRING_LIST
.
name
- Option name.NXException
RemoteException
OptionsManager.ReorderSelectableStringListValueData getReorderSelectableStringListValue(String name) throws NXException, RemoteException
OptionType.REORDER_SEL_LIST
option.
Throws an error if the option is not of type OptionType.REORDER_SEL_LIST
.
name
- Option name.NXException
RemoteException
boolean getLogicalValue(String name) throws NXException, RemoteException
OptionType.LOGICAL
option.
Throws an error if the option is not of type OptionType.LOGICAL
.
name
- Option name.NXException
RemoteException
int getIntValue(String name, LevelType level) throws NXException, RemoteException
OptionType.INT
option at the specified level.
Throws an error if the option is not of type OptionType.INT
.
name
- Option name.level
- Options level.NXException
RemoteException
double getRealValue(String name, LevelType level) throws NXException, RemoteException
OptionType.REAL
option at the specified level.
Throws an error if the option is not of type OptionType.REAL
.
name
- Option name.level
- Options level.NXException
RemoteException
String getStringValue(String name, LevelType level) throws NXException, RemoteException
OptionType.STRING
option at the specified level.
Throws an error if the option is not of type OptionType.STRING
.
name
- Option name.level
- Options level.NXException
RemoteException
String getUtf8stringValue(String name, LevelType level) throws NXException, RemoteException
OptionType.UTF8STRING
option at the specified level.
Throws an error if the option is not of type OptionType.STRING
.
name
- Option name.level
- Options level.NXException
RemoteException
String[] getStringListValue(String name, LevelType level) throws NXException, RemoteException
OptionType.STRING_LIST
option at the specified level.
Throws an error if the option is not of type OptionType.STRING_LIST
.
name
- Option name.level
- Options level.NXException
RemoteException
OptionsManager.ReorderSelectableStringListValueData getReorderSelectableStringListValue(String name, LevelType level) throws NXException, RemoteException
OptionType.REORDER_SEL_LIST
option at the specified level.
Throws an error if the option is not of type OptionType.REORDER_SEL_LIST
.
name
- Option name.level
- Options level.NXException
RemoteException
boolean getLogicalValue(String name, LevelType level) throws NXException, RemoteException
OptionType.LOGICAL
option at the specified level.
Throws an error if the option is not of type OptionType.LOGICAL
.
name
- Option name.level
- Options level.NXException
RemoteException
ChangeList newOptionsChangeList(LevelType level, LevelLockedByDefault lockedByDefault) throws NXException, RemoteException
ChangeList
class, in order to edit a set of options.
It is not possible to create an instance of ChangeList
for LevelType.SHIPPED
level,
or for a level that is not defined or is not writeable.
level
- Options level.lockedByDefault
- Specifies whether Options level is locked by default.
Ignored at LevelType.USER
level as locks at LevelType.USER
level are not supported.
If specified default lock status is different from the current one, then all exisitng locks are cleared.ChangeList
classNXException
RemoteException
DraftingStandardChangeList newOptionsDraftingStandardChangeList(LevelType level, String filename) throws NXException, RemoteException
DraftingStandardChangeList
class, in order to edit a set of options.
It is not possible to create an instance of DraftingStandardChangeList
for LevelType.SHIPPED
level,
or for a level that is not defined or is not writeable.
level
- Options level.filename
- Specifies the filename to save/save as.DraftingStandardChangeList
classNXException
RemoteException
String[] getAllOptions() throws NXException, RemoteException
NXException
RemoteException
boolean isValueLocked(String name, LevelType level) throws NXException, RemoteException
LevelType.USER
and LevelType.SHIPPED
levels.
name
- Option namelevel
- Options level.NXException
RemoteException
boolean isValueSet(String name, LevelType level) throws NXException, RemoteException
LevelType.SHIPPED
level.
name
- Option namelevel
- Options level.NXException
RemoteException
String getUserComment(String name, LevelType level) throws NXException, RemoteException
LevelType.SHIPPED
level.
name
- Option namelevel
- Options level.NXException
RemoteException
OptionType getOptionType(String name) throws NXException, RemoteException
name
- Option nameNXException
RemoteException
boolean isLevelLockedByDefault(LevelType level) throws NXException, RemoteException
level
- Options level.NXException
RemoteException
OptionsScope getScope(String name) throws NXException, RemoteException
name
- Option nameNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.