com.remedy.arsys.api
Class ActiveLinkCriteria

java.lang.Object
  com.remedy.arsys.api.CriteriaFlags
      com.remedy.arsys.api.ActiveLinkCriteria

public class ActiveLinkCriteria

extends CriteriaFlags

The ActiveLinkCriteria class is used to specify the list of ActiveLink information to retrieve on a findByKey or findObjects call from the AR System server.

Field Summary

static int	ACTION_LIST Returns If list of specified active link.
static int	CHANGE_DIARY Returns change diary of specified active link.
static int	CONTROL_FIELD Returns ID of field that represents the button, toolbar button, or menu item associated with executing the specified active link.
static int	ELSE_LIST Returns Else list of specified active link.
static int	ENABLE Returns information whether specified active link is disabled or enabled.
static int	EXECUTE_MASK Returns form operations that trigger the specified active link.
static int	FOCUS_FIELD Returns ID of field that executes the specified active link by pressing Return or selecting a character menu item.
static int	HELP_TEXT Returns help text of specified active link.
static int	LAST_CHANGED Returns user who made last change to specified active link.
static int	NAME Returns the name of the specified active link.
static int	ORDER Returns execution order (from 0 to 1000) of specified active link.
static int	OWNER Returns owning user of specified active link.
static int	PERMISSIONS Returns list of groups who can access specified active link.
static int	PROPERTY_LIST Returns object property tags of specified active link.
static int	QUERY Returns qualifications which execute the specified active link.
static int	TIMESTAMP Returns time stamp of specified active link.
static int	WORKFLOW_CONNECT Returns list of forms connected to specified active link.

Constructor Summary

ActiveLinkCriteria()

Methods inherited from class com.remedy.arsys.api.CriteriaFlags

getParameters, getPropertiesToRetrieve, resetChangeFlags, setParameter, setPropertiesToRetrieve, setRetrieveAll

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final int NAME

Returns the name of the specified active link.

ORDER

public static final int ORDER

Returns execution order (from 0 to 1000) of specified active link. When multiple active links are associated with a form, the value associated with each active link determines the order in which they are processed (from lowest to highest).

WORKFLOW_CONNECT

public static final int WORKFLOW_CONNECT

Returns list of forms connected to specified active link. The active link must be associated with a single form or a list of forms that currently exists on the server.

PERMISSIONS

public static final int PERMISSIONS

Returns list of groups who can access specified active link. Access to this information is limited to users with AR System administrator privileges only.

EXECUTE_MASK

public static final int EXECUTE_MASK

Returns form operations that trigger the specified active link.

CONTROL_FIELD

public static final int CONTROL_FIELD

Returns ID of field that represents the button, toolbar button, or menu item associated with executing the specified active link.

FOCUS_FIELD

public static final int FOCUS_FIELD

Returns ID of field that executes the specified active link by pressing Return or selecting a character menu item.

ENABLE

public static final int ENABLE

Returns information whether specified active link is disabled or enabled.

QUERY

public static final int QUERY

Returns qualifications which execute the specified active link.

ACTION_LIST

public static final int ACTION_LIST

Returns If list of specified active link. This list can contain from 1 to 25 actions.

ELSE_LIST

public static final int ELSE_LIST

Returns Else list of specified active link. This list can contain from 1 to 25 actions.

HELP_TEXT

public static final int HELP_TEXT

Returns help text of specified active link.

TIMESTAMP

public static final int TIMESTAMP

Returns time stamp of specified active link.

OWNER

public static final int OWNER

Returns owning user of specified active link.

LAST_CHANGED

public static final int LAST_CHANGED

Returns user who made last change to specified active link.

CHANGE_DIARY

public static final int CHANGE_DIARY

Returns change diary of specified active link.

PROPERTY_LIST

public static final int PROPERTY_LIST

Returns object property tags of specified active link. These are defined by AR System. You can use the following constants:

• Constants.AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, ? BMC Software.?
• Constants.AR_OPROP_VENDOR_PRODUCT: (CHAR): Indicates the product name. For example, ? AR System.?
• Constants.AR_OPROP_VENDOR_VERSION: (CHAR): Indicates the vendor version. For example, ? 6.0?
• Constants.AR_OPROP_GUID: (CHAR): Indicates the globally unique identifier for the object.
• Constants.AR_OPROP_COPYRIGHT: (CHAR): Indicates the copyright string.
• Constants.AR_OPROP_SCC_LOCKED_BY:(CHAR): Indicates the name of user who has locked the object.
• Constants.AR_OPROP_SCC_VERSION: (CHAR): Indicates the version of the Source Code Control (SCC) system.
• Constants.AR_OPROP_SCC_TIMESTAMP: (TIME): Indicates the SCC timestamp.
• Constants.AR_OPROP_SCC_USER: (CHAR): Indicates the SCC username.
• Constants.AR_OPROP_SCC_LOCATION: (CHAR): Indicates the location within the SCC system where the object may be found.
• Constants.AR_OPROP_SCC_DATA_LOCKED_BY: (CHAR): Indicates the name of the user who has "locked" the data or entries stored in a form under revision control. The AR System server does not enforce this lock and thus it is to be considered an advisory lock only.
• Constants.AR_OPROP_SCC_DATA_VERSION: (CHAR): Indicates the SCC version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_TIMESTAMP: (CHAR): Indicates the SCC timestamp of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username for the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_LOCATION: (CHAR): Indicates the location within the SCC system where the data or entries stored in a form under revision control.

Constructor Detail

ActiveLinkCriteria

public ActiveLinkCriteria()