AR System Java API

com.bmc.arsys.api
Class ActiveLink

java.lang.Object
  extended by com.bmc.arsys.api.ObjectBase
      extended by com.bmc.arsys.api.ActiveLink
All Implemented Interfaces:
IARPersistentObject, Serializable, Cloneable

public class ActiveLink
extends ObjectBase
implements IARPersistentObject, Cloneable, Serializable

The ActiveLink class and methods are used to represent the properties of active link objects.

Note:All the constants used in the ActiveLink class are found in the Constants class.

See Also:
Serialized Form

Constructor Summary
ActiveLink()
          construct an empty activeLink instance
ActiveLink(int order, List<String> formList, List<Integer> groupList, int executeMask, int controlField, int focusField, boolean enable, QualifierInfo query, List<ActiveLinkAction> actionList, List<ActiveLinkAction> elseList, ObjectPropertyMap objPropList, String name, String helpText, int lastUpdateTime, String owner, String lastChangedBy, String diaryStr)
          construct an activelink instance with the provided characteristics
 
Method Summary
 void clear()
          Clears all of the references to member objects.
 Object clone()
          Clone implementation that returns an Object with data cloned from self
 boolean equals(Object obj)
          Use this method for checking equality between the current object and the provided one.
 List<ActiveLinkAction> getActionList()
          Returns a list of actions performed if the condition defined by the query parameter is satisfied.
 List<Integer> getAssignedGroup()
          get list of assigned group
 int getControlField()
          Returns the ID of the field that represents the button, toolbar button, or menu item associated with executing the active link.
 List<ActiveLinkAction> getElseList()
          Returns set of actions performed if the condition defined by the query parameter is not satisfied.
 String getErrorActlinkName()
           
 int getErrorActlinkOptions()
           
 int getExecuteMask()
          Returns the masks indicating the form operations that trigger the active link.
 int getFocusField()
          Returns the ID of the field associated with executing the active link by pressing Return or selecting a character menu item.
 List<String> getFormList()
          Returns the name of forms that are associated with the active link
 List<Integer> getGroupList()
          Returns the list of zero or more groups who can access this active link.
 String getKey()
          Returns the unique identifier (name) for active link.
 int getOrder()
          Returns the active link execution order.
 String getPrimaryForm()
          returns the primiary form that are associated with the active link
 ObjectPropertyMap getProperties()
          Returns a list of server object property tags.
 QualifierInfo getQualifier()
          Returns the qualification that determines which set of If/Else actions should be executed.
 int hashCode()
          Returns the hash code value for this instance of the current class.
 boolean isEnable()
          Returns the flag identifying whether the active link is disabled (0) or enabled (1).
 void setActionList(List<ActiveLinkAction> actionList)
          Sets a list of actions performed if the condition defined by the query parameter is satisfied.
 void setControlField(int controlField)
          Sets the ID of the field that represents the button, toolbar button, or menu item associated with executing the active link.
 void setElseList(List<ActiveLinkAction> elseList)
          Sets list of actions performed if the condition defined by the query parameter is not satisfied.
 void setEnable(boolean enable)
          Sets the flag identifying whether the active link is disabled (0) or enabled (1).
 void setErrorActlinkName(String errorActlinkName)
           
 void setErrorActlinkOptions(int errorActlinkOptions)
           
 void setExecuteMask(int executeMask)
          Sets the masks indicating the form operations that trigger the active link.
 void setFocusField(int focusField)
          Sets the ID of the field associated with executing the active link by pressing Return or selecting a character menu item.
 void setFormList(List<String> formList)
          Set the name of forms that are associated with the active link
 void setGroupList(List<Integer> groupList)
          Sets the list of zero or more groups who can access this active link.
 void setKey(String key)
          Sets a unique identifier (name) for active link.
 void setOrder(int order)
          Sets the active link execution order.
 void setPrimaryForm(String primaryForm)
          Sets the name of the primary form
 void setProperties(ObjectPropertyMap objPropList)
          Sets a list of server object property tags you can specify.
 void setQualifier(QualifierInfo query)
          Sets the qualification that determines which set of If/Else actions should be executed.
 String toString()
          Returns a string description of the object.
 
Methods inherited from class com.bmc.arsys.api.ObjectBase
appendDiaryText, getChangeFlags, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setChangeFlags, setDiary, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface com.bmc.arsys.api.IARPersistentObject
appendDiaryText, getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions
 

Constructor Detail

ActiveLink

public ActiveLink()
construct an empty activeLink instance


ActiveLink

public ActiveLink(int order,
                  List<String> formList,
                  List<Integer> groupList,
                  int executeMask,
                  int controlField,
                  int focusField,
                  boolean enable,
                  QualifierInfo query,
                  List<ActiveLinkAction> actionList,
                  List<ActiveLinkAction> elseList,
                  ObjectPropertyMap objPropList,
                  String name,
                  String helpText,
                  int lastUpdateTime,
                  String owner,
                  String lastChangedBy,
                  String diaryStr)
construct an activelink instance with the provided characteristics

Parameters:
order - the order of the actlink
formList - the forms that are associated to the active link
groupList - the groups that have permission to access the active link
executeMask - a bitmask indicating the form operations that trigger the active link
controlField - the id of the field that represents the button associated with executing this active link
focusField - the id of the field associated with executing the active link by pressing return.
enable - a flag to enable or disable the active link
query - a qualification that determins if the active link executes or not.
actionList - the set of actions performed if the condition defined by the query parameter is satisfied.
elseList - the set of actions performed if the condition defined by the query parameter is not satisfied.
objPropList - the object properties of the activelink
name - the name of the active link
helpText - the help text associated with the active link
lastUpdateTime - the last update time of the active link
owner - the owner for the active link
lastChangedBy - the last admin user who changed the active link
diaryStr - the change diary associated with the active link.
Method Detail

clear

public void clear()
Description copied from class: ObjectBase
Clears all of the references to member objects.

Overrides:
clear in class ObjectBase

getOrder

public int getOrder()
Returns the active link execution order.


setOrder

public void setOrder(int order)
Sets the active link execution order. Use a value between 0 and 1000 (inclusive). 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).


getExecuteMask

public int getExecuteMask()
Returns the masks indicating the form operations that trigger the active link.


setExecuteMask

public void setExecuteMask(int executeMask)
Sets the masks indicating the form operations that trigger the active link. You can use any of the following constants:
  • Constants.AR_EXECUTE_ON_EVENT executes the active link when an event has arrived.
  • Constants.AR_EXECUTE_ON_TABLE_CONTENT_CHANGE executes the active link when a Table content is changed.
  • Constants.AR_EXECUTE_ON_HOVER_FIELD_LABEL executes the active link when cursor is hovering over a field label portion.
  • Constants.AR_EXECUTE_ON_HOVER_FIELD_DATA executes the active link when cursor is hovering over a field data portion.
  • Constants.AR_EXECUTE_ON_HOVER_FIELD executes the active link when cursor is hovering over a field.


  • getControlField

    public int getControlField()
    Returns the ID of the field that represents the button, toolbar button, or menu item associated with executing the active link. The system returns zero if the executeMask does not include the Constants.AR_EXECUTE_ON_BUTTON condition.


    setControlField

    public void setControlField(int controlField)
    Sets the ID of the field that represents the button, toolbar button, or menu item associated with executing the active link.


    getFocusField

    public int getFocusField()
    Returns the ID of the field associated with executing the active link by pressing Return or selecting a character menu item. The system returns zero if the executeMask does not include the Constants.AR_EXECUTE_ON_RETURN or Constants.AR_EXECUTE_ON_MENU_CHOICE conditions.


    setFocusField

    public void setFocusField(int focusField)
    Sets the ID of the field associated with executing the active link by pressing Return or selecting a character menu item.


    isEnable

    public boolean isEnable()
    Returns the flag identifying whether the active link is disabled (0) or enabled (1).


    setEnable

    public void setEnable(boolean enable)
    Sets the flag identifying whether the active link is disabled (0) or enabled (1).


    getFormList

    public List<String> getFormList()
    Returns the name of forms that are associated with the active link


    setFormList

    public void setFormList(List<String> formList)
    Set the name of forms that are associated with the active link

    Parameters:
    formList - the form names to set

    getPrimaryForm

    public String getPrimaryForm()
    returns the primiary form that are associated with the active link


    setPrimaryForm

    public void setPrimaryForm(String primaryForm)
    Sets the name of the primary form

    Parameters:
    primaryForm - the name of the primary form

    getGroupList

    public List<Integer> getGroupList()
    Returns the list of zero or more groups who can access this active link. Access is limited to users with AR System administrator privileges only.


    setGroupList

    public void setGroupList(List<Integer> groupList)
    Sets the list of zero or more groups who can access this active link. Access is limited to users with AR System administrator privileges only.


    getQualifier

    public QualifierInfo getQualifier()
    Returns the qualification that determines which set of If/Else actions should be executed. The system returns zero (Constants.AR_COND_OP_NONE) if the active link has no qualification.


    setQualifier

    public void setQualifier(QualifierInfo query)
    Sets the qualification that determines which set of If/Else actions should be executed.


    getProperties

    public ObjectPropertyMap getProperties()
    Returns a list of server object property tags.


    setProperties

    public void setProperties(ObjectPropertyMap objPropList)
    Sets a list of server object property tags you can specify. The constant values listed below are defined by AR System:


    getActionList

    public List<ActiveLinkAction> getActionList()
    Returns a list of actions performed if the condition defined by the query parameter is satisfied.


    setActionList

    public void setActionList(List<ActiveLinkAction> actionList)
    Sets a list of actions performed if the condition defined by the query parameter is satisfied. This list can contain from 1 to 25 actions (limited by Constants.AR_MAX_ACTIONS).


    getElseList

    public List<ActiveLinkAction> getElseList()
    Returns set of actions performed if the condition defined by the query parameter is not satisfied.


    setElseList

    public void setElseList(List<ActiveLinkAction> elseList)
    Sets list of actions performed if the condition defined by the query parameter is not satisfied. This list can contain from 0 to 25 actions.


    getKey

    public String getKey()
    Returns the unique identifier (name) for active link.


    setKey

    public void setKey(String key)
    Sets a unique identifier (name) for active link.


    getErrorActlinkOptions

    public int getErrorActlinkOptions()
    Returns:
    the error activelink options

    setErrorActlinkOptions

    public void setErrorActlinkOptions(int errorActlinkOptions)
    Parameters:
    errorActlinkOptions - the m_errorActlinkOptions to set

    getErrorActlinkName

    public String getErrorActlinkName()
    Returns:
    the error active link name

    setErrorActlinkName

    public void setErrorActlinkName(String errorActlinkName)
    Parameters:
    errorActlinkName - the m_errorActlinkName to set

    clone

    public Object clone()
                 throws CloneNotSupportedException
    Clone implementation that returns an Object with data cloned from self

    Overrides:
    clone in class ObjectBase
    Throws:
    CloneNotSupportedException

    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 ObjectBase
    Parameters:
    obj - the object that we are comparing to
    Returns:
    returns a boolean that tells if the two objects equal

    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 ObjectBase

    toString

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

    Overrides:
    toString in class ObjectBase

    getAssignedGroup

    public List<Integer> getAssignedGroup()
    get list of assigned group

    Returns:
    list of assigned group

    AR System Java API

    © Copyright 2006, 2007 BMC Software, Inc.