com.oracle.e1.aisclient

Class FormRequest

java.lang.Object

com.oracle.e1.aisclient.JASRequestBase

com.oracle.e1.aisclient.FSRParent

com.oracle.e1.aisclient.FormRequest

public class FormRequest
extends FSRParent

The FormRequest class is the expected input class to the jderest/formservice AIS service.

• maxPageSize - (optional) Max rows to return in the grid, default is 100 if not passed, absolute max is 500
• returnControlIDs - (optional) Indicates which form/grid fields the service passes back, form fields are single values, grid columns are indicated using grid id and brackets around a list of column ids, subform fields use subform id and field ids on subform
  Form Fields: "34|44|45"
  Grid Columns: "1[24,26,28]"
  Subform Fields: "50_45|50_53"
  Subform Grid Columns: "50_9[35,39,41]"
  
• formInputs - (optional) Collection of FIStructure (id,value pair) that represent the form interconnect input to the form. Associate a string for the FI id, with the value to be passed into that FI.
• version - Version of the E1 application (e.g. ZJDE0001)
• formName - (required) E1 application and form name (e.g. P01012_W01012B)
• formServiceAction - (optional) The CRUD operation the form will perform, constants available, this ties to an event in FDA
• bypassFormServiceEREvent - (optional) use boolean true or false, when the value is true the service will not execute the ER in the FormServiceEvent in FDA
• formServiceDemo - (optional) use TRUE or FALSE constant, for if the form should run in demo mode, guaranteed to show one 'dummy' row in the grid.
• stopOnWarning - (optional) use TRUE or FALSE constant, stop processing the form when error or warning is thrown in E1, false will allow you to bypass warnings.
• ignoreFDAFindOnEntry - (optional) use TRUE or FALSE constant, if the application is coded to find on entry, true will not execute that find.
• formActions - (optional) an array list of FormActions, allowing you to interact with the E1 form, fill in data, press buttons, add grid records.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_CREATE
static java.lang.String	ACTION_DELETE
static java.lang.String	ACTION_READ
static java.lang.String	ACTION_UPDATE
static java.lang.String	FALSE
static java.lang.String	TRUE

Constructor Summary

Constructors

Constructor and Description
FormRequest(LoginEnvironment loginEnv)

Method Summary

Methods

Modifier and Type	Method and Description
void	addToFISet(java.lang.String id, java.util.Date value)
void	addToFISet(java.lang.String id, java.lang.String value)
java.lang.String	getFormDSData()
java.lang.String	getFormDSTmpl()
java.util.Collection	getFormInputs()
java.lang.String	getFormName()
java.lang.String	getFormServiceAction()
java.lang.String	getIgnoreFDAFindOnEntry()
java.lang.String	getStopOnWarning()
java.lang.String	getVersion()
boolean	isBypassFormServiceEREvent()
void	setBypassFormServiceEREvent(boolean bypassFormServiceEREvent)
void	setFormDSData(java.lang.String formDSData)
void	setFormDSTmpl(java.lang.String formDSTmpl)
void	setFormInputs(java.util.Collection fiSet)
void	setFormName(java.lang.String formName)
void	setFormServiceAction(java.lang.String formServiceAction)
void	setIgnoreFDAFindOnEntry(LoginEnvironment loginEnv, java.lang.String ignoreFDAFindOnEntry)
void	setStopOnWarning(java.lang.String stopOnWarning)
void	setVersion(java.lang.String version)

Methods inherited from class com.oracle.e1.aisclient.FSRParent

addFSREvent, getFindOnEntry, getFormActions, getFormServiceDemo, getMaxPageSize, getQuery, getReturnControlIDs, setFindOnEntry, setFormActions, setFormServiceDemo, setMaxPageSize, setQuery, setReturnControlIDs

Methods inherited from class com.oracle.e1.aisclient.JASRequestBase

getDeviceName, getEnvironment, getJasserver, getPassword, getPsToken, getRole, getSsoUniqueId, getToken, getUsername, isAliasNaming, isSsoEnabled, setAliasNaming, setDeviceName, setEnvironment, setJasserver, setPassword, setPsToken, setRole, setSsoEnabled, setSsoUniqueId, setToken, setUsername

Methods inherited from class java.lang.Object

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

Field Detail

TRUE

public static final java.lang.String TRUE

See Also:

Constant Field Values

FALSE

public static final java.lang.String FALSE

See Also:

Constant Field Values

ACTION_READ

public static final java.lang.String ACTION_READ

See Also:

Constant Field Values

ACTION_CREATE

public static final java.lang.String ACTION_CREATE

See Also:

Constant Field Values

ACTION_UPDATE

public static final java.lang.String ACTION_UPDATE

See Also:

Constant Field Values

ACTION_DELETE

public static final java.lang.String ACTION_DELETE

See Also:

Constant Field Values

Constructor Detail

FormRequest

public FormRequest(LoginEnvironment loginEnv)

Method Detail

setFormName

public void setFormName(java.lang.String formName)

addToFISet

public void addToFISet(java.lang.String id,
              java.lang.String value)

addToFISet

public void addToFISet(java.lang.String id,
              java.util.Date value)

getFormName

public java.lang.String getFormName()

setFormDSTmpl

public void setFormDSTmpl(java.lang.String formDSTmpl)

getFormDSTmpl

public java.lang.String getFormDSTmpl()

setFormDSData

public void setFormDSData(java.lang.String formDSData)

getFormDSData

public java.lang.String getFormDSData()

setVersion

public void setVersion(java.lang.String version)

getVersion

public java.lang.String getVersion()

setFormInputs

public void setFormInputs(java.util.Collection fiSet)

getFormInputs

public java.util.Collection getFormInputs()

setFormServiceAction

public void setFormServiceAction(java.lang.String formServiceAction)

getFormServiceAction

public java.lang.String getFormServiceAction()

setStopOnWarning

public void setStopOnWarning(java.lang.String stopOnWarning)

getStopOnWarning

public java.lang.String getStopOnWarning()

setIgnoreFDAFindOnEntry

public void setIgnoreFDAFindOnEntry(LoginEnvironment loginEnv,
                           java.lang.String ignoreFDAFindOnEntry)
                             throws java.lang.Exception

Throws:

java.lang.Exception

getIgnoreFDAFindOnEntry

public java.lang.String getIgnoreFDAFindOnEntry()

setBypassFormServiceEREvent

public void setBypassFormServiceEREvent(boolean bypassFormServiceEREvent)

isBypassFormServiceEREvent

public boolean isBypassFormServiceEREvent()