gov.virginia.dcjs.standards.client
Class TRexClientRequest

java.lang.Object
  gov.virginia.dcjs.standards.client.TRexClientRequest

public class TRexClientRequest

extends java.lang.Object

This class enumerates those static constants representing the * various requests the TRex application server can service. * The custom request process contains two steps. First, the type * of request must be specified; one of:

*
• LISTING *
• EXISTING *

* Then one of the requests under the selected request type must be * specified. These sub requests are organized as follows:

*
• LISTING
  *
  • ACADEMY *
  • AGENCY *
  • AGENCY_EMPLOYEES *
  • AGENCY_INSTRUCTORS *
  • CERTIFICATION *
  • EMPLOYMENT *
  • INSTRUCTOR *
  • INSTRUCTOR_HISTORY *
  • LOOKUP *
  • NOTES *
  • PERSON *
  • REFRESH *
  • SEARCH *
  • TRAINING *
  *
• EXISTING
  *
  • AGENCY *
  • CERTIFICATION *
  • EMPLOYMENT *
  • INSTRUCTOR *
  • NOTES *
  • PERSON *
  • TRAINING *
  *

* The following default types may also be submitted:

*
• TCPClientRequest.ROWSOURCE
  *
  • ACADEMY *
  • ACADEMY_REGION *
  • AGENCY *
  • AGENCY_STATUS *
  • CERTIFICATION *
  • COMPLIANCE *
  • COURSE *
  • EDUCATION *
  • FUNCTION *
  • GENDER *
  • RACE *
  • RANK *
  • REGION *
  • STATUS *
  • SUFFIX *
  • TERMINATION *
  • TRAINING *
  • TYPE *
  *
• TCPClientRequest.METADATA
  *
  • AGENCY *
  • CERTIFICATION *
  • EMPLOYMENT *
  • INSTRUCTOR *
  • NOTES *
  • PERSON *
  • TRAINING *
  *

Field Summary

static int	ACADEMY Academy table, listing OR code row source
static int	ACADEMY_REGION Academy region
static int	AGENCY Agency table
static int	AGENCY_EMPLOYEES Obtain a listing of all agency employees
static int	AGENCY_INSTRUCTORS Obtain a listing of all agency instructors
static int	AGENCY_STATUS Agency status
static int	CERTIFICATION Certification table
static int	COMPLIANCE Compliance codes
static int	COURSE Course codes
static int	EDUCATION Eduction codes
static int	EMPLOYMENT Employment table
static int	EXISTING Existing record request
static int	FUNCTION Function codes
static int	GENDER Gender codes
static int	INSTRUCTOR Instructor table
static int	INSTRUCTOR_HISTORY Instructor history listing
static java.lang.String	INSTRUCTOR_SEARCH Instructor search key parameter
static int	LISTING Listing request
static int	LOOKUP Perform a lookup for a single table and ssn
static java.lang.String	NAME Application name
static int	NOTES Notes table
static int	PERSON Person table
static int	RACE Race codes
static int	RANK Rank codes
static int	REFRESH Refresh the stored code tables by recreating them
static int	REGION Region codes
static int	SEARCH Search results listing
static int	STATUS Status codes
static int	SUFFIX Suffixes
static int	TERMINATION Termination codes
static int	TRAINING Training table
static int	TYPE Type codes
static int	UNKNOWN Unrecognized request

Constructor Summary

TRexClientRequest()

Method Summary

static int	getTableID(java.lang.String name) Obtain the application specific integer constant representing * the specified table name.
static java.lang.String	getTableName(int table) Obtain the table name for the specified id constant.
static DataTable	getTableReference(int table) Obtain a reference for the table of the specified id constant.

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final java.lang.String NAME

Application name

See Also:

Constant Field Values

INSTRUCTOR_SEARCH

public static final java.lang.String INSTRUCTOR_SEARCH

Instructor search key parameter

See Also:

Constant Field Values

ACADEMY

public static final int ACADEMY

Academy table, listing OR code row source

See Also:

Constant Field Values

AGENCY

public static final int AGENCY

Agency table

See Also:

Constant Field Values

CERTIFICATION

public static final int CERTIFICATION

Certification table

See Also:

Constant Field Values

EMPLOYMENT

public static final int EMPLOYMENT

Employment table

See Also:

Constant Field Values

INSTRUCTOR

public static final int INSTRUCTOR

Instructor table

See Also:

Constant Field Values

NOTES

public static final int NOTES

Notes table

See Also:

Constant Field Values

PERSON

public static final int PERSON

Person table

See Also:

Constant Field Values

TRAINING

public static final int TRAINING

Training table

See Also:

Constant Field Values

UNKNOWN

public static final int UNKNOWN

Unrecognized request

See Also:

Constant Field Values

LISTING

public static final int LISTING

Listing request

See Also:

Constant Field Values

EXISTING

public static final int EXISTING

Existing record request

See Also:

Constant Field Values

INSTRUCTOR_HISTORY

public static final int INSTRUCTOR_HISTORY

Instructor history listing

See Also:

Constant Field Values

SEARCH

public static final int SEARCH

Search results listing

See Also:

Constant Field Values

LOOKUP

public static final int LOOKUP

Perform a lookup for a single table and ssn

See Also:

Constant Field Values

REFRESH

public static final int REFRESH

Refresh the stored code tables by recreating them

See Also:

Constant Field Values

AGENCY_EMPLOYEES

public static final int AGENCY_EMPLOYEES

Obtain a listing of all agency employees

See Also:

Constant Field Values

AGENCY_INSTRUCTORS

public static final int AGENCY_INSTRUCTORS

Obtain a listing of all agency instructors

See Also:

Constant Field Values

ACADEMY_REGION

public static final int ACADEMY_REGION

Academy region

See Also:

Constant Field Values

AGENCY_STATUS

public static final int AGENCY_STATUS

Agency status

See Also:

Constant Field Values

COMPLIANCE

public static final int COMPLIANCE

Compliance codes

See Also:

Constant Field Values

COURSE

public static final int COURSE

Course codes

See Also:

Constant Field Values

EDUCATION

public static final int EDUCATION

Eduction codes

See Also:

Constant Field Values

FUNCTION

public static final int FUNCTION

Function codes

See Also:

Constant Field Values

GENDER

public static final int GENDER

Gender codes

See Also:

Constant Field Values

RACE

public static final int RACE

Race codes

See Also:

Constant Field Values

RANK

public static final int RANK

Rank codes

See Also:

Constant Field Values

REGION

public static final int REGION

Region codes

See Also:

Constant Field Values

STATUS

public static final int STATUS

Status codes

See Also:

Constant Field Values

SUFFIX

public static final int SUFFIX

Suffixes

See Also:

Constant Field Values

TERMINATION

public static final int TERMINATION

Termination codes

See Also:

Constant Field Values

TYPE

public static final int TYPE

Type codes

See Also:

Constant Field Values

Constructor Detail

TRexClientRequest

public TRexClientRequest()

Method Detail

getTableID

public static int getTableID(java.lang.String name)

Obtain the application specific integer constant representing * the specified table name. * @param name Database table name to obtain constant for * @return Application specific constant for the specified table

getTableName

public static java.lang.String getTableName(int table)

Obtain the table name for the specified id constant. * @param table Constant identifier for the table. * @return Name of the table, or null if an invalid identifier.

getTableReference

public static DataTable getTableReference(int table)

Obtain a reference for the table of the specified id constant. * @param table Constant identifier for the table. * @return Reference to the specified table object, or null if the * identifier is invalid.