org.compiere.interfaces
Interface ServerLocal

All Superinterfaces:

EJBLocalObject

public interface ServerLocal
extends EJBLocalObject

Local interface for adempiere/Server.

Method Summary

int	cacheReset(String tableName, int Record_ID) Cash Reset
CallableResult	callable_execute(CStatementVO info, SecurityToken token)
void	closeTransaction(String trxName) Close remote transaction
boolean	commit(String trxName) Commit the named transaction on server
EMail	createEMail(Properties ctx, int AD_Client_ID, int AD_User_ID, String to, String subject, String message) Create EMail from Server (Request User)
EMail	createEMail(Properties ctx, int AD_Client_ID, String to, String subject, String message) Create EMail from Server (Request User)
ProcessInfo	dbProcess(ProcessInfo processInfo, String procedureName, String trxName, SecurityToken token) Execute db proces on server
String	executeTask(int AD_Task_ID) Create EMail from Server (Request User)
String	getDocumentNo(int C_DocType_ID, String trxName, boolean definite) Get Document No based on Document Type
String	getDocumentNo(int C_DocType_ID, String trxName, boolean definite, PO po) Get Document No based on Document Type
String	getDocumentNo(int AD_Client_ID, String TableName, String trxName) Get Document No from table
String	getDocumentNo(int AD_Client_ID, String TableName, String trxName, PO po) Get Document No from table
ArrayList	getFields(GridTabVO gridTabVO) Load fields meta data from database
int	getNextID(int AD_Client_ID, String TableName, String trxName) Get next number for Key column = 0 is Error.
String	getStatus() Describes the instance and its content for debugging purpose
int	getTableID(String tableName) Get table id from ad_table by table name
GridWindowVO	getWindowVO(Properties ctx, int WindowNo, int AD_Window_ID, int AD_Menu_ID) Get and create Window Model Value Object
boolean	paymentOnline(Properties ctx, int C_Payment_ID, int C_PaymentProcessor_ID, String trxName) Online Payment from Server
String	postImmediate(Properties ctx, int AD_Client_ID, int AD_Table_ID, int Record_ID, boolean force, String trxName) Post Immediate
ProcessInfo	process(Properties ctx, ProcessInfo pi) Process Remote
RowSet	pstmt_getRowSet(CStatementVO info, SecurityToken token) Get Prepared Statement ResultSet
boolean	rollback(String trxName) Rollback the named transaction on server
boolean	rollback(String trxName, SavepointVO savePoint) Rollback the named transaction on server
SavepointVO	setSavepoint(String trxName, String savePointName) Set savepoint
void	startTransaction(String trxName) Start remote transaction
ExecuteResult	stmt_execute(CStatementVO info, SecurityToken token)
int	stmt_executeUpdate(CStatementVO info, SecurityToken token) Execute Update
RowSet	stmt_getRowSet(CStatementVO info, SecurityToken token) Get Statement ResultSet
boolean	updateLOB(String sql, int displayType, Object value, String trxName, SecurityToken token) LOB update
ProcessInfo	workflow(Properties ctx, ProcessInfo pi, int AD_Workflow_ID) Run Workflow (and wait) on Server

Methods inherited from interface javax.ejb.EJBLocalObject

getEJBLocalHome, getPrimaryKey, isIdentical, remove

Method Detail

getWindowVO

GridWindowVO getWindowVO(Properties ctx,
                         int WindowNo,
                         int AD_Window_ID,
                         int AD_Menu_ID)

Get and create Window Model Value Object

Parameters:

ctx - Environment Properties

WindowNo - number of this window

AD_Window_ID - the internal number of the window, if not 0, AD_Menu_ID is ignored

AD_Menu_ID - ine internal menu number, used when AD_Window_ID is 0

Returns:

initialized Window Model

postImmediate

String postImmediate(Properties ctx,
                     int AD_Client_ID,
                     int AD_Table_ID,
                     int Record_ID,
                     boolean force,
                     String trxName)

Post Immediate

Parameters:

ctx - Client Context

AD_Client_ID - Client ID of Document

AD_Table_ID - Table ID of Document

Record_ID - Record ID of this document

force - force posting

trxName - transaction

Returns:

null, if success or error message

pstmt_getRowSet

RowSet pstmt_getRowSet(CStatementVO info,
                       SecurityToken token)
                       throws NotSerializableException

Get Prepared Statement ResultSet

Parameters:

info - Result info

token - Security Token

Returns:

RowSet

Throws:

NotSerializableException

stmt_getRowSet

RowSet stmt_getRowSet(CStatementVO info,
                      SecurityToken token)

Get Statement ResultSet

Parameters:

info - Result info

token - Security Token

Returns:

RowSet

stmt_executeUpdate

int stmt_executeUpdate(CStatementVO info,
                       SecurityToken token)

Execute Update

Parameters:

info - Result info

token - Security Token

Returns:

row count

stmt_execute

ExecuteResult stmt_execute(CStatementVO info,
                           SecurityToken token)

callable_execute

CallableResult callable_execute(CStatementVO info,
                                SecurityToken token)

getNextID

int getNextID(int AD_Client_ID,
              String TableName,
              String trxName)

Get next number for Key column = 0 is Error.

Parameters:

AD_Client_ID - client

TableName - table name

trxName - optional Transaction Name

Returns:

next no

getDocumentNo

String getDocumentNo(int AD_Client_ID,
                     String TableName,
                     String trxName)

Get Document No from table

Parameters:

AD_Client_ID - client

TableName - table name

trxName - optional Transaction Name

Returns:

document no or null

getDocumentNo

String getDocumentNo(int AD_Client_ID,
                     String TableName,
                     String trxName,
                     PO po)

Get Document No from table

Parameters:

AD_Client_ID - client

TableName - table name

trxName - optional Transaction Name

po -

Returns:

document no or null

getDocumentNo

String getDocumentNo(int C_DocType_ID,
                     String trxName,
                     boolean definite)

Get Document No based on Document Type

Parameters:

C_DocType_ID - document type

trxName - optional Transaction Name

Returns:

document no or null

getDocumentNo

String getDocumentNo(int C_DocType_ID,
                     String trxName,
                     boolean definite,
                     PO po)

Get Document No based on Document Type

Parameters:

C_DocType_ID - document type

trxName - optional Transaction Name

po -

Returns:

document no or null

process

ProcessInfo process(Properties ctx,
                    ProcessInfo pi)

Process Remote

Parameters:

ctx - Context

pi - Process Info

Returns:

resulting Process Info

workflow

ProcessInfo workflow(Properties ctx,
                     ProcessInfo pi,
                     int AD_Workflow_ID)

Run Workflow (and wait) on Server

Parameters:

ctx - Context

pi - Process Info

AD_Workflow_ID - id

Returns:

process info

paymentOnline

boolean paymentOnline(Properties ctx,
                      int C_Payment_ID,
                      int C_PaymentProcessor_ID,
                      String trxName)

Online Payment from Server

Parameters:

ctx - Context

C_Payment_ID - payment

C_PaymentProcessor_ID - processor

trxName - transaction

Returns:

true if approved

createEMail

EMail createEMail(Properties ctx,
                  int AD_Client_ID,
                  String to,
                  String subject,
                  String message)

Create EMail from Server (Request User)

Parameters:

ctx - Context

AD_Client_ID - client

to - recipient email address

subject - subject

message - message

Returns:

EMail

createEMail

EMail createEMail(Properties ctx,
                  int AD_Client_ID,
                  int AD_User_ID,
                  String to,
                  String subject,
                  String message)

Create EMail from Server (Request User)

Parameters:

ctx - Context

AD_Client_ID - client

AD_User_ID - user to send email from

to - recipient email address

subject - subject

message - message

Returns:

EMail

executeTask

String executeTask(int AD_Task_ID)

Create EMail from Server (Request User)

Parameters:

AD_Task_ID - task

Returns:

execution trace

cacheReset

int cacheReset(String tableName,
               int Record_ID)

Cash Reset

Parameters:

tableName - table name

Record_ID - record or 0 for all

Returns:

number of records reset

updateLOB

boolean updateLOB(String sql,
                  int displayType,
                  Object value,
                  String trxName,
                  SecurityToken token)

LOB update

Parameters:

sql - table name

displayType - display type (i.e. BLOB/CLOB)

value - the data

trxName -

token - Security Token

Returns:

true if updated

getStatus

String getStatus()

Describes the instance and its content for debugging purpose

Returns:

Debugging information about the instance and its content

setSavepoint

SavepointVO setSavepoint(String trxName,
                         String savePointName)

Set savepoint

Parameters:

trxName -

savePointName -

Returns:

true if success, false otherwise

startTransaction

void startTransaction(String trxName)

Start remote transaction

Parameters:

trxName -

closeTransaction

void closeTransaction(String trxName)

Close remote transaction

Parameters:

trxName -

commit

boolean commit(String trxName)

Commit the named transaction on server

Parameters:

trxName -

Returns:

true if success, false otherwise

rollback

boolean rollback(String trxName)

Rollback the named transaction on server

Parameters:

trxName -

Returns:

true if success, false otherwise

rollback

boolean rollback(String trxName,
                 SavepointVO savePoint)

Rollback the named transaction on server

Parameters:

trxName -

Returns:

true if success, false otherwise

dbProcess

ProcessInfo dbProcess(ProcessInfo processInfo,
                      String procedureName,
                      String trxName,
                      SecurityToken token)

Execute db proces on server

Parameters:

processInfo -

procedureName -

trxName -

Returns:

ProcessInfo

getFields

ArrayList getFields(GridTabVO gridTabVO)

Load fields meta data from database

Parameters:

gridTabVO -

Returns:

ArrayList

getTableID

int getTableID(String tableName)

Get table id from ad_table by table name

Parameters:

tableName -

Returns:

tableName