com.remedy.arsys.api
Class OpenDialogInfo

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

All Implemented Interfaces:

java.lang.Cloneable

public class OpenDialogInfo

extends java.lang.Object

implements java.lang.Cloneable

The OpenDialogInfo class is used to open all 10 types of AR System windows, including:

• Constants.AR_ACTIVE_LINK_ACTION_OPEN_DLG
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_SEARCH
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_SUBMIT
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_LST
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_DETAIL
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_MODIFY_SPLIT
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_LST
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_DETAIL
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_DSPLY_SPLIT
• Constants.AR_ACTIVE_LINK_ACTION_OPEN_REPORT

Constructor Summary

OpenDialogInfo()
constructor

OpenDialogInfo(java.lang.String serverName, java.lang.String schemaName, java.lang.String vuiLabel, boolean closeBox, FieldAssignInfo[] inputValueFieldPairs, FieldAssignInfo[] outputValueFieldPairs, int windowMode, QualifierInfo query, boolean noMatchContinue, MessageInfo msg, long pollinginterval, java.lang.String reportString, SortInfo[] sortOrderList, java.lang.String targetLocation, boolean suppressEmptyLst)

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)
boolean	getCloseBox() Returns whether close box appears in the upper-right corner of the dialog box.
FieldAssignInfo[]	getInputValueFieldPairs() Returns field/value pair for values that users enter into Dialog/Search/Submit windows.
MessageInfo	getMsg() Returns message for Modify/Display/Report windows.
boolean	getNoMatchContinue() Returns action to take if no requests match.
FieldAssignInfo[]	getOutputValueFieldPairs() Returns field/value pair for output values from Dialog/Search/Submit windows.
long	getPollinginterval() Returns polling interval (how often to refresh) for reports.
QualifierInfo	getQuery() Returns qualification for Modify/Display/Report windows.
java.lang.String	getReportString() Returns report information in a string format of report windows.
NameID	getSchemaName() Returns the name of the form that you want to open as a dialog box or window.
ServerNameID	getServerName() Returns the server name that contains the form that you want to open as a dialog box.
SortInfo[]	getSortOrderList() Returns list of fields in ascending/descending order included in a report.
boolean	getSuppressEmptyLst() Returns action in Modify/Display/Report windows if no requests match.
java.lang.String	getTargetLocation() Returns whether target is a New or Open window.
NameID	getVuiLabel() Returns the view of the form that you want to appear as a dialog box.
int	getWindowMode() Returns map where data from the dialog box will transfer to the parent form when the dialog box opens/closes.
int	hashCode() Returns the hash code value for this instance of the current class.
void	setCloseBox(boolean closeBox) Sets whether close box appears in the upper-right corner of the dialog box.
void	setInputValueFieldPairs(FieldAssignInfo[] inputValueFieldPairs) Field/value pair for values that users enter into Dialog/Search/Submit windows.
void	setMsg(MessageInfo msg) Sets message for Modify/Display/Report windows.
void	setNoMatchContinue(boolean noMatchContinue) Sets action to take if no requests match.
void	setOutputValueFieldPairs(FieldAssignInfo[] outputValueFieldPairs) Field/value pair for output values from Dialog/Search/Submit windows.
void	setPollinginterval(long pollinginterval) Sets polling interval (how often to refresh) for reports.
void	setQuery(QualifierInfo query) Sets qualification for Modify/Display/Report windows.
void	setReportString(java.lang.String reportString) Sets report information in a string format of report windows.
void	setSchemaName(NameID schemaName) Defines the name of the form that you want to open as a dialog box or window.
void	setServerName(ServerNameID serverName) Defines the server name that contains the form that you want to open as a dialog box.
void	setSortOrderList(SortInfo[] sortOrderList) Sets list of fields in ascending/descending order included in a report.
void	setSuppressEmptyLst(boolean suppressEmptyLst) Sets action in Modify/Display/Report windows if no requests match.
void	setTargetLocation(java.lang.String targetLocation) Sets whether target is a New or Open window.
void	setVuiLabel(NameID vuiLabel) Defines the view of the form that you want to appear as a dialog box.
void	setWindowMode(int windowMode) Returns map where data from the dialog box will transfer to the parent form when the dialog box opens/closes.

Methods inherited from class java.lang.Object

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

Constructor Detail

OpenDialogInfo

public OpenDialogInfo()

constructor

OpenDialogInfo

public OpenDialogInfo(java.lang.String serverName,
                      java.lang.String schemaName,
                      java.lang.String vuiLabel,
                      boolean closeBox,
                      FieldAssignInfo[] inputValueFieldPairs,
                      FieldAssignInfo[] outputValueFieldPairs,
                      int windowMode,
                      QualifierInfo query,
                      boolean noMatchContinue,
                      MessageInfo msg,
                      long pollinginterval,
                      java.lang.String reportString,
                      SortInfo[] sortOrderList,
                      java.lang.String targetLocation,
                      boolean suppressEmptyLst)

Method Detail

getServerName

public ServerNameID getServerName()

Returns the server name that contains the form that you want to open as a dialog box.

setServerName

public void setServerName(ServerNameID serverName)

Defines the server name that contains the form that you want to open as a dialog box.

getSchemaName

public NameID getSchemaName()

Returns the name of the form that you want to open as a dialog box or window.

setSchemaName

public void setSchemaName(NameID schemaName)

Defines the name of the form that you want to open as a dialog box or window.

getVuiLabel

public NameID getVuiLabel()

Returns the view of the form that you want to appear as a dialog box. If no form view is selected, the default administrator view will be displayed.

setVuiLabel

public void setVuiLabel(NameID vuiLabel)

Defines the view of the form that you want to appear as a dialog box. If no form view is selected, the default administrator view will be displayed.

getCloseBox

public boolean getCloseBox()

Returns whether close box appears in the upper-right corner of the dialog box.

setCloseBox

public void setCloseBox(boolean closeBox)

Sets whether close box appears in the upper-right corner of the dialog box.

getInputValueFieldPairs

public FieldAssignInfo[] getInputValueFieldPairs()

Returns field/value pair for values that users enter into Dialog/Search/Submit windows.

setInputValueFieldPairs

public void setInputValueFieldPairs(FieldAssignInfo[] inputValueFieldPairs)

Field/value pair for values that users enter into Dialog/Search/Submit windows. Method will not return value.

getOutputValueFieldPairs

public FieldAssignInfo[] getOutputValueFieldPairs()

Returns field/value pair for output values from Dialog/Search/Submit windows.

setOutputValueFieldPairs

public void setOutputValueFieldPairs(FieldAssignInfo[] outputValueFieldPairs)

Field/value pair for output values from Dialog/Search/Submit windows. Method will not return value.

getWindowMode

public int getWindowMode()

Returns map where data from the dialog box will transfer to the parent form when the dialog box opens/closes.

setWindowMode

public void setWindowMode(int windowMode)

Returns map where data from the dialog box will transfer to the parent form when the dialog box opens/closes. Method will not return value.

getQuery

public QualifierInfo getQuery()

Returns qualification for Modify/Display/Report windows.

setQuery

public void setQuery(QualifierInfo query)

Sets qualification for Modify/Display/Report windows.

getNoMatchContinue

public boolean getNoMatchContinue()

Returns action to take if no requests match.

setNoMatchContinue

public void setNoMatchContinue(boolean noMatchContinue)

Sets action to take if no requests match.

getMsg

public MessageInfo getMsg()

Returns message for Modify/Display/Report windows. These include the following methods:

• FilterStatusInfo.getMessageNum()
• FilterStatusInfo.getMessageText()
• FilterStatusInfo.getMessageType()

setMsg

public void setMsg(MessageInfo msg)

Sets message for Modify/Display/Report windows. These include the following methods:

• FilterStatusInfo.setMessageNum(long)
• FilterStatusInfo.setMessageText(java.lang.String)
• FilterStatusInfo.setMessageType(long)

getPollinginterval

public long getPollinginterval()

Returns polling interval (how often to refresh) for reports.

setPollinginterval

public void setPollinginterval(long pollinginterval)

Sets polling interval (how often to refresh) for reports.

getReportString

public java.lang.String getReportString()

Returns report information in a string format of report windows.

setReportString

public void setReportString(java.lang.String reportString)

Sets report information in a string format of report windows. You can use constants like Constants.AR_REPORT_ATTR_LAYOUT.

getSortOrderList

public SortInfo[] getSortOrderList()

Returns list of fields in ascending/descending order included in a report.

setSortOrderList

public void setSortOrderList(SortInfo[] sortOrderList)

Sets list of fields in ascending/descending order included in a report.

getTargetLocation

public java.lang.String getTargetLocation()

Returns whether target is a New or Open window.

setTargetLocation

public void setTargetLocation(java.lang.String targetLocation)

Sets whether target is a New or Open window.

getSuppressEmptyLst

public boolean getSuppressEmptyLst()

Returns action in Modify/Display/Report windows if no requests match.

setSuppressEmptyLst

public void setSuppressEmptyLst(boolean suppressEmptyLst)

Sets action in Modify/Display/Report windows if no requests match.

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 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.