nxopen.report

Interface BaseArgument

All Superinterfaces:

INXObject, Remote, TaggedObject

All Known Subinterfaces:

DoubleArgument, EnumerationArgument, IntegerArgument, StringArgument

public interface BaseArgument
extends TaggedObject, INXObject

Represents an abstract command argument.
Not support KF.

Created in NX11.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BaseArgument.Type Represents the argument type.

Method Summary

Modifier and Type	Method and Description
String	displayName() Returns the argument display name License requirements: None.
String	hint() Returns the argument hint.
boolean	optional() Returns a value that indicates whether this argument is optional or not.
void	setDisplayName(String displayName) License requirements: None.
void	setHint(String argumentHint) License requirements: None.
void	setOptional(boolean isOptional) License requirements: None.

Methods inherited from interface nxopen.TaggedObject

printTestData, printTestData, tag, tagValue

Methods inherited from interface nxopen.INXObject

findObject, isOccurrence, journalIdentifier, name, owningComponent, owningPart, print, prototype, setName

Method Detail

displayName

String displayName()
            throws NXException,
                   RemoteException

Returns the argument 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

hint

String hint()
     throws NXException,
            RemoteException

Returns the argument hint.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setHint

void setHint(String argumentHint)
      throws NXException,
             RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

argumentHint -

Throws:

NXException

RemoteException

optional

boolean optional()
          throws NXException,
                 RemoteException

Returns a value that indicates whether this argument is optional or not.
License requirements: None.

Created in NX11.0.0

Throws:

NXException

RemoteException

setOptional

void setOptional(boolean isOptional)
          throws NXException,
                 RemoteException

License requirements: None.

Created in NX11.0.0

Parameters:

isOptional -

Throws:

NXException

RemoteException