|
|
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 |
String | getCommandName() |
void | setParameter(String parmName, ENOVIDataObject parmValue, boolean uuidOnly) |
void | setParameter(String parmName, ENOVIDataObject parmValue) |
void | setParameter(String parmName, ENOVIDataObject[] parmValue, boolean uuidOnly) |
void | setParameter(String parmName, ENOVIDataObject[] parmValue) |
void | setUUIDParameter(String parmName, String iUUID) |
void | setUUIDParameter(String parmName, String[] iUUIDs) |
void | setParameter(String parmName, String parmValue) |
void | setParameter(String parmName, int parmValue) |
void | setParameter(String parmName, double parmValue) |
void | setParameter(String parmName, boolean parmValue) |
void | setParameter(String parmName, String[] parmValue) |
void | setParameter(String parmName, int[] parmValue) |
void | setParameter(String parmName, double[] parmValue) |
void | setParameter(String parmName, byte[] parmValue) |
boolean | execute() |
ENOVIDataObject | getObjectResult(String parmName, ENOVTypeMask mask) |
ENOVIDataObject | getObjectResult(String parmName) |
ENOVIDataObject[] | getObjectResults(String parmName, ENOVTypeMask mask) |
ENOVIDataObject[] | getObjectResults(String parmName) |
String | getStringResult(String parmName) |
Integer | getIntegerResult(String parmName) |
Double | getDoubleResult(String parmName) |
Boolean | getBooleanResult(String parmName) |
byte[] | getByteArrayResult(String parmName) |
String[] | getStringResults(String parmName) |
int[] | getIntegerResults(String parmName) |
double[] | getDoubleResults(String parmName) |
ENOVIServerMessage[] | getMessages() |
Field Detail |
Constructor Detail |
Method Detail |
String getCommandName()Get the command name
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)
parmName
parmValue
uuidOnly
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)
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).
parmName
parmValue
uuidOnly
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)
void setUUIDParameter(String parmName, String iUUID)Sets command parameter
parmName
parmValue
void setUUIDParameter(String parmName, String[] iUUIDs)Sets command parameter
parmName
parmValue
void setParameter(String parmName, String parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, int parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, double parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, boolean parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, String[] parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, int[] parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, double[] parmValue)Sets command parameter
parmName
parmValue
void setParameter(String parmName, byte[] parmValue)Sets command parameter
parmName
parmValue
boolean execute()Executes the command
ENOVIDataObject getObjectResult(String parmName, ENOVTypeMask mask)Returns data object for the given result parameter
parmName
mask
ENOVIDataObject getObjectResult(String parmName)Calls "getObjectResult" with the read mask
ENOVIDataObject[] getObjectResults(String parmName, ENOVTypeMask mask)Returns list of data objects for the given result parameter
parmName
mask
ENOVIDataObject[] getObjectResults(String parmName)Calls "getObjectResults" with the read mask
String getStringResult(String parmName)Returns command result
parmName
Integer getIntegerResult(String parmName)Returns integer command result
parmName
Double getDoubleResult(String parmName)Returns double command result
parmName
Boolean getBooleanResult(String parmName)Returns boolean command result
parmName
byte[] getByteArrayResult(String parmName)Returns byte array command result
parmName
String[] getStringResults(String parmName)Returns string array command result
parmName
int[] getIntegerResults(String parmName)Returns integer array command result
parmName
double[] getDoubleResults(String parmName)Returns double array command result
parmName
ENOVIServerMessage[] getMessages()Gets any message created as a result of executing the command