gov.va.med.vistalink.security.m

Class SecurityVOLogon

Object

SecurityVO

SecurityVOLogon

public class SecurityVOLogon
extends SecurityVO

Logon-related value object for "logon with access/verify code" results.

Field Summary

Fields inherited from class SecurityVO

RESULT_FAILURE, RESULT_PARTIAL, RESULT_SUCCESS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
String	getCvcHelpText() Help text to make available for the 'change verify code' dialog.
Map	getDivisionList() Returns a TreeMap of divisions (should only be populated if getNeedDivisionSelection() returns true.)
boolean	getNeedDivisionSelection() Returns whether division selection is needed, after a (partially) successful logon operation.
boolean	getNeedNewVerifyCode() Returns whether a new verify code is needed, after a (partially) successful logon operation.
String	getPostSignInText() If there is post-sign-in text to return, it is returned here
void	setCvcHelpText(String cvcHelpText) Help text to make available for the 'change verify code' dialog.
void	setDivisionList(Map divisionList) Sets a TreeMap of divisions (should only be populated if getNeedDivisionSelection() returns true.)
void	setNeedDivisionSelection(boolean needDivisionSelection) Sets whether division selection is needed, after a (partially) successful logon operation.
void	setNeedNewVerifyCode(boolean needNewVerifyCode) Sets whether a new verify code is needed, after a (partially) successful logon operation.
void	setPostSignInText(String postSignInText) If there is post-sign-in text to return, set it here.

Methods inherited from class SecurityVO

getResultMessage, getResultType, setResultMessage, setResultType

Methods inherited from class Object

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

Constructor Detail

SecurityVOLogon

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

getNeedNewVerifyCode

public boolean getNeedNewVerifyCode()

Returns whether a new verify code is needed, after a (partially) successful logon operation.

Returns:

boolean whether a new verify code is needed

setNeedNewVerifyCode

public void setNeedNewVerifyCode(boolean needNewVerifyCode)

Sets whether a new verify code is needed, after a (partially) successful logon operation.

Parameters:

needNewVerifyCode - whether the user needs to change verify code.

getDivisionList

public Map getDivisionList()

Returns a TreeMap of divisions (should only be populated if getNeedDivisionSelection() returns true.)

Returns:

TreeMap list of divisions, division/station number string as key, VistaInstitutionVO as object.

See Also:

VistaInstitutionVO

setDivisionList

public void setDivisionList(Map divisionList)

Sets a TreeMap of divisions (should only be populated if getNeedDivisionSelection() returns true.)

Parameters:

divisionList - TreeMap list of divisions, division/station number string as key, VistaInstitutionVO as object.

See Also:

VistaInstitutionVO

getPostSignInText

public String getPostSignInText()

If there is post-sign-in text to return, it is returned here

Returns:

String post-sign-in text

setPostSignInText

public void setPostSignInText(String postSignInText)

If there is post-sign-in text to return, set it here.

Parameters:

postSignInText - post-sign-in text

getNeedDivisionSelection

public boolean getNeedDivisionSelection()

Returns whether division selection is needed, after a (partially) successful logon operation.

Returns:

boolean true if needed, false if not

setNeedDivisionSelection

public void setNeedDivisionSelection(boolean needDivisionSelection)

Sets whether division selection is needed, after a (partially) successful logon operation.

Parameters:

needDivisionSelection - true if needed, false if not

getCvcHelpText

public String getCvcHelpText()

Help text to make available for the 'change verify code' dialog.

Returns:

String help text for changing the verify code.

setCvcHelpText

public void setCvcHelpText(String cvcHelpText)

Help text to make available for the 'change verify code' dialog.

Parameters:

cvcHelpText - help text for changing the verify code.