com.remedy.arsys.api
Class ActiveLink

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

All Implemented Interfaces:

java.lang.Cloneable, IARPersistentObject

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() Peregrine 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.
boolean	equals(java.lang.Object anObject) Use this method for checking equality.
boolean	equals(java.lang.Object anObject, java.lang.String lhsServer, java.lang.String rhsServer)
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.
int	hashCode() This method can be used to populate a hash table.
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() Peregrine reserved method.
void	remove() Deletes 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() Updates this active link on the database.
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

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Method Detail

setContext

public void setContext(ARServerUser ctx)

Description copied from interface: IARPersistentObject

Associates ARServerUser information with this AR System server object.

Specified by:

setContext in interface IARPersistentObject

unsetContext

public void unsetContext()

Description copied from interface: IARPersistentObject

Removes the association to a specific user context. This is equal to setContext(null).

Specified by:

unsetContext in interface IARPersistentObject

clear

public void clear()

Description copied from interface: IARPersistentObject

Clears all of the references to member objects.

Specified by:

clear in interface IARPersistentObject

Overrides:

clear in class ObjectBase

create

public void create()
            throws ARException

Creates this object on the AR System server.

Specified by:

create in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not created

remove

public void remove()
            throws ARException

Deletes this object on the AR System server.

Specified by:

remove in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not deleted

load

public void load()
          throws ARException

Populates this object with information from the AR System server.

Specified by:

load in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not created

load

public void load(ActiveLinkCriteria criteria)
          throws ARException

Populates this object with information specified by ActiveLinkCriteria from the AR System server.

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not created

store

public void store()
           throws ARException

Updates this active link on the database.

Specified by:

store in interface IARPersistentObject

Throws:

NullPointerException - if invalid ARServerUser object

ARException - if object is not saved

activate

public void activate()

Peregrine reserved method.

Specified by:

activate in interface IARPersistentObject

passivate

public void passivate()

Peregrine reserved method.

Specified by:

passivate in interface IARPersistentObject

isPresent

public boolean isPresent()

Denotes if the field is valid.

getOrder

public long getOrder()

Returns the active link execution order.

setOrder

public void setOrder(long 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 long getExecuteMask()

Returns the masks indicating the form operations that trigger the active link.

setExecuteMask

public void setExecuteMask(long 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_NONE has no execution action for the active link.
• Constants.AR_EXECUTE_ON_BUTTON executes the active link when a user selects a button, toolbar button, or menu item specified by the controlField parameter.
• Constants.AR_EXECUTE_ON_RETURN executes the active link when a user presses Return in field specified by the focusField parameter.
• Constants.AR_EXECUTE_ON_SUBMIT executes the active link when a user submits an entry (before data is sent to the AR System server).
• Constants.AR_EXECUTE_ON_MODIFY executes the active link when a user modifies an individual entry (before data is sent to the AR System server).
• Constants.AR_EXECUTE_ON_DISPLAY executes the active link when a user displays an entry (after data is retrieved from the AR System server).
• Constants.AR_EXECUTE_ON_MENU_CHOICE executes the active link when a user selects an item from a character menu associated with a field specified by the focusField parameter or selects a row in a table field specified by the focusField parameter.
• Constants.AR_EXECUTE_ON_LOSE_FOCUS executes the active link when the focus is changed, for example by clicking in another field.
• Constants.AR_EXECUTE_ON_SET_DEFAULT executes the active link when a user sets default values (either manually or through preference settings).
• Constants.AR_EXECUTE_ON_QUERY executes the active link when a user retrieves one or more entries (before the query is sent to the AR System server).
• Constants.AR_EXECUTE_ON_AFTER_MODIFY executes the active link when a user modifies an individual entry (after data is committed to the database).
• Constants.AR_EXECUTE_ON_GAIN_FOCUS executes the active link when the specified field receives the focus.
• Constants.AR_EXECUTE_ON_AFTER_SUBMIT executes the active link when a user submits an entry (after data is committed to the database).
• Constants.AR_EXECUTE_ON_WINDOW_OPEN executes the active link when a user opens any form window or changes its mode.
• Constants.AR_EXECUTE_ON_WINDOW_CLOSE executes the active link when a user closes any form window or changes its mode.
• Constants.AR_EXECUTE_ON_UNDISPLAY executes the active link when a request is removed from the Details pane because a new request was selected in the Results pane or because the window is closing. The workflow actions execute before the new request is displayed.
• Constants.AR_EXECUTE_ON_COPY_SUBMIT executes the active link when a user chooses Edit -> Copy to New in AR System User. The active links will be executed after the data has been sent to the new window, so that the administrator has the ability to use this data in the workflow.
• Constants.AR_EXECUTE_ON_LOADED executes the active link on Submit and Search windows after all data has been loaded on the window (from defaults, from a copy to new, from an open window action).
• Constants.AR_EXECUTE_ON_INTERVAL executes the active link when a specified interval has arrived.

getControlField

public long 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(long controlField)

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

getFocusField

public long 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(long focusField)

Sets the ID of the field associated with executing the active link by pressing Return or selecting a character menu item.

getEnable

public long getEnable()

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

setEnable

public void setEnable(long enable)

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

getWorkflowConnect

public WorkflowConnectInfo getWorkflowConnect()

Returns the list of form names the active link is linked to.

setWorkflowConnect

public void setWorkflowConnect(WorkflowConnectInfo workflowConnect)

Sets the list of form names the active link is linked to. The active link must be associated with a single form or a list of forms that currently exists on the server.

getGroupList

public InternalID[] 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(InternalID[] 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.

getObjPropList

public PropInfo[] getObjPropList()

Returns a list of server object property tags you can specify.

setObjPropList

public void setObjPropList(PropInfo[] objPropList)

Sets a list of server object property tags you can specify. The constant values listed below are defined by AR System:

• Constants.AR_OPROP_VENDOR_NAME: (CHAR): Indicates the vendor name. For example, “ Peregrine Systems.”
• 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, “ 5.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 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 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 version of the data or entries stored in a form under revision control.
• Constants.AR_OPROP_SCC_DATA_USER: (TIME): Indicates the SCC username fore 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.

getActionList

public ActiveLinkActionInfo[] getActionList()

Returns a list of actions performed if the condition defined by the query parameter is satisfied.

setActionList

public void setActionList(ActiveLinkActionInfo[] 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 ActiveLinkActionInfo[] getElseList()

Returns set of actions performed if the condition defined by the query parameter is not satisfied.

setElseList

public void setElseList(ActiveLinkActionInfo[] 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 ActiveLinkKey getKey()

Returns unique identifier for active link.

setKey

public void setKey(ActiveLinkKey key)

Sets unique identifier for active link.

clone

public java.lang.Object clone()
                       throws java.lang.CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class ObjectBase

equals

public boolean equals(java.lang.Object anObject)

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

Overrides:

equals in class ObjectBase

equals

public boolean equals(java.lang.Object anObject,
                      java.lang.String lhsServer,
                      java.lang.String rhsServer)

hashCode

public int hashCode()

This method can be used to populate a hash table. Implicitly used method to test equality of objects.

Overrides:

hashCode in class ObjectBase