com.remedy.arsys.api
Class ActiveLinkActionInfo

java.lang.Object
  com.remedy.arsys.api.ActiveLinkActionInfo

All Implemented Interfaces:

java.lang.Cloneable

public class ActiveLinkActionInfo

extends java.lang.Object

implements java.lang.Cloneable

The ActiveLinkActionInfo class and methods are used for implementing active link actions.

Field Summary

static int	AR_ACTIVE_LINK_ACTION_AUTO Performs the specified OLE automation.
static int	AR_ACTIVE_LINK_ACTION_CALLGUIDE Performs the specified guide.
static int	AR_ACTIVE_LINK_ACTION_CLOSEWND Closes a dialog or schema window.
static int	AR_ACTIVE_LINK_ACTION_COMMITC Commits changes from a dialog to the parent schema window.
static int	AR_ACTIVE_LINK_ACTION_DDE Performs the specified DDE action.
static int	AR_ACTIVE_LINK_ACTION_EXITGUIDE Exits the current guide or all guides.
static int	AR_ACTIVE_LINK_ACTION_FIELDP Transfers, or pushes, data from a field in the current schema to another schema.
static int	AR_ACTIVE_LINK_ACTION_FIELDS Sets values for the specified fields.
static int	AR_ACTIVE_LINK_ACTION_GOTOACTION Goes to the active link with the specified execution order.
static int	AR_ACTIVE_LINK_ACTION_GOTOGUIDELABEL Goes to the specified active link within current guide.
static int	AR_ACTIVE_LINK_ACTION_MACRO Executes specified macro
static int	AR_ACTIVE_LINK_ACTION_MESSAGE Displays the specified message.
static int	AR_ACTIVE_LINK_ACTION_NONE No action taken.
static int	AR_ACTIVE_LINK_ACTION_OPENDLG Opens a schema as a modal dialog.
static int	AR_ACTIVE_LINK_ACTION_PROCESS Executes the specified command.
static int	AR_ACTIVE_LINK_ACTION_SET_CHAR Sets characteristics for the specified field.
static int	AR_ACTIVE_LINK_ACTION_SQL Performs the specified SQL statements.
static int	AR_ACTIVE_LINK_ACTION_WAIT Causes the current guide to wait for user input.

Constructor Summary

ActiveLinkActionInfo()
constructor

ActiveLinkActionInfo(int action, ActiveLinkMacroInfo macro, SetFieldsActionInfo setFields, java.lang.String process, MessageInfo message, FieldCharacteristicsInfo characteristics, DDEInfo dde, PushFieldsActionInfo pushFields, SQLInfo sqlCommand, AutomationInfo automation, OpenDialogInfo openDlg, CommitChangesInfo commitChanges, CloseWindowInfo closeWnd, CallGuideInfo callGuide, ExitGuideInfo exitGuide, GotoGuideLabelInfo gotoGuide, WaitInfo waitAction, GotoActionInfo gotoAction)

Method Summary

java.lang.Object	clone() Clone implementation that returns an Object with data cloned from self
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 lhsSchema, java.lang.String rhsServer, java.lang.String rhsSchema)
int	getAction() Indicates type of action you want to retrieve.
AutomationInfo	getAutomation() Returns information about OLE Automation active link action.
CallGuideInfo	getCallGuide() Returns information about Call Guide active link action.
FieldCharacteristicsInfo	getCharacteristics() Returns information about Change Field active link action.
CloseWindowInfo	getCloseWnd() Returns information about Close Window active link action.
CommitChangesInfo	getCommitChanges() Returns information about Commit Changes active link action.
DDEInfo	getDde() Returns information about DDE active link action.
ExitGuideInfo	getExitGuide() Returns information about Exit Guide active link action.
GotoActionInfo	getGotoAction() Returns information about GoTo active link action.
GotoGuideLabelInfo	getGotoGuide() Returns information about Go to Guide active link action.
ActiveLinkMacroInfo	getMacro() Returns information about Run Macro active link action.
MessageInfo	getMessage() Returns information about Message active link action.
OpenDialogInfo	getOpenDlg() Returns information about Open Dialog active link action.
java.lang.String	getProcess() Returns information about Run Process active link action.
PushFieldsActionInfo	getPushFields() Returns information about Push Fields active link action.
SetFieldsActionInfo	getSetFields() Returns information about Set Fields active link action.
SQLInfo	getSqlCommand() Returns information about Direct SQL active link action.
WaitInfo	getWaitAction() Returns information about Wait Action active link action.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setAction(int action) Sets type of action you want to fill.
void	setAutomation(AutomationInfo automation) Sets values for OLE Automation active link action.
void	setCallGuide(CallGuideInfo callGuide) Sets values for Call Guide active link action.
void	setCharacteristics(FieldCharacteristicsInfo characteristics) Sets values for Change Field active link action.
void	setCloseWnd(CloseWindowInfo closeWnd) Sets values for Close Window active link action.
void	setCommitChanges(CommitChangesInfo commitChanges) Sets values for Commit Changes active link action.
void	setDde(DDEInfo dde) Sets values for DDE active link action.
void	setExitGuide(ExitGuideInfo exitGuide) Sets values for Exit Guide active link action.
void	setGotoAction(GotoActionInfo gotoAction) Sets values for GoTo active link action.
void	setGotoGuide(GotoGuideLabelInfo gotoGuide) Sets values for Go to Guide active link action.
void	setMacro(ActiveLinkMacroInfo macro) Sets values for Run Macro active link action.
void	setMessage(MessageInfo message) Sets values for Message active link action.
void	setOpenDlg(OpenDialogInfo openDlg) Sets values for Open Dialog active link action.
void	setProcess(java.lang.String process) Sets values for Run Process active link action.
void	setPushFields(PushFieldsActionInfo pushFields) Sets values for Push Fields active link action.
void	setSetFields(SetFieldsActionInfo setFields) Sets values for Set Fields active link action.
void	setSqlCommand(SQLInfo sqlCommand) Sets values for Direct SQL active link action.
void	setWaitAction(WaitInfo waitAction) Sets values for Wait Action active link action.

Methods inherited from class java.lang.Object

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

Field Detail

AR_ACTIVE_LINK_ACTION_NONE

public static final int AR_ACTIVE_LINK_ACTION_NONE

No action taken.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_MACRO

public static final int AR_ACTIVE_LINK_ACTION_MACRO

Executes specified macro

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_FIELDS

public static final int AR_ACTIVE_LINK_ACTION_FIELDS

Sets values for the specified fields.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_PROCESS

public static final int AR_ACTIVE_LINK_ACTION_PROCESS

Executes the specified command.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_MESSAGE

public static final int AR_ACTIVE_LINK_ACTION_MESSAGE

Displays the specified message.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_SET_CHAR

public static final int AR_ACTIVE_LINK_ACTION_SET_CHAR

Sets characteristics for the specified field.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_DDE

public static final int AR_ACTIVE_LINK_ACTION_DDE

Performs the specified DDE action.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_FIELDP

public static final int AR_ACTIVE_LINK_ACTION_FIELDP

Transfers, or pushes, data from a field in the current schema to another schema.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_SQL

public static final int AR_ACTIVE_LINK_ACTION_SQL

Performs the specified SQL statements.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_AUTO

public static final int AR_ACTIVE_LINK_ACTION_AUTO

Performs the specified OLE automation.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_OPENDLG

public static final int AR_ACTIVE_LINK_ACTION_OPENDLG

Opens a schema as a modal dialog.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_COMMITC

public static final int AR_ACTIVE_LINK_ACTION_COMMITC

Commits changes from a dialog to the parent schema window.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_CLOSEWND

public static final int AR_ACTIVE_LINK_ACTION_CLOSEWND

Closes a dialog or schema window.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_CALLGUIDE

public static final int AR_ACTIVE_LINK_ACTION_CALLGUIDE

Performs the specified guide.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_EXITGUIDE

public static final int AR_ACTIVE_LINK_ACTION_EXITGUIDE

Exits the current guide or all guides.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_GOTOGUIDELABEL

public static final int AR_ACTIVE_LINK_ACTION_GOTOGUIDELABEL

Goes to the specified active link within current guide.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_WAIT

public static final int AR_ACTIVE_LINK_ACTION_WAIT

Causes the current guide to wait for user input.

See Also:

Constant Field Values

AR_ACTIVE_LINK_ACTION_GOTOACTION

public static final int AR_ACTIVE_LINK_ACTION_GOTOACTION

Goes to the active link with the specified execution order.

See Also:

Constant Field Values

Constructor Detail

ActiveLinkActionInfo

public ActiveLinkActionInfo()

constructor

ActiveLinkActionInfo

public ActiveLinkActionInfo(int action,
                            ActiveLinkMacroInfo macro,
                            SetFieldsActionInfo setFields,
                            java.lang.String process,
                            MessageInfo message,
                            FieldCharacteristicsInfo characteristics,
                            DDEInfo dde,
                            PushFieldsActionInfo pushFields,
                            SQLInfo sqlCommand,
                            AutomationInfo automation,
                            OpenDialogInfo openDlg,
                            CommitChangesInfo commitChanges,
                            CloseWindowInfo closeWnd,
                            CallGuideInfo callGuide,
                            ExitGuideInfo exitGuide,
                            GotoGuideLabelInfo gotoGuide,
                            WaitInfo waitAction,
                            GotoActionInfo gotoAction)

Method Detail

getMacro

public ActiveLinkMacroInfo getMacro()

Returns information about Run Macro active link action.

setMacro

public void setMacro(ActiveLinkMacroInfo macro)

Sets values for Run Macro active link action.

getSetFields

public SetFieldsActionInfo getSetFields()

Returns information about Set Fields active link action.

setSetFields

public void setSetFields(SetFieldsActionInfo setFields)

Sets values for Set Fields active link action.

getProcess

public java.lang.String getProcess()

Returns information about Run Process active link action.

setProcess

public void setProcess(java.lang.String process)

Sets values for Run Process active link action.

getMessage

public MessageInfo getMessage()

Returns information about Message active link action.

setMessage

public void setMessage(MessageInfo message)

Sets values for Message active link action.

getCharacteristics

public FieldCharacteristicsInfo getCharacteristics()

Returns information about Change Field active link action.

setCharacteristics

public void setCharacteristics(FieldCharacteristicsInfo characteristics)

Sets values for Change Field active link action.

getDde

public DDEInfo getDde()

Returns information about DDE active link action.

setDde

public void setDde(DDEInfo dde)

Sets values for DDE active link action.

getPushFields

public PushFieldsActionInfo getPushFields()

Returns information about Push Fields active link action.

setPushFields

public void setPushFields(PushFieldsActionInfo pushFields)

Sets values for Push Fields active link action.

getSqlCommand

public SQLInfo getSqlCommand()

Returns information about Direct SQL active link action.

setSqlCommand

public void setSqlCommand(SQLInfo sqlCommand)

Sets values for Direct SQL active link action.

getAutomation

public AutomationInfo getAutomation()

Returns information about OLE Automation active link action.

setAutomation

public void setAutomation(AutomationInfo automation)

Sets values for OLE Automation active link action.

getOpenDlg

public OpenDialogInfo getOpenDlg()

Returns information about Open Dialog active link action.

setOpenDlg

public void setOpenDlg(OpenDialogInfo openDlg)

Sets values for Open Dialog active link action.

getCommitChanges

public CommitChangesInfo getCommitChanges()

Returns information about Commit Changes active link action.

setCommitChanges

public void setCommitChanges(CommitChangesInfo commitChanges)

Sets values for Commit Changes active link action.

getCloseWnd

public CloseWindowInfo getCloseWnd()

Returns information about Close Window active link action.

setCloseWnd

public void setCloseWnd(CloseWindowInfo closeWnd)

Sets values for Close Window active link action.

getCallGuide

public CallGuideInfo getCallGuide()

Returns information about Call Guide active link action.

setCallGuide

public void setCallGuide(CallGuideInfo callGuide)

Sets values for Call Guide active link action.

getExitGuide

public ExitGuideInfo getExitGuide()

Returns information about Exit Guide active link action.

setExitGuide

public void setExitGuide(ExitGuideInfo exitGuide)

Sets values for Exit Guide active link action.

getGotoGuide

public GotoGuideLabelInfo getGotoGuide()

Returns information about Go to Guide active link action.

setGotoGuide

public void setGotoGuide(GotoGuideLabelInfo gotoGuide)

Sets values for Go to Guide active link action.

getWaitAction

public WaitInfo getWaitAction()

Returns information about Wait Action active link action.

setWaitAction

public void setWaitAction(WaitInfo waitAction)

Sets values for Wait Action active link action.

getGotoAction

public GotoActionInfo getGotoAction()

Returns information about GoTo active link action.

setGotoAction

public void setGotoAction(GotoActionInfo gotoAction)

Sets values for GoTo active link action.

getAction

public int getAction()

Indicates type of action you want to retrieve.

setAction

public void setAction(int action)

Sets type of action you want to fill.

clone

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

Clone implementation that returns an Object with data cloned from self

Throws:

java.lang.CloneNotSupportedException

equals

public boolean equals(java.lang.Object anObject)

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

equals

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

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.