gov.va.med.vistalink.security.m

Class SecurityVO

Object

SecurityVO

Direct Known Subclasses:

SecurityVOChangeVc, SecurityVOLogon, SecurityVOSelectDivision, SecurityVOSetupAndIntroText, SecurityVOUserDemographics

public abstract class SecurityVO
extends Object

Abstract base class for Logon-related value objects.

Field Summary

Fields

Modifier and Type	Field and Description
static int	RESULT_FAILURE resulttype representing failure.
static int	RESULT_PARTIAL resulttype representing partial success.
static int	RESULT_SUCCESS resulttype representing success.

Constructor Summary

Constructors

Constructor and Description
SecurityVO(int resultType, String resultMessage) Constructor.

Method Summary

Modifier and Type	Method and Description
String	getResultMessage() Gets any message associated with the result type.
int	getResultType() Result type -- sucessful, partially successful or failure.
void	setResultMessage(String resultMessage) Sets any message associated with the result type.
void	setResultType(int resultType) Sets the result type.

Methods inherited from class Object

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

Field Detail

RESULT_SUCCESS

public static final int RESULT_SUCCESS

resulttype representing success.

See Also:

Constant Field Values

RESULT_FAILURE

public static final int RESULT_FAILURE

resulttype representing failure.

See Also:

Constant Field Values

RESULT_PARTIAL

public static final int RESULT_PARTIAL

resulttype representing partial success.

See Also:

Constant Field Values

Constructor Detail

SecurityVO

public SecurityVO(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

Method Detail

getResultType

public int getResultType()

Result type -- sucessful, partially successful or failure.

• RESULT_SUCCESS is returned if operation was successful
• RESULT_FAILURE if operation was unsuccessful
• RESULT_PARTIAL is returned only for:
  • logon calls (if logon was successful but user needs to change verify code or select division)
  • change verify code calls (if the change verify code succeeded but the user needs to select division)

Returns:

int RESULT_SUCCESS, RESULT_FAILURE or RESULT_PARTIAL.

setResultType

public void setResultType(int resultType)

Sets the result type.

Parameters:

resultType -

getResultMessage

public String getResultMessage()

Gets any message associated with the result type.

Returns:

String

setResultMessage

public void setResultMessage(String resultMessage)

Sets any message associated with the result type. Usually only partially succesful and failure result types have a message associated with them.

Parameters:

resultMessage - message to associate with/explain the result type.