org.compiere.interfaces
Interface ServerLocal

All Superinterfaces:

EJBLocalObject

public interface ServerLocal
extends EJBLocalObject

Local interface for compiere/Server.

Method Summary

int	cacheReset(String tableName, int Record_ID) Cash Reset
EMail	createEMail(Ctx ctx, int AD_Client_ID, int AD_User_ID, String toEMail, String toName, String subject, String message) Create EMail from Server (Request User)
EMail	createEMail(Ctx ctx, int AD_Client_ID, String toEMail, String toName, String subject, String message) Create EMail from Server (Request User)
String	executeTask(int AD_Task_ID) Create EMail from Server (Request User)
String	getDocumentNo(int C_DocType_ID, String trxName) Get Document No based on Document Type
String	getDocumentNo(int AD_Client_ID, String TableName, String trxName) Get Document No from table
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
GridWindowVO	getWindowVO(Ctx ctx, int WindowNo, int AD_Window_ID, int AD_Menu_ID) Get and create Window Model Value Object
boolean	paymentOnline(Ctx ctx, int C_Payment_ID, int C_PaymentProcessor_ID, String trxName) Online Payment from Server
String	postImmediate(Ctx ctx, int AD_Client_ID, int AD_Table_ID, int Record_ID, boolean force, String trxName) Post Immediate
ProcessInfo	process(Ctx ctx, ProcessInfo pi) Process Remote
RowSet	pstmt_getRowSet(CStatementVO info) Get Prepared Statement ResultSet
int	stmt_executeUpdate(CStatementVO info) Execute Update
RowSet	stmt_getRowSet(CStatementVO info) Get Statement ResultSet
boolean	updateLOB(String sql, int displayType, Object value) LOB update
ProcessInfo	workflow(Ctx 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(Ctx 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(Ctx 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)
                       throws NotSerializableException

Get Prepared Statement ResultSet

Parameters:

info - Result info

Returns:

RowSet

Throws:

NotSerializableException

stmt_getRowSet

RowSet stmt_getRowSet(CStatementVO info)

Get Statement ResultSet

Parameters:

info - Result info

Returns:

RowSet

stmt_executeUpdate

int stmt_executeUpdate(CStatementVO info)

Execute Update

Parameters:

info - Result info

Returns:

row count

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 C_DocType_ID,
                     String trxName)

Get Document No based on Document Type

Parameters:

C_DocType_ID - document type

trxName - optional Transaction Name

Returns:

document no or null

process

ProcessInfo process(Ctx ctx,
                    ProcessInfo pi)

Process Remote

Parameters:

ctx - Context

pi - Process Info

Returns:

resulting Process Info

workflow

ProcessInfo workflow(Ctx 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(Ctx 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(Ctx ctx,
                  int AD_Client_ID,
                  String toEMail,
                  String toName,
                  String subject,
                  String message)

Create EMail from Server (Request User)

Parameters:

ctx - Context

AD_Client_ID - client

toEMail - recipient email address

subject - subject

message - message

Returns:

EMail

createEMail

EMail createEMail(Ctx ctx,
                  int AD_Client_ID,
                  int AD_User_ID,
                  String toEMail,
                  String toName,
                  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

toEMail - recipient email address

subject - subject

message - message

Returns:

EMail or null

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)

LOB update

Parameters:

sql - table name

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

value - the data

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