gov.va.med.vistalink.security.m

Class SecurityVOSetupAndIntroText

Object

SecurityVO

SecurityVOSetupAndIntroText

public final class SecurityVOSetupAndIntroText
extends SecurityVO

Logon-related value object to hold results gathered from a SetupAndGetIntroText call.

Field Summary

Fields inherited from class SecurityVO

RESULT_FAILURE, RESULT_PARTIAL, RESULT_SUCCESS

Constructor Summary

Constructors

Constructor and Description
SecurityVOSetupAndIntroText() No-parameter constructor.
SecurityVOSetupAndIntroText(int resultType, String resultMessage) Constructor.
SecurityVOSetupAndIntroText(SecurityDataSetupAndIntroTextResponse setupAndIntroResponseObj) Constructor based on the (VistaLink-internal) setup/intro text response object.

Method Summary

Modifier and Type	Method and Description
String	getDevice() Gets the Device name representing the M system active partition, expected to be as returned from M.
String	getIntroductoryText() Gets the raw Introductory Text string returned from M.
int	getLogonRetryCount() returns the number of logon retries allowed by Kernel, expected to be as returned from M.
int	getPort() returns the port value for the server connection
String	getServerName() Gets the server name representing the M system active partition, expected to be as returned from M.
int	getTimeout() Gets the timeout from the M system active partition prior to logon, expected to be as returned from M.
String	getUci() Gets the UCI name representing the M system active partition, expected to be as returned from M.
String	getVolume() Gets the volume name representing the M system active partition, expected to be as returned from M.
void	setDevice(String value) Sets the Device name representing the M system active partition, expected to be as returned from M.
void	setIntroductoryText(String value) Sets the raw Introductory Text string returned from M.
void	setLogonRetryCount(int count) sets the number of logon retries allowed by Kernel, expected to be as returned from M.
void	setPort(int value) Sets the port, expected to be the port to which the connection is being made
void	setServerName(String value) Sets the server name representing the M system active partition, expected to be as returned from M.
void	setTimeout(int value) Sets the timeout, expected to be as returned from the M server
void	setUci(String value) Sets the UCI name representing the M system active partition, expected to be as returned from M.
void	setVolume(String value) Sets the volume name representing the M system active partition, expected to be as returned from M.
String	toString() Returns a crude "toString" representation of the data held in the object.

Methods inherited from class SecurityVO

getResultMessage, getResultType, setResultMessage, setResultType

Methods inherited from class Object

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

Constructor Detail

SecurityVOSetupAndIntroText

public SecurityVOSetupAndIntroText(int resultType,
                                   String resultMessage)

Constructor.

Parameters:

resultType - Success, Failure or Partial Success (types defined in parent class)

resultMessage - optional explanatory description for the result, usually used for failure and partial success only

SecurityVOSetupAndIntroText

public SecurityVOSetupAndIntroText()

No-parameter constructor. Sets the result type to FAILURE, and the result message string to "".

SecurityVOSetupAndIntroText

public SecurityVOSetupAndIntroText(SecurityDataSetupAndIntroTextResponse setupAndIntroResponseObj)

Constructor based on the (VistaLink-internal) setup/intro text response object.

Parameters:

setupAndIntroResponseObj - internal VistaLink object representing all setup and intro text information returned from an M system

Method Detail

setIntroductoryText

public void setIntroductoryText(String value)

Sets the raw Introductory Text string returned from M. This is expected to be many actual display lines concatenated into one string separated by <BR>'s.

Parameters:

value - the introductory text string to set

getIntroductoryText

public String getIntroductoryText()

Gets the raw Introductory Text string returned from M. This is typically many actual display lines concatenated into one string separated by <BR>'s.

Returns:

String the introductory text as a string

setServerName

public void setServerName(String value)

Sets the server name representing the M system active partition, expected to be as returned from M.

Parameters:

value - the server name

getServerName

public String getServerName()

Gets the server name representing the M system active partition, expected to be as returned from M.

Returns:

String the server name

setVolume

public void setVolume(String value)

Sets the volume name representing the M system active partition, expected to be as returned from M.

Parameters:

value - the M partition's volume

getVolume

public String getVolume()

Gets the volume name representing the M system active partition, expected to be as returned from M.

Returns:

String the M partition's volume

setLogonRetryCount

public void setLogonRetryCount(int count)

sets the number of logon retries allowed by Kernel, expected to be as returned from M.

Parameters:

count - the # of logon retries

getLogonRetryCount

public int getLogonRetryCount()

returns the number of logon retries allowed by Kernel, expected to be as returned from M.

Returns:

int the # of logon retries

setUci

public void setUci(String value)

Sets the UCI name representing the M system active partition, expected to be as returned from M.

Parameters:

value - the M partition UCI name

getUci

public String getUci()

Gets the UCI name representing the M system active partition, expected to be as returned from M.

Returns:

String the M partition UCI name

setDevice

public void setDevice(String value)

Sets the Device name representing the M system active partition, expected to be as returned from M.

Parameters:

value - the device name for the M partition

getDevice

public String getDevice()

Gets the Device name representing the M system active partition, expected to be as returned from M.

Returns:

String the device name for the M partition

setTimeout

public void setTimeout(int value)

Sets the timeout, expected to be as returned from the M server

Parameters:

value - timeout in seconds

getTimeout

public int getTimeout()

Gets the timeout from the M system active partition prior to logon, expected to be as returned from M.

Returns:

int

setPort

public void setPort(int value)

Sets the port, expected to be the port to which the connection is being made

Parameters:

value - port of the current connection

getPort

public int getPort()

returns the port value for the server connection

Returns:

int port for the server connection

toString

public String toString()

Returns a crude "toString" representation of the data held in the object.

Overrides:

toString in class Object

See Also:

Object.toString()