nxopen.options

Interface DraftingStandardChangeList

All Superinterfaces:

Remote, TransientObject

public interface DraftingStandardChangeList
extends TransientObject

Records changes to option values at the specified level.
A DraftingStandardChangeList is created with a given level, and all of the edit operations apply to that level for drafting standard defaults. Each method for setting a value throws an error if the option value is locked at a higher level, or the specified value is not valid.

All methods in this class use an option name as a unique identifier for accessing individual options and throw an error if an option with the given name is not found. All existing option names and their allowed values are described in the Online Documentation.

Use Options.OptionsManager#newOptionsDraftingStandardChangeList to create a new instance of this class

Created in NX5.0.0

Method Summary

Modifier and Type	Method and Description
LevelType	currentLevel() Returns the current level of options License requirements: None.
void	load() Load the drafting standard defaults at the current level.
void	lockValue(String name) Lock option value.
void	save() Saves the drafting standard defaults at the current level.
void	setUserComment(String name, String comment) Sets the user comment.
void	setUtf8Value(String name, String value) Sets the value of a Options.OptionType#UTF8STRING option.
void	setValue(String name, boolean value) Sets the value of a Options.OptionType#LOGICAL option.
void	setValue(String name, double value) Sets the value of a Options.OptionType#REAL option.
void	setValue(String name, int value) Sets the value of an Options.OptionType#INT option.
void	setValue(String name, String value) Sets the value of a Options.OptionType#STRING option.
void	setValue(String name, String[] value) Sets the value of a Options.OptionType#STRING_LIST option.
void	setValueOrder(String name, String[] value) Sets the value of a Options.OptionType#REORDER_SEL_LIST option for which the list entries can be reordered.
void	setValueSelection(String name, boolean[] selection, String[] value) Sets the value of a Options.OptionType#REORDER_SEL_LIST option for which the list entries can be reordered as well as selected.
void	unlockValue(String name) Unlock option value.

Methods inherited from interface nxopen.TransientObject

_value, dispose, printTestData, printTestData

Method Detail

currentLevel

LevelType currentLevel()
                throws NXException,
                       RemoteException

Returns the current level of options
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

setValue

void setValue(String name,
              int value)
       throws NXException,
              RemoteException

Sets the value of an Options.OptionType#INT option. If the option is of type Options.OptionType#REAL then the value parameter is converted to double. Throws an error if the option type is not Options.OptionType#INT or Options.OptionType#REAL .
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value - Option value.

Throws:

NXException

RemoteException

setValue

void setValue(String name,
              double value)
       throws NXException,
              RemoteException

Sets the value of a Options.OptionType#REAL option. Throws an error if the option type is not Options.OptionType#REAL .
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value - Option value.

Throws:

NXException

RemoteException

setValue

void setValue(String name,
              String value)
       throws NXException,
              RemoteException

Sets the value of a Options.OptionType#STRING option. Throws an error if the option type is not Options.OptionType#STRING .
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value - Option value
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

setUtf8Value

void setUtf8Value(String name,
                  String value)
           throws NXException,
                  RemoteException

Sets the value of a Options.OptionType#UTF8STRING option. Throws an error if the option type is not Options.OptionType#UTF8STRING .
License requirements: None.

Created in NX6.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value - Option value

Throws:

NXException

RemoteException

setValue

void setValue(String name,
              String[] value)
       throws NXException,
              RemoteException

Sets the value of a Options.OptionType#STRING_LIST option. Throws an error if the option type is not Options.OptionType#STRING_LIST .
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value -
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

setValueOrder

void setValueOrder(String name,
                   String[] value)
            throws NXException,
                   RemoteException

Sets the value of a Options.OptionType#REORDER_SEL_LIST option for which the list entries can be reordered. Throws an error if the option type is not Options.OptionType#REORDER_SEL_LIST .
License requirements: None.

Created in NX7.5.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value -
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

setValueSelection

void setValueSelection(String name,
                       boolean[] selection,
                       String[] value)
                throws NXException,
                       RemoteException

Sets the value of a Options.OptionType#REORDER_SEL_LIST option for which the list entries can be reordered as well as selected. Throws an error if the option type is not Options.OptionType#REORDER_SEL_LIST .
License requirements: None.

Created in NX7.5.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

selection - the selection bit

value -
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

setValue

void setValue(String name,
              boolean value)
       throws NXException,
              RemoteException

Sets the value of a Options.OptionType#LOGICAL option. Throws an error if the option type is not Options.OptionType#LOGICAL .
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

value - Option value

Throws:

NXException

RemoteException

setUserComment

void setUserComment(String name,
                    String comment)
             throws NXException,
                    RemoteException

Sets the user comment. Throws an error if the value does not exist at this level.
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name.
NOTE: The full Unicode character set is not supported for this parameter.

comment - User comment text.

Throws:

NXException

RemoteException

lockValue

void lockValue(String name)
        throws NXException,
               RemoteException

Lock option value.
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

unlockValue

void unlockValue(String name)
          throws NXException,
                 RemoteException

Unlock option value.
License requirements: None.

Created in NX5.0.0

Parameters:

name - Option name
NOTE: The full Unicode character set is not supported for this parameter.

Throws:

NXException

RemoteException

save

void save()
   throws NXException,
          RemoteException

Saves the drafting standard defaults at the current level.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException

load

void load()
   throws NXException,
          RemoteException

Load the drafting standard defaults at the current level.
License requirements: None.

Created in NX5.0.0

Throws:

NXException

RemoteException