|
|
|||||
| Package com.dassault_systemes.enovwebsrvr.ews0infra.interfaces |
Interface ENOVIClientCommand
|
| Class Hierarchy |
com.dassault_systemes.enovwebsrvr.ews0infra.interfaces.ENOVIClientCommand
| Class Location |
| Class Description |
public interface ENOVIClientCommand
This interface provides methods for executing LCA single IDL commands.
| Field Summary |
| Constructor Summary |
| Method Summary |
| public boolean | execute()
Executes the command |
| public Boolean | getBooleanResult(String parmName)
Returns boolean command result |
| public byte[] | getByteArrayResult(String parmName)
Returns byte array command result |
| public String | getCommandName()
Get the command name |
| public Double | getDoubleResult(String parmName)
Returns double command result |
| public double[] | getDoubleResults(String parmName)
Returns double array command result |
| public Integer | getIntegerResult(String parmName)
Returns integer command result |
| public int[] | getIntegerResults(String parmName)
Returns integer array command result |
| public ENOVIServerMessage[] | getMessages()
Gets any message created as a result of executing the command |
| public ENOVIDataObject | getObjectResult(String parmName)
Calls "getObjectResult" with the read mask |
| public ENOVIDataObject | getObjectResult(String parmName, ENOVTypeMask mask)
Returns data object for the given result parameter |
| public ENOVIDataObject[] | getObjectResults(String parmName)
Calls "getObjectResults" with the read mask |
| public ENOVIDataObject[] | getObjectResults(String parmName, ENOVTypeMask mask)
Returns list of data objects for the given result parameter |
| public String | getStringResult(String parmName)
Returns command result |
| public String[] | getStringResults(String parmName)
Returns string array command result |
| public void | setParameter(String parmName, boolean parmValue)
Sets command parameter |
| public void | setParameter(String parmName, byte[] parmValue)
Sets command parameter |
| public void | setParameter(String parmName, double parmValue)
Sets command parameter |
| public void | setParameter(String parmName, double[] parmValue)
Sets command parameter |
| public void | setParameter(String parmName, ENOVIDataObject parmValue)
Calls "setParameter" passing true for uuidOnly parameter because in most cases there is no need to send entire object (e.g. |
| public void | setParameter(String parmName, ENOVIDataObject[] parmValue)
Calls "setParameter" passing true for uuidOnly parameter because in most cases there is no need to send entire object (e.g. |
| public void | setParameter(String parmName, ENOVIDataObject[] parmValue, boolean uuidOnly)
Sets command parameter. |
| public void | setParameter(String parmName, ENOVIDataObject parmValue, boolean uuidOnly)
Sets command parameter. |
| public void | setParameter(String parmName, int parmValue)
Sets command parameter |
| public void | setParameter(String parmName, int[] parmValue)
Sets command parameter |
| public void | setParameter(String parmName, String parmValue)
Sets command parameter |
| public void | setParameter(String parmName, String[] parmValue)
Sets command parameter |
| public void | setUUIDParameter(String parmName, String iUUID)
Sets command parameter |
| public void | setUUIDParameter(String parmName, String[] iUUIDs)
Sets command parameter |
| Field Detail |
| Constructor Detail |
| Method Detail |
public boolean execute()
Executes the command
public Boolean getBooleanResult(String parmName)
Returns boolean command result
parmName
public byte[] getByteArrayResult(String parmName)
Returns byte array command result
parmName
public String getCommandName()
Get the command name
public Double getDoubleResult(String parmName)
Returns double command result
parmName
public double[] getDoubleResults(String parmName)
Returns double array command result
parmName
public Integer getIntegerResult(String parmName)
Returns integer command result
parmName
public int[] getIntegerResults(String parmName)
Returns integer array command result
parmName
public ENOVIServerMessage[] getMessages()
Gets any message created as a result of executing the command
public ENOVIDataObject getObjectResult(String parmName)
Calls "getObjectResult" with the read mask
public ENOVIDataObject getObjectResult(String parmName, ENOVTypeMask mask)
Returns data object for the given result parameter
parmNamemask
public ENOVIDataObject[] getObjectResults(String parmName)
Calls "getObjectResults" with the read mask
public ENOVIDataObject[] getObjectResults(String parmName, ENOVTypeMask mask)
Returns list of data objects for the given result parameter
parmNamemask
public String getStringResult(String parmName)
Returns command result
parmName
public String[] getStringResults(String parmName)
Returns string array command result
parmName
public void setParameter(String parmName, boolean parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, byte[] parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, double parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, double[] parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, ENOVIDataObject parmValue)
Calls "setParameter" passing true for uuidOnly parameter because in most
cases there is no need to send entire object (e.g. only update)
public void setParameter(String parmName, ENOVIDataObject[] parmValue)
Calls "setParameter" passing true for uuidOnly parameter because in most
cases there is no need to send entire object (e.g. only update)
public void setParameter(String parmName, ENOVIDataObject[] parmValue, boolean uuidOnly)
Sets command parameter.
When uuidOnly is true, only the uuid of the data object will be transmitted
to the LCA server during command execution (for performance).
parmNameparmValueuuidOnly
public void setParameter(String parmName, ENOVIDataObject parmValue, boolean uuidOnly)
Sets command parameter.
When uuidOnly is true, only the uuid of the data object will be transmitted
to the LCA server during command execution (for performance)
parmNameparmValueuuidOnly
public void setParameter(String parmName, int parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, int[] parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, String parmValue)
Sets command parameter
parmNameparmValue
public void setParameter(String parmName, String[] parmValue)
Sets command parameter
parmNameparmValue
public void setUUIDParameter(String parmName, String iUUID)
Sets command parameter
parmNameparmValue
public void setUUIDParameter(String parmName, String[] iUUIDs)
Sets command parameter
parmNameparmValue