Package com.dassault_systemes.enovwebsrvr.ews0infra.interfaces

   
Interface ENOVIClientCommand

 
Class Hierarchy
com.dassault_systemes.enovwebsrvr.ews0infra.interfaces.ENOVIClientCommand
Class Location

Framework : ENOVWebSrvr

Module : EWS0Infra

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

getCommandName

    String getCommandName()

Get the command name


setParameter

    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)

Parameters:
parmName
Parameter name
parmValue
Parameter value
uuidOnly

setParameter

    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)


setParameter

    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).

Parameters:
parmName
Parameter name
parmValue
Parameter value
uuidOnly

setParameter

    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)


setUUIDParameter

    void setUUIDParameter(String parmName, String iUUID)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Object UUID

setUUIDParameter

    void setUUIDParameter(String parmName, String[] iUUIDs)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Array of object UUID's

setParameter

    void setParameter(String parmName, String parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, int parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, double parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, boolean parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, String[] parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, int[] parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, double[] parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

setParameter

    void setParameter(String parmName, byte[] parmValue)

Sets command parameter

Parameters:
parmName
Parameter name
parmValue
Parameter value

execute

    boolean execute()

Executes the command


getObjectResult

    ENOVIDataObject getObjectResult(String parmName, ENOVTypeMask mask)

Returns data object for the given result parameter

Parameters:
parmName
Name of command output parameter
mask
the mask which the resulting object was returned
Returns:
data object for the given result parameter

getObjectResult

    ENOVIDataObject getObjectResult(String parmName)

Calls "getObjectResult" with the read mask


getObjectResults

    ENOVIDataObject[] getObjectResults(String parmName, ENOVTypeMask mask)

Returns list of data objects for the given result parameter

Parameters:
parmName
Name of command output parameter
mask
the mask which the resulting objects were returned
Returns:
list of data objects for the given result parameter

getObjectResults

    ENOVIDataObject[] getObjectResults(String parmName)

Calls "getObjectResults" with the read mask


getStringResult

    String getStringResult(String parmName)

Returns command result

Parameters:
parmName
Name of command output parameter
Returns:
string command result

getIntegerResult

    Integer getIntegerResult(String parmName)

Returns integer command result

Parameters:
parmName
Name of command output parameter
Returns:
integer command result

getDoubleResult

    Double getDoubleResult(String parmName)

Returns double command result

Parameters:
parmName
Name of command output parameter
Returns:
double command result

getBooleanResult

    Boolean getBooleanResult(String parmName)

Returns boolean command result

Parameters:
parmName
Name of command output parameter
Returns:
boolean command result

getByteArrayResult

    byte[] getByteArrayResult(String parmName)

Returns byte array command result

Parameters:
parmName
Name of command output parameter
Returns:
byte array command result

getStringResults

    String[] getStringResults(String parmName)

Returns string array command result

Parameters:
parmName
Name of command output parameter
Returns:
string array command result

getIntegerResults

    int[] getIntegerResults(String parmName)

Returns integer array command result

Parameters:
parmName
Name of command output parameter
Returns:
integer array command result

getDoubleResults

    double[] getDoubleResults(String parmName)

Returns double array command result

Parameters:
parmName
Name of command output parameter
Returns:
double array command result

getMessages

    ENOVIServerMessage[] getMessages()

Gets any message created as a result of executing the command



Copyright © 2000, Dassault Systèmes. All rights reserved