AR System Java API

com.bmc.arsys.api
Class Keyword

java.lang.Object
  extended by com.bmc.arsys.api.Keyword
All Implemented Interfaces:
Serializable

public class Keyword
extends Object
implements Serializable

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

See Also:
Serialized Form

Field Summary
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
           
 
Method Summary
 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 str)
          Converts given string into Keyword.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class java.lang.Object
getClass, 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.


AR_KEYWORD_ROLES

public static final Keyword AR_KEYWORD_ROLES
Constants.AR_KEYWORD_ROLES is the set of roles the current user is a member of.


AR_KEYWORD_EVENTTYPE

public static final Keyword AR_KEYWORD_EVENTTYPE
Constants.AR_KEYWORD_EVENTTYPE is the type or name of event received by the window (client only).


AR_KEYWORD_EVENTSRCWINID

public static final Keyword AR_KEYWORD_EVENTSRCWINID
Constants.AR_KEYWORD_EVENTSRCWINID is the window ID from which the event was sent (client only).


AR_KEYWORD_CURRENTWINID

public static final Keyword AR_KEYWORD_CURRENTWINID
Constants.AR_KEYWORD_CURRENTWINID returns the window id of the current window (client only)


AR_KEYWORD_LASTOPENEDWINID

public static final Keyword AR_KEYWORD_LASTOPENEDWINID
Constants.AR_KEYWORD_LASTOPENEDWINID returns the window ID from the last open window action (client only).


AR_KEYWORD_INBULKTRANS

public static final Keyword AR_KEYWORD_INBULKTRANS
Constants.AR_KEYWORD_INBULKTRANS indicates if currently in a bulk entry transaction.


AR_KEYWORD_FIELDID

public static final Keyword AR_KEYWORD_FIELDID
Constants.AR_KEYWORD_FIELDID returns the field ID for the currently selected field (client only).


AR_KEYWORD_FIELDNAME

public static final Keyword AR_KEYWORD_FIELDNAME
Constants.AR_KEYWORD_FIELDNAME returns the field name for the currently selected field (client only).


AR_KEYWORD_FIELDLABEL

public static final Keyword AR_KEYWORD_FIELDLABEL
Constants.AR_KEYWORD_FIELDLABEL returns the field label for the currently selected field (client only).


AR_KEYWORD_SERVERTIMESTAMP

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).


AR_KEYWORD_GROUPIDS

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).


AR_KEYWORD_EVENTDATA

public static final Keyword AR_KEYWORD_EVENTDATA
Constants.AR_KEYWORD_EVENTDATA is The data for the event sent to window (client only).


AR_KEYWORD_ERRNO

public static final Keyword AR_KEYWORD_ERRNO
Constants.AR_KEYWORD_ERRNO is errorcode of the current action. Relevant in both filter and activelink error handler


AR_KEYWORD_ERRMSG

public static final Keyword AR_KEYWORD_ERRMSG
Constants.AR_KEYWORD_ERRMSG is error message of the current action. Relevant in both filter and activelink error handler


AR_KEYWORD_ERRAPPENDMSG

public 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 handler


AR_KEYWORD_INCLNTMANAGEDTRANS

public static final Keyword AR_KEYWORD_INCLNTMANAGEDTRANS
Constants.AR_KEYWORD_INCLNTMANAGEDTRANS is additional appended message(if any) of the error above. Relevant in filter error handler


AR_KEYWORD_DRAGSRCFIELDID

public static final Keyword AR_KEYWORD_DRAGSRCFIELDID
Constants.AR_KEYWORD_DRAGSRCFIELDID is field ID of source field for drag operation. (client only)


AR_KEYWORD_DROPTGTFIELDID

public static final Keyword AR_KEYWORD_DROPTGTFIELDID
Constants.AR_KEYWORD_DROPTGTFIELDID is field ID of destination field for drop operation. (client only)


AR_KEYWORD_SHIFT_KEY

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)


AR_KEYWORD_CTRL_KEY

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)


AR_KEYWORD_ALT_KEY

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)


AR_KEYWORD_AUTHSTRING

public static final Keyword AR_KEYWORD_AUTHSTRING
Constants.AR_KEYWORD_AUTHSTRING is the authString. (client only)


AR_KEYWORD_ROWVISIBLE

public static final Keyword AR_KEYWORD_ROWVISIBLE
Constants.AR_KEYWORD_ROWVISIBLE indicates if row in a table is visible (client only)


AR_KEYWORD_NO

public static final Keyword AR_KEYWORD_NO
Constants.AR_KEYWORD_NO is No more keywords. Returns NO!


IS_INTEGER

public static final int IS_INTEGER
See Also:
Constant Field Values

IS_CONSTANT

public static final int IS_CONSTANT
See Also:
Constant Field Values

IS_TEMPORAL

public static final int IS_TEMPORAL
See Also:
Constant Field Values

IS_TIME_RELATED

public static final int IS_TIME_RELATED
See Also:
Constant Field Values

IS_FUNCTION

public static final int IS_FUNCTION
See Also:
Constant Field Values

NEEDS_FIELDID

public static final int NEEDS_FIELDID
See Also:
Constant Field Values
Method Detail

toInt

public int toInt()
Returns the integer value of the keyword (constants).


toString

public String toString()
Returns a string description of the object.

Overrides:
toString in class Object

toKeyword

public static Keyword toKeyword(String str)
Converts given string into Keyword. If the string is not a valid Keyword then null will be returned.

Parameters:
str -
Returns:
Keyword

toKeyword

public static Keyword toKeyword(int n)

equals

public boolean equals(Object obj)
Use this method for checking equality of Keyword. The result is true only if the argument is not null and is a Keyword object that represents the same content.

Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

getAsFieldID

public int getAsFieldID()

isTimeRelated

public boolean isTimeRelated()

AR System Java API

© Copyright 2006, 2007 BMC Software, Inc.