VistALink v1.5.0.026

gov.va.med.vistalink.security.m
Class VistaInstitutionVO

java.lang.Object
  extended bygov.va.med.vistalink.security.m.VistaInstitutionVO

public final class VistaInstitutionVO
extends java.lang.Object

Represents a Vista Institution, including IEN, Station Name and Station Number.

Version:
1.5.0.026
Author:
Application Modernization - Foundations Team

Constructor Summary
VistaInstitutionVO()
          Instantiates a VistaInstitutionVO with all fields set to the null string.
VistaInstitutionVO(java.lang.String divIen, java.lang.String divName, java.lang.String divNumber)
          Instantiates a VistaInstitutionVO with the fields set to the parameters you specify:
VistaInstitutionVO(java.lang.String divIen, java.lang.String divName, java.lang.String divNumber, boolean isDefaultLogonDivision)
          Instantiates a VistaInstitutionVO with the fields set to the parameters you specify:
 
Method Summary
 java.lang.String getIen()
          returns the IEN of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)
 boolean getIsDefaultLogonDivision()
          If used during part of the logon process, stores whether this is the "default" division
 java.lang.String getName()
          returns the station name of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)
 java.lang.String getNumber()
          returns the station number of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)
 java.lang.String toString()
          returns a string representation of the institution information
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

VistaInstitutionVO

public VistaInstitutionVO()
Instantiates a VistaInstitutionVO with all fields set to the null string.


VistaInstitutionVO

public VistaInstitutionVO(java.lang.String divIen,
                          java.lang.String divName,
                          java.lang.String divNumber,
                          boolean isDefaultLogonDivision)
Instantiates a VistaInstitutionVO with the fields set to the parameters you specify:

Parameters:
divIen - the IEN on Vista of the Institution
divName - the Station Name of the Institution
divNumber - the Station Number of the Institution
isDefaultLogonDivision - set to true if this is the default logon division. Defaults to false.

VistaInstitutionVO

public VistaInstitutionVO(java.lang.String divIen,
                          java.lang.String divName,
                          java.lang.String divNumber)
Instantiates a VistaInstitutionVO with the fields set to the parameters you specify:

Parameters:
divIen - the IEN on Vista of the Institution
divName - the Station Name of the Institution
divNumber - the Station Number of the Institution
Method Detail

getIen

public java.lang.String getIen()
returns the IEN of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)

Returns:
the IEN of the institution

getName

public java.lang.String getName()
returns the station name of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)

Returns:
the name of the institution

getNumber

public java.lang.String getNumber()
returns the station number of the institution, presumably from the VistA Institution file entry (depending on the source of the information the instance contains)

Returns:
the station number of the institution

getIsDefaultLogonDivision

public boolean getIsDefaultLogonDivision()
If used during part of the logon process, stores whether this is the "default" division

Returns:
boolean true if this is the default division, otherwise false.

toString

public java.lang.String toString()
returns a string representation of the institution information

Returns:
a string with IEN, name and number labels and values.

VistALink v1.5.0.026

VistALink v1.5.0.026