public interface ActionInterface
extends com.deltek.enterprise.system.serverapi.remoteapi.MessageTypes
AppInterface
,
ResultSetInterface
,
RowSetInterface
Modifier and Type | Field and Description |
---|---|
static int |
CANCEL_TXT_HARD |
static int |
CANCEL_TXT_SOFT |
static int |
DLG_BOTTOM_LINE |
static int |
DLG_NO_COUNT |
static int |
DLG_TOP_LINE |
static java.lang.String |
UPLOADED_FILE_NAME |
Modifier and Type | Method and Description |
---|---|
void |
addMessage(java.lang.String msgId,
short msgType)
Add message for this action to the message collection.
|
void |
addMessage(java.lang.String msgId,
short msgType,
java.lang.String[] parms)
Add message for this action to the message collection.
|
void |
addReqParm(java.lang.String pName,
java.lang.Object pValue)
This function is provided only to compile code that needs to be converted to JavaScript.
|
void |
cancel()
Cancels the action
|
boolean |
checkUserCancel()
Checks if a user voted to cancel this action.
|
void |
deletePostSemaphoreData()
Delete POST_SEMAPHORE data for an action that it's invoked from.
|
void |
endTransaction()
Commits all connections associated with this action
|
java.lang.String |
getActionId()
Returns action id.
|
AppInterface |
getApplication()
Returns the AppInterface for the application this action was invoked from.
|
FileHandlerInterface |
getFileManager()
ver 6
|
FileReaderInterface |
getFileReadManager() |
FileWriterInterface |
getFileWriteManager() |
java.util.Map<java.lang.String,java.io.Serializable> |
getLastPostSemaphoreData() |
java.lang.String |
getRegParm(java.lang.String pName)
Returns the value for the named parameter if one was passed from the client
|
java.lang.String |
getReportId()
This function can be used from report before/after action if the same class/method is re-used for more then one report
ver 6
|
ResultSetInterface |
getResultSet()
Returns the ResultSetInterface for the result set this action was invoked from.
|
SqlManager |
getSqlManager(java.lang.Object o)
Return an instance of SqlManager.
|
void |
insertPostSemaphoreData(java.util.HashMap<java.lang.String,java.io.Serializable> hParms)
Inserts a row in POST_SEMAPHORE table.
|
boolean |
isProcessCanceled()
Checks if the action was cancelled
An action is cancelled only when either a developer calls cancel() method or it is cancelled by the framework
This method is intended to be used in report after Action to check whether the reporting process was successful or not
|
void |
openDirectChildresultSet(java.lang.String rsName)
This function is provided only to compile code that needs to be converted to JavaScript.
|
void |
rollbackTransaction()
Rolls back all connections associated with this action
|
void |
saveBeforeAction()
This function is provided only to compile code that needs to be converted to JavaScript.
|
void |
setDlgCancelText(int optionNo)
Sets the action status meter cancel text property
|
void |
setDlgCount(int nCount)
Sets the action status count property
|
void |
setDlgCountText(java.lang.String msgId)
Sets the action status count text property
|
void |
setDlgCountText(java.lang.String msgId,
java.lang.String[] parms)
Sets the action status count text property
|
void |
setDlgMeterLimit(int meterLimit)
Sets the action status meter limit property
|
void |
setDlgMeterTextLine(int lineNo,
java.lang.String msgId)
Sets the action status meter text line property
|
void |
setDlgMeterTextLine(int lineNo,
java.lang.String msgId,
java.lang.String[] parms)
Sets the action status meter text line property
|
void |
setDlgMeterValue(int meterValue)
Sets the action status meter value property
|
void |
showFirstTab()
this is a client only method for Expense Wizard, allows client action, assigned to the result set to set focus into first tab after action is complete
|
void |
stopReport()
This function can be used only from report before action in order to stop report from executing
but consider this process a success from a business standpoint
Typical scenario is "no data found" situation in posting apps.
|
void |
uploadFile(java.lang.String namePrefix,
java.lang.String altFileLocation)
This function is provided only to compile code that needs to be converted to JavaScript.
|
static final int DLG_TOP_LINE
static final int DLG_BOTTOM_LINE
static final int DLG_NO_COUNT
static final int CANCEL_TXT_SOFT
static final int CANCEL_TXT_HARD
static final java.lang.String UPLOADED_FILE_NAME
java.lang.String getActionId()
AppInterface getApplication()
ResultSetInterface getResultSet()
SqlManager getSqlManager(java.lang.Object o) throws DEException
o
- the object that hosts this SqlManager. SqlManager uses public variables of
this object for into and bind variables. Usually, just pass 'this' for
the current object.DEException
void endTransaction() throws DEException
DEException
void rollbackTransaction() throws DEException
DEException
void addMessage(java.lang.String msgId, short msgType)
msgId
- The ID of text as stored in table S_RESOURCE_LIB.msgType
- Severity of the message. (ActionInterface's INFORMATION, WARNING, ERROR
or FATAL)void addMessage(java.lang.String msgId, short msgType, java.lang.String[] parms)
msgId
- The ID of text as stored in table S_RESOURCE_LIB.msgType
- Severity of the message. (ActionInterface's INFORMATION, WARNING, ERROR
or FATAL)parms
- Array of message parametersjava.lang.String getRegParm(java.lang.String pName)
pName
- parameter namevoid setDlgCount(int nCount) throws DEException
nCount
- DEException
void setDlgCountText(java.lang.String msgId) throws DEException
msgId
- DEException
void setDlgCountText(java.lang.String msgId, java.lang.String[] parms) throws DEException
msgId
- parms
- array of message parametersDEException
void setDlgMeterLimit(int meterLimit) throws DEException
meterLimit
- DEException
void setDlgMeterValue(int meterValue) throws DEException
meterValue
- DEException
void setDlgMeterTextLine(int lineNo, java.lang.String msgId) throws DEException
lineNo
- msgId
- DEException
void setDlgMeterTextLine(int lineNo, java.lang.String msgId, java.lang.String[] parms) throws DEException
lineNo
- msgId
- parms
- array of message parametersDEException
void setDlgCancelText(int optionNo) throws DEException
optionNo
- either CANCEL_TXT_SOFT or CANCEL_TXT_HARD
version 7DEException
boolean checkUserCancel() throws DEException
DEException
boolean isProcessCanceled() throws DEException
DEException
void cancel() throws DEException
DEException
void insertPostSemaphoreData(java.util.HashMap<java.lang.String,java.io.Serializable> hParms) throws DEException
hParms
- - HashMap containing the values for columns in POST_SEMAPHORE table. Names of the columns are the keys in the HashMapDEException
void deletePostSemaphoreData() throws DEException
DEException
java.util.Map<java.lang.String,java.io.Serializable> getLastPostSemaphoreData() throws DEException
DEException
FileHandlerInterface getFileManager() throws DEException
DEException
FileReaderInterface getFileReadManager() throws DEException
DEException
FileWriterInterface getFileWriteManager() throws DEException
DEException
java.lang.String getReportId()
void stopReport()
void addReqParm(java.lang.String pName, java.lang.Object pValue)
pName
- parameter namepValue
- parameter valuevoid saveBeforeAction()
void uploadFile(java.lang.String namePrefix, java.lang.String altFileLocation)
void openDirectChildresultSet(java.lang.String rsName)
void showFirstTab()