com.simplifiedlogic.nitro.jlink.data

Class AbstractJLISession

java.lang.Object

com.simplifiedlogic.nitro.jlink.data.AbstractJLISession

Direct Known Subclasses:

JLISession

public abstract class AbstractJLISession
extends java.lang.Object

Abstract class representing a JShell session object.

Constructor Summary

Constructors

Constructor and Description
AbstractJLISession()

Method Summary

Methods

Modifier and Type	Method and Description
abstract java.lang.String	getConnectionId() Get the Creo connection ID; create a connection to Creo if one does not exist.
abstract int	getProeVersion() Get the Creo version value
abstract java.lang.String	getSessionId() Get the session's ID
abstract boolean	logCommand(java.util.Map<java.lang.Object,java.lang.Object> cmd) When a function is executed, this function will write the request to a command log file
abstract boolean	logReturn(java.util.Map<java.lang.Object,java.lang.Object> cmd) When a function is executed, this function will write the response data to a command log file
abstract void	setConnectionId(java.lang.String connId) Get the Creo connection ID
abstract void	setProeVersion(int proeVersion) Set the Creo version value

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractJLISession

public AbstractJLISession()

Method Detail

logCommand

public abstract boolean logCommand(java.util.Map<java.lang.Object,java.lang.Object> cmd)

When a function is executed, this function will write the request to a command log file

Parameters:

cmd - The generic request structure

Returns:

Whether the write occurred successfully

logReturn

public abstract boolean logReturn(java.util.Map<java.lang.Object,java.lang.Object> cmd)

When a function is executed, this function will write the response data to a command log file

Parameters:

cmd - The generic response structure

Returns:

Whether the write occurred successfully

getSessionId

public abstract java.lang.String getSessionId()

Get the session's ID

Returns:

The session ID

getConnectionId

public abstract java.lang.String getConnectionId()
                                          throws JLIException

Get the Creo connection ID; create a connection to Creo if one does not exist.

Returns:

The Creo connection ID

Throws:

JLIException

setConnectionId

public abstract void setConnectionId(java.lang.String connId)

Get the Creo connection ID

Parameters:

connId - The Creo connection ID

getProeVersion

public abstract int getProeVersion()

Get the Creo version value

Returns:

The Creo version value

setProeVersion

public abstract void setProeVersion(int proeVersion)

Set the Creo version value

Parameters:

proeVersion - The Creo version value