Action Request System Java API: Class ActiveLink

Overview

Package

Class

Tree

Deprecated

Index

Help

Action Request System Java API

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.remedy.arsys.api
Class ActiveLink

java.lang.Object
  |
  +--com.remedy.arsys.api.ObjectBase
        |
        +--com.remedy.arsys.api.ActiveLink

public class ActiveLink
extends ObjectBase
implements IARPersistentObject, java.lang.Cloneable

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.

Fields inherited from class com.remedy.arsys.api.ObjectBase

m_changeFlags

Method Summary

void activate()
          Remedy reserved method.

void clear()
          Clears all of the references to member objects.

java.lang.Object clone()
          Clone implementation that returns an Object with data cloned from self

void create()
          Creates this object on the AR System server.

ActiveLinkActionInfo[] getActionList()
          Returns a list of actions performed if the condition defined by the query parameter is satisfied.

long getControlField()
          Returns the ID of the field that represents the button, toolbar button, or menu item associated with executing the active link.

ActiveLinkActionInfo[] getElseList()
          Returns set of actions performed if the condition defined by the query parameter is not satisfied.

long getEnable()
          Returns the flag identifying whether the active link is disabled (0) or enabled (1).

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

long getFocusField()
          Returns the ID of the field associated with executing the active link by pressing Return or selecting a character menu item.

InternalID[] getGroupList()
          Returns the list of zero or more groups who can access this active link.

ActiveLinkKey getKey()
          Returns unique identifier for active link.

PropInfo[] getObjPropList()
          Returns a list of server object property tags you can specify.

long getOrder()
          Returns the active link execution order.

QualifierInfo getQualifier()
          Returns the qualification that determines which set of If/Else actions should be executed.

WorkflowConnectInfo getWorkflowConnect()
          Returns the list of form names the active link is linked to.

boolean isPresent()
          Denotes if the field is valid.

void load()
          Populates this object with information from the AR System server.

void load(ActiveLinkCriteria criteria)
          Populates this object with information specified by ActiveLinkCriteria from the AR System server.

void passivate()
          Remedy reserved method.

void remove()
          Removes this object on the AR System server.

void setActionList(ActiveLinkActionInfo[] actionList)
          Sets a list of actions performed if the condition defined by the query parameter is satisfied.

void setContext(ARServerUser ctx)
          Associates ARServerUser information with this AR System server object.

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

void setElseList(ActiveLinkActionInfo[] elseList)
          Sets list of actions performed if the condition defined by the query parameter is not satisfied.

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

void setExecuteMask(long executeMask)
          Sets the masks indicating the form operations that trigger the active link.

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

void setGroupList(InternalID[] groupList)
          Sets the list of zero or more groups who can access this active link.

void setKey(ActiveLinkKey key)
          Sets unique identifier for active link.

void setObjPropList(PropInfo[] objPropList)
          Sets a list of server object property tags you can specify.

void setOrder(long order)
          Sets the active link execution order.

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

void setWorkflowConnect(WorkflowConnectInfo workflowConnect)
          Sets the list of form names the active link is linked to.

void store()
          Saves the changes made to this object specified by ActiveLinkCriteria on the AR System server.

void unsetContext()
          Removes the association to a specific user context.

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

getDiary, getHelpText, getLastChangedBy, getLastUpdateTime, getName, getNewName, getOwner, getPermissions, resetChangeFlags, setDiary, setHelpText, setLastChangedBy, setName, setNewName, setOwner, setPermissions

Methods inherited from class java.lang.Object

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

Method Detail