public class Keyword extends Object implements Serializable
Keyword
class
represents keywords you can use in qualification criteria.Modifier and Type | Field and Description |
---|---|
static Keyword |
AR_KEYWORD_ALT_KEY
Constants.AR_KEYWORD_ALT_KEY is set when user has pressed ALT key while opening a link. |
static Keyword |
AR_KEYWORD_APPLICATION
The name (not label) of the currently running (client only) application.
|
static Keyword |
AR_KEYWORD_AUTHSTRING
Constants.AR_KEYWORD_AUTHSTRING is the authString. |
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_CTRL_KEY
Constants.AR_KEYWORD_CTRL_KEY is set when user has pressed CONTROL key while opening a link. |
static Keyword |
AR_KEYWORD_CURRENTWINID
Constants.AR_KEYWORD_CURRENTWINID returns the window id of the current window
(client only) |
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_DRAGSRCFIELDID
Constants.AR_KEYWORD_DRAGSRCFIELDID is field ID of source field for drag operation. |
static Keyword |
AR_KEYWORD_DROPTGTFIELDID
Constants.AR_KEYWORD_DROPTGTFIELDID is field ID of destination field for drop operation. |
static Keyword |
AR_KEYWORD_ERRAPPENDMSG
Constants.AR_KEYWORD_ERRAPPENDMSG is additional appended message(if any) of the error above. |
static Keyword |
AR_KEYWORD_ERRMSG
Constants.AR_KEYWORD_ERRMSG is error message of the current action. |
static Keyword |
AR_KEYWORD_ERRNO
Constants.AR_KEYWORD_ERRNO is errorcode of the current action. |
static Keyword |
AR_KEYWORD_EVENTDATA
Constants.AR_KEYWORD_EVENTDATA is The data for the event sent to
window (client only). |
static Keyword |
AR_KEYWORD_EVENTSRCWINID
Constants.AR_KEYWORD_EVENTSRCWINID is the window ID from which the event was
sent (client only). |
static Keyword |
AR_KEYWORD_EVENTTYPE
Constants.AR_KEYWORD_EVENTTYPE is the type or name of event received by the
window (client only). |
static Keyword |
AR_KEYWORD_FIELDHELP
Current Field Help (client only) in the Help Text
tab of the Field Properties window.
|
static Keyword |
AR_KEYWORD_FIELDID
Constants.AR_KEYWORD_FIELDID returns the field ID for the currently
selected field (client only). |
static Keyword |
AR_KEYWORD_FIELDLABEL
Constants.AR_KEYWORD_FIELDLABEL returns the field label for the currently
selected field (client only). |
static Keyword |
AR_KEYWORD_FIELDNAME
Constants.AR_KEYWORD_FIELDNAME returns the field name for the currently
selected field (client only). |
static Keyword |
AR_KEYWORD_GROUPIDS
Constants.AR_KEYWORD_GROUPIDS are the ids for groups which the current user is a member (returns an
empty string for escalations). |
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_INBULKTRANS
Constants.AR_KEYWORD_INBULKTRANS indicates if currently in a bulk
entry transaction. |
static Keyword |
AR_KEYWORD_INCLNTMANAGEDTRANS
Constants.AR_KEYWORD_INCLNTMANAGEDTRANS is additional appended message(if any) of the error above. |
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_LASTOPENEDWINID
Constants.AR_KEYWORD_LASTOPENEDWINID returns the window ID from the last open
window action (client only). |
static Keyword |
AR_KEYWORD_LOCALE
Constants.AR_KEYWORD_LOCALE is the user locale. |
static Keyword |
AR_KEYWORD_NO
Constants.AR_KEYWORD_NO is No more keywords. |
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_ROLES
Constants.AR_KEYWORD_ROLES is the set of roles the current user is a member of. |
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_ROWVISIBLE
Constants.AR_KEYWORD_ROWVISIBLE indicates if row in a table is visible
(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_SERVERTIMESTAMP
Constants.AR_KEYWORD_SERVERTIMESTAMP is the current date/time on
the server (same as AR_KEYWORD_TIMESTAMP on server). |
static Keyword |
AR_KEYWORD_SHIFT_KEY
Constants.AR_KEYWORD_SHIFT_KEY is set when user has pressed SHIFT key while opening a link. |
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. |
static int |
IS_CONSTANT |
static int |
IS_FUNCTION |
static int |
IS_INTEGER |
static int |
IS_TEMPORAL |
static int |
IS_TIME_RELATED |
static int |
NEEDS_FIELDID |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(Object obj)
Use this method for checking equality of Keyword.
|
int |
getAsFieldID() |
int |
hashCode() |
boolean |
isTimeRelated() |
int |
toInt()
Returns the integer value of the keyword (constants).
|
static Keyword |
toKeyword(int n) |
static Keyword |
toKeyword(String keyword)
Converts given string into Keyword.
|
String |
toString()
Returns a string description of the object.
|
public static final Keyword AR_KEYWORD_DEFAULT
Constants.AR_KEYWORD_DEFAULT
is the the
administrator-defined default for the fieldpublic static final Keyword AR_KEYWORD_USER
Constants.AR_KEYWORD_USER
is the current user login.public static final Keyword AR_KEYWORD_TIMESTAMP
Constants.AR_KEYWORD_TIMESTAMP
is the current date/time.public static final Keyword AR_KEYWORD_TIME_ONLY
Constants.AR_KEYWORD_TIME_ONLY
is the current time (date defaults to today).public static final Keyword AR_KEYWORD_DATE_ONLY
Constants.AR_KEYWORD_DATE_ONLY
is the current date (time defaults to midnight).public static final Keyword AR_KEYWORD_SCHEMA
Constants.AR_KEYWORD_SCHEMA
is the name of the current form.public static final Keyword AR_KEYWORD_SERVER
Constants.AR_KEYWORD_SERVER
is the name of the current AR System server.public static final Keyword AR_KEYWORD_WEEKDAY
Constants.AR_KEYWORD_WEEKDAY
is the current day of the week as a character string.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).public static final Keyword AR_KEYWORD_OPERATION
Constants.AR_KEYWORD_OPERATION
is the current operation (for example, CREATE).public static final Keyword AR_KEYWORD_HARDWARE
Constants.AR_KEYWORD_HARDWARE
is the hardware on which the process is running.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.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.public static final Keyword AR_KEYWORD_LASTID
Constants.AR_KEYWORD_LASTID
is the keyword contains the Request ID
of the most recently created request during the user's login
environment.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.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.public static final Keyword AR_KEYWORD_VUI
public static final Keyword AR_KEYWORD_GUIDETEXT
public static final Keyword AR_KEYWORD_FIELDHELP
public static final Keyword AR_KEYWORD_GUIDE
$NULL$
if
no guide is running.)public static final Keyword AR_KEYWORD_APPLICATION
$NULL$
if no application is running.)public static final Keyword AR_KEYWORD_LOCALE
Constants.AR_KEYWORD_LOCALE
is the user locale.public static final Keyword AR_KEYWORD_CLIENT_TYPE
Constants.AR_KEYWORD_CLIENT_TYPE
is the client type of the api program.public static final Keyword AR_KEYWORD_SCHEMA_ALIAS
Constants.AR_KEYWORD_SCHEMA_ALIAS
is the alias name for the current form.public static final Keyword AR_KEYWORD_ROWSELECTED
Constants.AR_KEYWORD_ROWSELECTED
indicates if a row in table field was selected (client only).public static final Keyword AR_KEYWORD_ROWCHANGED
Constants.AR_KEYWORD_ROWCHANGED
indicates if a row in table field was changed (client only).public static final Keyword AR_KEYWORD_BROWSER
Constants.AR_KEYWORD_BROWSER
is the browser type (client only).public static final Keyword AR_KEYWORD_VUI_TYPE
Constants.AR_KEYWORD_VUI_TYPE
is the VUI type.public static final Keyword AR_KEYWORD_TCPPORT
Constants.AR_KEYWORD_TCPPORT
is the TCP/IP Port of the local AR System server.public static final Keyword AR_KEYWORD_HOMEURL
Constants.AR_KEYWORD_HOMEURL
is the base location of the mid tier install.public static final Keyword AR_KEYWORD_ROLES
Constants.AR_KEYWORD_ROLES
is the set of roles the current user is a member of.public static final Keyword AR_KEYWORD_EVENTTYPE
Constants.AR_KEYWORD_EVENTTYPE
is the type or name of event received by the
window (client only).public static final Keyword AR_KEYWORD_EVENTSRCWINID
Constants.AR_KEYWORD_EVENTSRCWINID
is the window ID from which the event was
sent (client only).public static final Keyword AR_KEYWORD_CURRENTWINID
Constants.AR_KEYWORD_CURRENTWINID
returns the window id of the current window
(client only)public static final Keyword AR_KEYWORD_LASTOPENEDWINID
Constants.AR_KEYWORD_LASTOPENEDWINID
returns the window ID from the last open
window action (client only).public static final Keyword AR_KEYWORD_INBULKTRANS
Constants.AR_KEYWORD_INBULKTRANS
indicates if currently in a bulk
entry transaction.public static final Keyword AR_KEYWORD_FIELDID
Constants.AR_KEYWORD_FIELDID
returns the field ID for the currently
selected field (client only).public static final Keyword AR_KEYWORD_FIELDNAME
Constants.AR_KEYWORD_FIELDNAME
returns the field name for the currently
selected field (client only).public static final Keyword AR_KEYWORD_FIELDLABEL
Constants.AR_KEYWORD_FIELDLABEL
returns the field label for the currently
selected field (client only).public static final Keyword AR_KEYWORD_SERVERTIMESTAMP
Constants.AR_KEYWORD_SERVERTIMESTAMP
is the current date/time on
the server (same as AR_KEYWORD_TIMESTAMP on server).public static final Keyword AR_KEYWORD_GROUPIDS
Constants.AR_KEYWORD_GROUPIDS
are the ids for groups which the current user is a member (returns an
empty string for escalations).public static final Keyword AR_KEYWORD_EVENTDATA
Constants.AR_KEYWORD_EVENTDATA
is The data for the event sent to
window (client only).public static final Keyword AR_KEYWORD_ERRNO
Constants.AR_KEYWORD_ERRNO
is errorcode of the current action.
Relevant in both filter and activelink error handlerpublic static final Keyword AR_KEYWORD_ERRMSG
Constants.AR_KEYWORD_ERRMSG
is error message of the current action.
Relevant in both filter and activelink error handlerpublic static final Keyword AR_KEYWORD_ERRAPPENDMSG
Constants.AR_KEYWORD_ERRAPPENDMSG
is additional appended message(if any) of the error above.
Relevant in both filter and activelink error handlerpublic static final Keyword AR_KEYWORD_INCLNTMANAGEDTRANS
Constants.AR_KEYWORD_INCLNTMANAGEDTRANS
is additional appended message(if any) of the error above.
Relevant in filter error handlerpublic static final Keyword AR_KEYWORD_DRAGSRCFIELDID
Constants.AR_KEYWORD_DRAGSRCFIELDID
is field ID of source field for drag operation.
(client only)public static final Keyword AR_KEYWORD_DROPTGTFIELDID
Constants.AR_KEYWORD_DROPTGTFIELDID
is field ID of destination field for drop operation.
(client only)public static final Keyword AR_KEYWORD_SHIFT_KEY
Constants.AR_KEYWORD_SHIFT_KEY
is set when user has pressed SHIFT key while opening a link.
(client only)public static final Keyword AR_KEYWORD_CTRL_KEY
Constants.AR_KEYWORD_CTRL_KEY
is set when user has pressed CONTROL key while opening a link.
(client only)public static final Keyword AR_KEYWORD_ALT_KEY
Constants.AR_KEYWORD_ALT_KEY
is set when user has pressed ALT key while opening a link.
(client only)public static final Keyword AR_KEYWORD_AUTHSTRING
Constants.AR_KEYWORD_AUTHSTRING
is the authString.
(client only)public static final Keyword AR_KEYWORD_ROWVISIBLE
Constants.AR_KEYWORD_ROWVISIBLE
indicates if row in a table is visible
(client only)public static final Keyword AR_KEYWORD_NO
Constants.AR_KEYWORD_NO
is No more keywords. Returns NO!public static final int IS_INTEGER
public static final int IS_CONSTANT
public static final int IS_TEMPORAL
public static final int IS_TIME_RELATED
public static final int IS_FUNCTION
public static final int NEEDS_FIELDID
public int toInt()
public String toString()
public static Keyword toKeyword(String keyword)
keyword
- Keyword
public static Keyword toKeyword(int n)
public boolean equals(Object obj)
public int getAsFieldID()
public boolean isTimeRelated()
? Copyright 2013 BMC Software, Inc.