com.bmc.arsys.api
Class ActiveLinkCriteria

java.lang.Object
  com.bmc.arsys.api.CriteriaFlags
      com.bmc.arsys.api.ObjectBaseCriteria
          com.bmc.arsys.api.ActiveLinkCriteria

All Implemented Interfaces:

Serializable, Cloneable

public class ActiveLinkCriteria
extends ObjectBaseCriteria
implements Serializable

The ActiveLinkCriteria class is used to specify the list of ActiveLink information to retrieve call from the AR System server.

See Also:

Serialized Form

Field Summary

static int	ACTION_LIST Returns If list of specified active link.
static int	ASSIGNED_GROUPS Returns the assigned groups for 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	DEFAULT_CRITERIA The default criteria -- allows for setting all other criteria flags.
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	ERROR_ACTLINK_NAME Returns the error handler active link name
static int	ERROR_ACTLINK_OPT Returns the error handler active link option
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	ORDER Returns execution order (from 0 to 1000) of specified active link.
static int	QUERY Returns qualifications which execute the specified active link.
int	USE_REALNAME Overlay: Returns active link with real name.
static int	WORKFLOW_CONNECT Returns list of forms connected to specified active link.

Fields inherited from class com.bmc.arsys.api.ObjectBaseCriteria

CHANGE_DIARY, HELP_TEXT, LAST_CHANGED, NAME, OWNER, PERMISSIONS, PROPERTY_LIST, TIMESTAMP

Constructor Summary

ActiveLinkCriteria()

Method Summary

boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
int	hashCode() Returns the hash code value for this instance of the current class.
String	toString() Returns a string description of the object.

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

clone, getParameters, getPropertiesToRetrieve, resetCriteriaFlags, setParameter, setPropertiesToRetrieve, setRetrieveAll

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

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.

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.

ERROR_ACTLINK_OPT

public static final int ERROR_ACTLINK_OPT

Returns the error handler active link option

ERROR_ACTLINK_NAME

public static final int ERROR_ACTLINK_NAME

Returns the error handler active link name

ASSIGNED_GROUPS

public static final int ASSIGNED_GROUPS

Returns the assigned groups for active link

USE_REALNAME

public final int USE_REALNAME

Overlay: Returns active link with real name.

DEFAULT_CRITERIA

public static final int DEFAULT_CRITERIA

The default criteria -- allows for setting all other criteria flags.

Constructor Detail

ActiveLinkCriteria

public ActiveLinkCriteria()

Method Detail

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class ObjectBaseCriteria

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class ObjectBaseCriteria

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class ObjectBaseCriteria

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal