nxopen.report

Interface CommandBuilder

All Superinterfaces:

Builder, IComponentBuilder, Remote, TaggedObject

public interface CommandBuilder
extends Builder

Represents a CommandBuilder .
To create a new instance of this class, use CommandManager.createCommandBuilder(nxopen.report.CommandLibrary, nxopen.report.Command)

Created in NX11.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CommandBuilder.UserInputLocation Represents the user input location in command.

Method Summary

Modifier and Type	Method and Description
boolean	active() Returns a value that indicates whether the command is active or not.
BaseArgument	addArgument(BaseArgument.Type argumentType) Adds an argument and adds it to the command.
UserInput	addUserInput(CommandBuilder.UserInputLocation userInputLocation, UserInput.Type userInputType) Adds an user input and adds it to command.
String	displayName() Returns the command display name License requirements: None.
BaseArgument[]	getArguments() Gets all arguments in the command.
String[]	getHint() Gets the command hint License requirements: None.
String[]	getNamespaces() Gets the categories which command apply to.
UserInput[]	getUserInputs(CommandBuilder.UserInputLocation userInputLocation) Gets all user inputs.
void	moveUserInputs(CommandBuilder.UserInputLocation userInputLocation, UserInput[] pUserInputs, boolean isBeforeRefUserInput, UserInput pRefUserInputs) Moves the user inputs to the new position.
String	name() Returns the command name License requirements: None.
ProgramInformation	programInformation() Returns the automation program information object.
void	removeArguments(BaseArgument[] pArguments) Removes the arguments.
void	removeUserInputs(CommandBuilder.UserInputLocation userInputLocation, UserInput[] pUserInputs) Removes the user inputs.
void	setActive(boolean isActive) License requirements: None.
void	setDisplayName(String displayName) License requirements: None.
void	setHint(String[] commandHint) Sets the command hint License requirements: None.
void	setName(String commandName) License requirements: None.
void	setNamespaces(String[] pNamespaces) Sets the categories which command apply to.

Methods inherited from interface nxopen.Builder

commit, destroy, getCommittedObjects, getObject, showResults

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.geometricutilities.IComponentBuilder

validate

Method Detail

name

String name()
     throws NXException,
            RemoteException

Returns the command name
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setName

void setName(String commandName)
      throws NXException,
             RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

commandName -

Throws:

NXException

RemoteException

getHint

String[] getHint()
          throws NXException,
                 RemoteException

Gets the command hint
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setHint

void setHint(String[] commandHint)
      throws NXException,
             RemoteException

Sets the command hint
License requirements: None.

Created in NX11.0.0

Parameters:

commandHint -

Throws:

NXException

RemoteException

displayName

String displayName()
            throws NXException,
                   RemoteException

Returns the command display name
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setDisplayName

void setDisplayName(String displayName)
             throws NXException,
                    RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

displayName -

Throws:

NXException

RemoteException

active

boolean active()
        throws NXException,
               RemoteException

Returns a value that indicates whether the command is active or not.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setActive

void setActive(boolean isActive)
        throws NXException,
               RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

isActive -

Throws:

NXException

RemoteException

setNamespaces

void setNamespaces(String[] pNamespaces)
            throws NXException,
                   RemoteException

Sets the categories which command apply to.
License requirements: None.

Created in NX11.0.0

Parameters:

pNamespaces -

Throws:

NXException

RemoteException

getNamespaces

String[] getNamespaces()
                throws NXException,
                       RemoteException

Gets the categories which command apply to.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

addArgument

BaseArgument addArgument(BaseArgument.Type argumentType)
                  throws NXException,
                         RemoteException

Adds an argument and adds it to the command.
License requirements: None.

Created in NX11.0.0

Parameters:

argumentType -

Throws:

NXException

RemoteException

getArguments

BaseArgument[] getArguments()
                     throws NXException,
                            RemoteException

Gets all arguments in the command.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

removeArguments

void removeArguments(BaseArgument[] pArguments)
              throws NXException,
                     RemoteException

Removes the arguments.
License requirements: None.

Created in NX11.0.0

Parameters:

pArguments -

Throws:

NXException

RemoteException

addUserInput

UserInput addUserInput(CommandBuilder.UserInputLocation userInputLocation,
                       UserInput.Type userInputType)
                throws NXException,
                       RemoteException

Adds an user input and adds it to command.
License requirements: None.

Created in NX11.0.0

Parameters:

userInputLocation -

userInputType -

Throws:

NXException

RemoteException

getUserInputs

UserInput[] getUserInputs(CommandBuilder.UserInputLocation userInputLocation)
                   throws NXException,
                          RemoteException

Gets all user inputs.
License requirements: None.

Created in NX11.0.0

Parameters:

userInputLocation -

Throws:

NXException

RemoteException

removeUserInputs

void removeUserInputs(CommandBuilder.UserInputLocation userInputLocation,
                      UserInput[] pUserInputs)
               throws NXException,
                      RemoteException

Removes the user inputs.
License requirements: None.

Created in NX11.0.0

Parameters:

userInputLocation -

pUserInputs -

Throws:

NXException

RemoteException

moveUserInputs

void moveUserInputs(CommandBuilder.UserInputLocation userInputLocation,
                    UserInput[] pUserInputs,
                    boolean isBeforeRefUserInput,
                    UserInput pRefUserInputs)
             throws NXException,
                    RemoteException

Moves the user inputs to the new position.
License requirements: None.

Created in NX11.0.0

Parameters:

userInputLocation -

pUserInputs -

isBeforeRefUserInput -

pRefUserInputs - the target reference user input

Throws:

NXException

RemoteException

programInformation

ProgramInformation programInformation()
                               throws NXException,
                                      RemoteException

Returns the automation program information object.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException