com.bmc.arsys.api
Class OpenWindowAction

java.lang.Object
  com.bmc.arsys.api.Action
      com.bmc.arsys.api.OpenWindowAction

All Implemented Interfaces:

ActiveLinkAction, Serializable, Cloneable

public class OpenWindowAction
extends Action
implements ActiveLinkAction, Cloneable, Serializable

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

See Also:

Serialized Form

Nested Class Summary

static class

OpenWindowAction.ReportInfo The ReportInfo class has properties of the report.

Constructor Summary

OpenWindowAction()

OpenWindowAction(String serverName, String formName, String vuiLabel, boolean closeBox, List<FieldAssignInfo> inputValueFieldPairs, List<FieldAssignInfo> outputValueFieldPairs, int windowMode, QualifierInfo query, boolean noMatchContinue, MessageAction msg, int pollinginterval, OpenWindowAction.ReportInfo reportInfo, List<SortInfo> sortOrderList, String targetLocation, boolean suppressEmptyLst)

Method Summary

Object	clone() Clone implementation that returns an Object with data cloned from self
boolean	equals(Object obj) Use this method for checking equality.
boolean	equals(Object anObject, String lhsServer, String lhsForm, String rhsServer, String rhsForm)
String	getFormName() Returns the name of the form that you want to open as a dialog box or window.
List<FieldAssignInfo>	getInputValueFieldPairs() Returns field/value pair for values that users enter into Dialog/Search/Submit windows.
MessageAction	getMsg() Returns message for Modify/Display/Report windows.
List<FieldAssignInfo>	getOutputValueFieldPairs() Returns field/value pair for output values from Dialog/Search/Submit windows.
int	getPollinginterval() Returns polling interval (how often to refresh) for reports.
QualifierInfo	getQuery() Returns qualification for Modify/Display/Report windows.
OpenWindowAction.ReportInfo	getReportInfo() return the report info that is encoded in the Open Window report string.
String	getReportString() Returns report information in a string format of report windows.
String	getSampleForm() Returns the sample form name.
String	getSampleServer() Returns the sample server name.
String	getServerName() Returns the server name that contains the form that you want to open as a dialog box.
List<SortInfo>	getSortOrderList() Returns list of fields in ascending/descending order included in a report.
String	getTargetLocation() Returns whether target is a New or Open window.
String	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.
boolean	isCloseBox() Returns whether close box appears in the upper-right corner of the dialog box.
boolean	isInputDefault()
boolean	isNoMatchContinue() Returns action to take if no requests match.
boolean	isSuppressEmptyLst() Returns action in Modify/Display/Report windows if no requests match.
void	setCloseBox(boolean closeBox) Sets whether close box appears in the upper-right corner of the dialog box.
void	setFormName(String formName) Defines the name of the form that you want to open as a dialog box or window.
void	setInputDefault(boolean isInputDefault)
void	setInputValueFieldPairs(List<FieldAssignInfo> inputValueFieldPairs) Field/value pair for values that users enter into Dialog/Search/Submit windows.
void	setMsg(MessageAction msg) Sets message for Modify/Display/Report windows.
void	setNoMatchContinue(boolean noMatchContinue) Sets action to take if no requests match.
void	setOutputValueFieldPairs(List<FieldAssignInfo> outputValueFieldPairs) Field/value pair for output values from Dialog/Search/Submit windows.
void	setPollinginterval(int pollinginterval) Sets polling interval (how often to refresh) for reports.
void	setQuery(QualifierInfo query) Sets qualification for Modify/Display/Report windows.
void	setReportInfo(OpenWindowAction.ReportInfo report) Sets report information to the Open Window action, and encode the info into a report string, which late on will be stored in the server.
void	setSampleForm(String sampleForm) Sets the sample form name.
void	setSampleServer(String sampleServer) Sets the sample server name.
void	setServerName(String serverName) Defines the server name that contains the form that you want to open as a dialog box.
void	setSortOrderList(List<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(String targetLocation) Sets whether target is a New or Open window.
void	setVuiLabel(String 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.
String	toString() Returns a string description of the object.

Methods inherited from class com.bmc.arsys.api.Action

getActionType

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OpenWindowAction

public OpenWindowAction()

OpenWindowAction

public OpenWindowAction(String serverName,
                        String formName,
                        String vuiLabel,
                        boolean closeBox,
                        List<FieldAssignInfo> inputValueFieldPairs,
                        List<FieldAssignInfo> outputValueFieldPairs,
                        int windowMode,
                        QualifierInfo query,
                        boolean noMatchContinue,
                        MessageAction msg,
                        int pollinginterval,
                        OpenWindowAction.ReportInfo reportInfo,
                        List<SortInfo> sortOrderList,
                        String targetLocation,
                        boolean suppressEmptyLst)

Method Detail

getServerName

public String getServerName()

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

setServerName

public void setServerName(String serverName)

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

getFormName

public String getFormName()

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

setFormName

public void setFormName(String formName)

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

getVuiLabel

public String 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(String 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.

isCloseBox

public boolean isCloseBox()

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 List<FieldAssignInfo> getInputValueFieldPairs()

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

setInputValueFieldPairs

public void setInputValueFieldPairs(List<FieldAssignInfo> inputValueFieldPairs)

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

getOutputValueFieldPairs

public List<FieldAssignInfo> getOutputValueFieldPairs()

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

setOutputValueFieldPairs

public void setOutputValueFieldPairs(List<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.

isNoMatchContinue

public boolean isNoMatchContinue()

Returns action to take if no requests match.

setNoMatchContinue

public void setNoMatchContinue(boolean noMatchContinue)

Sets action to take if no requests match.

getMsg

public MessageAction getMsg()

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

• FilterMessageAction.getMessageNum()
• FilterMessageAction.getMessageText()
• FilterMessageAction.getMessageType()

setMsg

public void setMsg(MessageAction msg)

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

• FilterMessageAction.setMessageNum(int)
• FilterMessageAction.setMessageText(java.lang.String)
• FilterMessageAction.setMessageType(int)

getPollinginterval

public int getPollinginterval()

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

setPollinginterval

public void setPollinginterval(int pollinginterval)

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

getReportString

public String getReportString()

Returns report information in a string format of report windows.

getReportInfo

public OpenWindowAction.ReportInfo getReportInfo()

return the report info that is encoded in the Open Window report string.

Returns:

the decoded report info

setReportInfo

public void setReportInfo(OpenWindowAction.ReportInfo report)

Sets report information to the Open Window action, and encode the info into a report string, which late on will be stored in the server.

getSortOrderList

public List<SortInfo> getSortOrderList()

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

setSortOrderList

public void setSortOrderList(List<SortInfo> sortOrderList)

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

getTargetLocation

public String getTargetLocation()

Returns whether target is a New or Open window.

setTargetLocation

public void setTargetLocation(String targetLocation)

Sets whether target is a New or Open window.

isSuppressEmptyLst

public boolean isSuppressEmptyLst()

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 Object clone()
             throws CloneNotSupportedException

Clone implementation that returns an Object with data cloned from self

Overrides:

clone in class Action

Throws:

CloneNotSupportedException

equals

public boolean equals(Object obj)

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.

Overrides:

equals in class Action

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal

equals

public boolean equals(Object anObject,
                      String lhsServer,
                      String lhsForm,
                      String rhsServer,
                      String rhsForm)

Overrides:

equals in class Action

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 Action

Returns:

returns the hash code for this instance

toString

public String toString()

Description copied from class: Action

Returns a string description of the object.

Overrides:

toString in class Action

getSampleForm

public String getSampleForm()

Returns the sample form name. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

getSampleServer

public String getSampleServer()

Returns the sample server name. This is used by the authoring environment when the server is a reference to a value rather than an actual form name.

setSampleForm

public void setSampleForm(String sampleForm)

Sets the sample form name. This is used by the authoring environment when the form is a reference to a value rather than an actual form name.

setSampleServer

public void setSampleServer(String sampleServer)

Sets the sample server name. This is used by the authoring environment when the server is a reference to a value rather than an actual form name.

isInputDefault

public boolean isInputDefault()

Returns:

the isInputDefault

setInputDefault

public void setInputDefault(boolean isInputDefault)

Parameters:

isInputDefault - the isInputDefault to set