gov.virginia.dcjs.client
Interface ApplicationClient

All Superinterfaces:

GridRowProvider

All Known Implementing Classes:

GridClient, GuiClient, TCPApplicationClient

public interface ApplicationClient

extends GridRowProvider

This class serves as the intermediary interface between a distributed * application's GUI and communication components. Implementors of this * interface become the channel through which a GUI component makes * requests of the associated server piece.

Method Summary

void	alert(java.lang.String msg, java.lang.String title) Pop up a message to the user * @param msg Message to present to user * @param title Dialog title
void	cancel(ApplicationPanel ap) Method for receiving a Cancel event from an * ApplicationPanel object.
boolean	custom(ApplicationPanel ap) Method for receiving a Custom event from an * ApplicationPanel object.
boolean	delete(ApplicationPanel ap) Method for receiving a Delete event from an * ApplicationPanel object.
void	exit() End client connection with server
java.lang.String	getEmployerID()
java.awt.Frame	getFrame() Obtain the frame housing this client.
java.lang.String	getPassword()
Relation	getRelation() Obtain the resulting Relation from the most recent * request to the server.
Relation	getRequestResult() Obtain the resulting Relation from the most recent * request.
java.lang.String	getUserID()
java.lang.String	getUserLogon() Obtain the username portion of the logon for this user * @return User's logon name
java.lang.String	getUserName()
java.lang.String	getWhyInvalid() Obtain why the latest request was not satisfied * @return Reason a request was not satisfied
boolean	insert(ApplicationPanel ap) Method for receiving an Insert event from an * ApplicationPanel object.
void	login() Custom login method that an ApplicationLogon object * calls for application specific login functionality.
boolean	register(java.lang.String logonName, java.lang.String logonPassword, boolean isLogon) Method for initial user logon and valid use registration with * server * @param logonName User's logon name * @param logonPassword User's logon password * @param isLogon True for initial logon, False for registering * a valid user * @return True for a successful logon * @deprecated use register(String, String) instead.
boolean	save(ApplicationPanel ap) Write the contents of the ApplicationPanel provided to the database * @param ap ApplicationPanel containing the data * to be written to the database * @return True when data has been successfully saved
boolean	select(ApplicationPanel ap, boolean newList) Method for receiving a Select event from an * ApplicationPanel or TCPClientMenu * object.
boolean	selectRecord(ApplicationPanel ap, boolean isNew) Stub function for receiving a SelectRecord event from an * ApplicationPanel object.
boolean	update(ApplicationPanel ap) Method for receiving a Update event from an * ApplicationPanel object.

Methods inherited from interface gov.virginia.dcjs.gui.GridRowProvider

getGroup, getMetaData, getRowSource, isNewRequest

Method Detail

register

public boolean register(java.lang.String logonName,
                        java.lang.String logonPassword,
                        boolean isLogon)

Method for initial user logon and valid use registration with * server * @param logonName User's logon name * @param logonPassword User's logon password * @param isLogon True for initial logon, False for registering * a valid user * @return True for a successful logon * @deprecated use register(String, String) instead. * isLogon functionality no longer supported.

login

public void login()

Custom login method that an ApplicationLogon object * calls for application specific login functionality. * @deprecated use register() instead.

exit

public void exit()

End client connection with server

getWhyInvalid

public java.lang.String getWhyInvalid()

Obtain why the latest request was not satisfied * @return Reason a request was not satisfied

select

public boolean select(ApplicationPanel ap,
                      boolean newList)

Method for receiving a Select event from an * ApplicationPanel or TCPClientMenu * object. * @param ap Application Panel object making the request * @param newList True if the request is for a new listing, * False for obtaining a sublist for an existing record. * @return True for a successful operation

selectRecord

public boolean selectRecord(ApplicationPanel ap,
                            boolean isNew)

Stub function for receiving a SelectRecord event from an * ApplicationPanel object. * @param ap Application Panel object making the request * @param isNew True if the request is for a new record, * False for obtaining an existing record. * @return True for a successful operation

save

public boolean save(ApplicationPanel ap)

Write the contents of the ApplicationPanel provided to the database * @param ap ApplicationPanel containing the data * to be written to the database * @return True when data has been successfully saved

insert

public boolean insert(ApplicationPanel ap)

Method for receiving an Insert event from an * ApplicationPanel object. * @param ap Application Panel object making the request * @return True for a successful operation

update

public boolean update(ApplicationPanel ap)

Method for receiving a Update event from an * ApplicationPanel object. * @param ap Application Panel object making the request * @return True for a successful operation

delete

public boolean delete(ApplicationPanel ap)

Method for receiving a Delete event from an * ApplicationPanel object. * @param ap Application Panel object making the request * @return True for a successful operation

cancel

public void cancel(ApplicationPanel ap)

Method for receiving a Cancel event from an * ApplicationPanel object. * @param ap Application Panel object making the request

custom

public boolean custom(ApplicationPanel ap)

Method for receiving a Custom event from an * ApplicationPanel object. * @param ap Application Panel object making the request

alert

public void alert(java.lang.String msg,
                  java.lang.String title)

Pop up a message to the user * @param msg Message to present to user * @param title Dialog title

getRelation

public Relation getRelation()

Obtain the resulting Relation from the most recent * request to the server. * @return Resulting data from last SQL request to server.

getRequestResult

public Relation getRequestResult()

Obtain the resulting Relation from the most recent * request. * @deprecated Use getRelation() instead.

getUserName

public java.lang.String getUserName()

Returns:

User's display name

getUserLogon

public java.lang.String getUserLogon()

Obtain the username portion of the logon for this user * @return User's logon name

getPassword

public java.lang.String getPassword()

Returns:

User's password

getUserID

public java.lang.String getUserID()

Returns:

User's ID

getEmployerID

public java.lang.String getEmployerID()

Returns:

User Employer's ID

getFrame

public java.awt.Frame getFrame()

Obtain the frame housing this client. * Subclasses should provide the actual frame containing the application GUI. * @return frame GUI frame housing this client. * @deprecated Applications shall provide the frame directly as needed.