public interface InvokeAppInterface
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
COMPANY_ID_COLUMN |
Modifier and Type | Method and Description |
---|---|
void |
close()
close method submits unsubmitted documents ( previously built by calling addRow on output row set ) ;
then it closes all resourses so no other methods can be called after that
|
IntRowSet |
createOutputRowSet(java.lang.String rsId)
Use this method to pass data to Costpoint application.
|
IntRowWrite |
getRegularActionReportParams()
Use this method to get reference to the parameters row that you can populate with data
using set* methods and then pass as a parameter to one of the method that invokes action or report;
you only need to do it if you invoke action/report with regular parameters as opposed to the
saved parameter or archive report id
|
com.deltek.enterprise.system.serverapi.remoteapi.integration.MethodResponseInterface |
invokeAction(java.lang.String actionID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId)
You this method to invoke action synchronously .
|
void |
invokeActionAsync(java.lang.String actionID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId)
You this method to invoke action asynchronously ; it works same way as invokeAction() except
we submit invoke action request to the framework and immidiately return control back.
|
void |
invokeExcelReportAsync(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
int maxNumberOfPages) |
void |
invokeHTMLReportAsync(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
int maxNumberOfPages) |
void |
invokePDFReportAsync(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
int maxNumberOfPages)
method renerates report asynchronously ; it works same way as invokeReportPDF() except
we submit generate report request to the framework and immidiately return control back.
|
com.deltek.enterprise.system.serverapi.remoteapi.integration.ExcelReportResponse |
invokeReportExcel(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
java.lang.String archivedReportId,
int maxNumberOfPages)
Same as invokeReportPDF() but it returns back report in Excel format
|
com.deltek.enterprise.system.serverapi.remoteapi.integration.HTMLReportResponse |
invokeReportHTML(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
java.lang.String archivedReportId,
int maxNumberOfPages)
Same as invokeReportPDF() but it returns back report in PDF format
|
com.deltek.enterprise.system.serverapi.remoteapi.integration.PDFReportResponse |
invokeReportPDF(java.lang.String reportID,
java.lang.String rsID,
java.lang.String companyId,
IntRowWrite params,
java.lang.String savedParmId,
java.lang.String archivedReportId,
int maxNumberOfPages)
You this method to invoke report synchronously .
|
void |
sendMessagesToClient(com.deltek.enterprise.system.serverapi.remoteapi.integration.MethodResponseInterface mgs,
ResultSetInterface rs)
Use this method to send messages returned by invoke* methods back to client as if they were
generated by your parent action
|
void |
setErrorHandler(ErrorHandler errorHandler)
If application needs to do error handling it needs to invoke setErrorHandler to pass ErrorHandler
to the framework that would allow application to get back reference to the failed rows;
error message returned by 3party system
|
default void |
setMessageHandler(MessageHandler errorHandler)
If application needs to do message handling it needs to invoke setMessageHandler to pass MessageHandler
to the framework that would allow application to get back reference to the rows that returned messages.
|
static final java.lang.String COMPANY_ID_COLUMN
IntRowSet createOutputRowSet(java.lang.String rsId) throws DEException
rsId
- Costpoint application top level rs_idDEException
void close() throws DEException
DEException
- if close fails for whatever reasonvoid setErrorHandler(ErrorHandler errorHandler)
errorHandler
- default void setMessageHandler(MessageHandler errorHandler)
errorHandler
- IntRowWrite getRegularActionReportParams()
com.deltek.enterprise.system.serverapi.remoteapi.integration.MethodResponseInterface invokeAction(java.lang.String actionID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId)
actionID
- - action idrsID
- - result set id action assigned to (right now we only support top level result set )companyId
- - company id you want action to be executed in ; pass null to execute it in current companyparams
- - pass IntRowWrite object you previously get using getRegularActionReportParams() if you need to
invoke action using regular parameters ; pass null if you want to invoke action using saved parameterssavedParmId
- - pass saved parameter id or null if you are using regular parametersvoid sendMessagesToClient(com.deltek.enterprise.system.serverapi.remoteapi.integration.MethodResponseInterface mgs, ResultSetInterface rs)
mgs
- MethodResponseInterface you got back after you invoke invoke* method ( e.g. invokeAction() )rs
- result result set in you invoking app that you want messages to assosiate withvoid invokeActionAsync(java.lang.String actionID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId)
actionID
- rsID
- companyId
- params
- savedParmId
- com.deltek.enterprise.system.serverapi.remoteapi.integration.PDFReportResponse invokeReportPDF(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, java.lang.String archivedReportId, int maxNumberOfPages)
reportID
- - report idrsID
- - result set id action assigned to (right now we only support top level result set )companyId
- - company id you want report to be executed in ; pass null to execute it in current companyparams
- - pass IntRowWrite object you previously get using getRegularActionReportParams() if you need to
invoke report using regular parameters ; pass null if you want to invoke report using saved parameters need to get archive reportsavedParmId
- - pass saved parameter id or null if you are using regular parameters or need to get archive reportarchivedReportId
- - pass archive report id if you want ot get previosly archived report or null if you are using regular or saved parametersmaxNumberOfPages
- - pass maximum number of pages you want report to generate or pass -1 if you want to return all report pagescom.deltek.enterprise.system.serverapi.remoteapi.integration.HTMLReportResponse invokeReportHTML(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, java.lang.String archivedReportId, int maxNumberOfPages)
reportID
- rsID
- companyId
- params
- savedParmId
- archivedReportId
- maxNumberOfPages
- com.deltek.enterprise.system.serverapi.remoteapi.integration.ExcelReportResponse invokeReportExcel(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, java.lang.String archivedReportId, int maxNumberOfPages)
reportID
- rsID
- companyId
- params
- savedParmId
- archivedReportId
- maxNumberOfPages
- void invokePDFReportAsync(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, int maxNumberOfPages)
reportID
- rsID
- companyId
- params
- savedParmId
- maxNumberOfPages
- void invokeHTMLReportAsync(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, int maxNumberOfPages)
void invokeExcelReportAsync(java.lang.String reportID, java.lang.String rsID, java.lang.String companyId, IntRowWrite params, java.lang.String savedParmId, int maxNumberOfPages)