com.remedy.arsys.api
Class Keyword

java.lang.Object
  |
  +--com.remedy.arsys.api.Keyword

public class Keyword

extends java.lang.Object

The Keyword class represents keywords you can use in qualification criteria.

Field Summary

static Keyword	AR_KEYWORD_APPLICATION The name (not label) of the currently running (client only) application.
static Keyword	AR_KEYWORD_BROWSER Constants.AR_KEYWORD_BROWSER is the browser type (client only).
static Keyword	AR_KEYWORD_CLIENT_TYPE Constants.AR_KEYWORD_CLIENT_TYPE is the client type of the api program.
static Keyword	AR_KEYWORD_DATABASE Constants.AR_KEYWORD_DATABASE is the name of the database used on the current server.
static Keyword	AR_KEYWORD_DATE_ONLY Constants.AR_KEYWORD_DATE_ONLY is the current date (time defaults to midnight).
static Keyword	AR_KEYWORD_DEFAULT Constants.AR_KEYWORD_DEFAULT is the the administrator-defined default for the field
static Keyword	AR_KEYWORD_FIELDHELP Current Field Help (client only) in the Help Text tab of the Field Properties window.
static Keyword	AR_KEYWORD_GROUPS Constants.AR_KEYWORD_GROUPS are the groups of which the current user is a member (returns an empty string for escalations).
static Keyword	AR_KEYWORD_GUIDE Current running guide (client only).
static Keyword	AR_KEYWORD_GUIDETEXT Current Guide Text (client only) entered under the Help tab when you create or modify a guide.
static Keyword	AR_KEYWORD_HARDWARE Constants.AR_KEYWORD_HARDWARE is the hardware on which the process is running.
static Keyword	AR_KEYWORD_HOMEURL Constants.AR_KEYWORD_HOMEURL is the base location of the mid tier install.
static Keyword	AR_KEYWORD_LASTCOUNT Constants.AR_KEYWORD_LASTCOUNT is the number of requests returned from the most recent search.
static Keyword	AR_KEYWORD_LASTID Upon a successful submit, Constants.AR_KEYWORD_LASTID is the keyword contains the Request ID of the most recently created request during the user’s login environment.
static Keyword	AR_KEYWORD_LOCALE Constants.AR_KEYWORD_LOCALE is the user locale.
static Keyword	AR_KEYWORD_OPERATION Constants.AR_KEYWORD_OPERATION is the current operation (for example, CREATE).
static Keyword	AR_KEYWORD_OS Constants.AR_KEYWORD_OS is the operating system of the machine on which a process is running.
static Keyword	AR_KEYWORD_ROWCHANGED Constants.AR_KEYWORD_ROWCHANGED indicates if a row in table field was changed (client only).
static Keyword	AR_KEYWORD_ROWSELECTED Constants.AR_KEYWORD_ROWSELECTED indicates if a row in table field was selected (client only).
static Keyword	AR_KEYWORD_SCHEMA Constants.AR_KEYWORD_SCHEMA is the name of the current form.
static Keyword	AR_KEYWORD_SCHEMA_ALIAS Constants.AR_KEYWORD_SCHEMA_ALIAS is the alias name for the current form.
static Keyword	AR_KEYWORD_SERVER Constants.AR_KEYWORD_SERVER is the name of the current AR System server.
static Keyword	AR_KEYWORD_TCPPORT Constants.AR_KEYWORD_TCPPORT is the TCP/IP Port of the local AR System server.
static Keyword	AR_KEYWORD_TIME_ONLY Constants.AR_KEYWORD_TIME_ONLY is the current time (date defaults to today).
static Keyword	AR_KEYWORD_TIMESTAMP Constants.AR_KEYWORD_TIMESTAMP is the current date/time.
static Keyword	AR_KEYWORD_USER Constants.AR_KEYWORD_USER is the current user login.
static Keyword	AR_KEYWORD_VERSION Constants.AR_KEYWORD_VERSION is the software version running on the client (active links) or server (filters and escalations).
static Keyword	AR_KEYWORD_VUI Name of the form view displayed in the active window (returns an empty string for filters and escalations).
static Keyword	AR_KEYWORD_VUI_TYPE Constants.AR_KEYWORD_VUI_TYPE is the VUI type.
static Keyword	AR_KEYWORD_WEEKDAY Constants.AR_KEYWORD_WEEKDAY is the current day of the week as a character string.

Method Summary

boolean	equals(java.lang.Object anObject) Use this method for checking equality of Keyword.
int	toInt() Returns the integer value of the keyword (constants).
static Keyword	toKeyword(int n)
java.lang.String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

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

Field Detail

AR_KEYWORD_DEFAULT

public static final Keyword AR_KEYWORD_DEFAULT

Constants.AR_KEYWORD_DEFAULT is the the administrator-defined default for the field

AR_KEYWORD_USER

public static final Keyword AR_KEYWORD_USER

Constants.AR_KEYWORD_USER is the current user login.

AR_KEYWORD_TIMESTAMP

public static final Keyword AR_KEYWORD_TIMESTAMP

Constants.AR_KEYWORD_TIMESTAMP is the current date/time.

AR_KEYWORD_TIME_ONLY

public static final Keyword AR_KEYWORD_TIME_ONLY

Constants.AR_KEYWORD_TIME_ONLY is the current time (date defaults to today).

AR_KEYWORD_DATE_ONLY

public static final Keyword AR_KEYWORD_DATE_ONLY

Constants.AR_KEYWORD_DATE_ONLY is the current date (time defaults to midnight).

AR_KEYWORD_SCHEMA

public static final Keyword AR_KEYWORD_SCHEMA

Constants.AR_KEYWORD_SCHEMA is the name of the current form.

AR_KEYWORD_SERVER

public static final Keyword AR_KEYWORD_SERVER

Constants.AR_KEYWORD_SERVER is the name of the current AR System server.

AR_KEYWORD_WEEKDAY

public static final Keyword AR_KEYWORD_WEEKDAY

Constants.AR_KEYWORD_WEEKDAY is the current day of the week as a character string.

AR_KEYWORD_GROUPS

public static final Keyword AR_KEYWORD_GROUPS

Constants.AR_KEYWORD_GROUPS are the groups of which the current user is a member (returns an empty string for escalations).

AR_KEYWORD_OPERATION

public static final Keyword AR_KEYWORD_OPERATION

Constants.AR_KEYWORD_OPERATION is the current operation (for example, CREATE).

AR_KEYWORD_HARDWARE

public static final Keyword AR_KEYWORD_HARDWARE

Constants.AR_KEYWORD_HARDWARE is the hardware on which the process is running.

AR_KEYWORD_OS

public static final Keyword AR_KEYWORD_OS

Constants.AR_KEYWORD_OS is the operating system of the machine on which a process is running. You can use this keyword to build workflow that executes conditionally based on the current operating system.

AR_KEYWORD_DATABASE

public static final Keyword AR_KEYWORD_DATABASE

Constants.AR_KEYWORD_DATABASE is the name of the database used on the current server. This keyword is especially useful for workflow that is dependent on the database environment.

AR_KEYWORD_LASTID

public static final Keyword AR_KEYWORD_LASTID

Upon a successful submit, Constants.AR_KEYWORD_LASTID is the keyword contains the Request ID of the most recently created request during the user’s login environment.

AR_KEYWORD_LASTCOUNT

public static final Keyword AR_KEYWORD_LASTCOUNT

Constants.AR_KEYWORD_LASTCOUNT is the number of requests returned from the most recent search. You can use this keyword with any search, including one run from the search window, a search menu, a Set Fields operation, a macro, a table refresh, and so on.

AR_KEYWORD_VERSION

public static final Keyword AR_KEYWORD_VERSION

Constants.AR_KEYWORD_VERSION is the software version running on the client (active links) or server (filters and escalations). This keyword includes any applicable patch number.

AR_KEYWORD_VUI

public static final Keyword AR_KEYWORD_VUI

Name of the form view displayed in the active window (returns an empty string for filters and escalations).

AR_KEYWORD_GUIDETEXT

public static final Keyword AR_KEYWORD_GUIDETEXT

Current Guide Text (client only) entered under the Help tab when you create or modify a guide.

AR_KEYWORD_FIELDHELP

public static final Keyword AR_KEYWORD_FIELDHELP

Current Field Help (client only) in the Help Text tab of the Field Properties window.

AR_KEYWORD_GUIDE

public static final Keyword AR_KEYWORD_GUIDE

Current running guide (client only). (The name is $NULL$ if no guide is running.)

AR_KEYWORD_APPLICATION

public static final Keyword AR_KEYWORD_APPLICATION

The name (not label) of the currently running (client only) application. (The name is $NULL$ if no application is running.)

AR_KEYWORD_LOCALE

public static final Keyword AR_KEYWORD_LOCALE

Constants.AR_KEYWORD_LOCALE is the user locale.

AR_KEYWORD_CLIENT_TYPE

public static final Keyword AR_KEYWORD_CLIENT_TYPE

Constants.AR_KEYWORD_CLIENT_TYPE is the client type of the api program.

AR_KEYWORD_SCHEMA_ALIAS

public static final Keyword AR_KEYWORD_SCHEMA_ALIAS

Constants.AR_KEYWORD_SCHEMA_ALIAS is the alias name for the current form.

AR_KEYWORD_ROWSELECTED

public static final Keyword AR_KEYWORD_ROWSELECTED

Constants.AR_KEYWORD_ROWSELECTED indicates if a row in table field was selected (client only).

AR_KEYWORD_ROWCHANGED

public static final Keyword AR_KEYWORD_ROWCHANGED

Constants.AR_KEYWORD_ROWCHANGED indicates if a row in table field was changed (client only).

AR_KEYWORD_BROWSER

public static final Keyword AR_KEYWORD_BROWSER

Constants.AR_KEYWORD_BROWSER is the browser type (client only).

AR_KEYWORD_VUI_TYPE

public static final Keyword AR_KEYWORD_VUI_TYPE

Constants.AR_KEYWORD_VUI_TYPE is the VUI type.

AR_KEYWORD_TCPPORT

public static final Keyword AR_KEYWORD_TCPPORT

Constants.AR_KEYWORD_TCPPORT is the TCP/IP Port of the local AR System server.

AR_KEYWORD_HOMEURL

public static final Keyword AR_KEYWORD_HOMEURL

Constants.AR_KEYWORD_HOMEURL is the base location of the mid tier install.

Method Detail

toInt

public int toInt()

Returns the integer value of the keyword (constants).

toString

public java.lang.String toString()

Returns a string description of the object.

Overrides:

toString in class java.lang.Object

toKeyword

public static Keyword toKeyword(int n)

equals

public boolean equals(java.lang.Object anObject)

Use this method for checking equality of Keyword. The result is true if and only if the argument is not null and is a Keyword object that represents the same content.

Overrides:

equals in class java.lang.Object