org.compiere.model
Class MSession

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_AD_Session
          org.compiere.model.MSession

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MSession
extends X_AD_Session

Session Model. Maintained in AMenu.

Version:

$Id: MSession.java,v 1.3 2006/07/30 00:58:05 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Session

accessLevel, Model, Table_ID, Table_Name, updatedMS

Fields inherited from class org.compiere.framework.PO

ACCESSLEVEL_ALL, ACCESSLEVEL_CLIENT, ACCESSLEVEL_CLIENTORG, ACCESSLEVEL_ORG, ACCESSLEVEL_SYSTEM, ACCESSLEVEL_SYSTEMCLIENT, ENTITYTYPE_Dictionary, ENTITYTYPE_UserMaintained, I_ZERO, log, p_changeVO, p_info, XML_ATTRIBUTE_AD_Table_ID, XML_ATTRIBUTE_Record_ID

Constructor Summary

MSession(Ctx ctx, int AD_Session_ID, String trxName)
Standard Constructor

MSession(Ctx ctx, ResultSet rs, String trxName)
Load Constructor

MSession(Ctx ctx, String trxName)
New (local) Constructor

MSession(Ctx ctx, String Remote_Addr, String Remote_Host, String WebSession, String trxName)
New (remote) Constructor

Method Summary

MChangeLog	changeLog(String TrxName, int AD_ChangeLog_ID, int AD_Table_ID, int AD_Column_ID, Object keyInfo, int AD_Client_ID, int AD_Org_ID, Object OldValue, Object NewValue, String tableName, String type) Create Change Log only if table is logged
static MSession	get(Ctx ctx, boolean createNew) Get existing or create local session
static MSession	get(Ctx ctx, String Remote_Addr, String Remote_Host, String WebSession) Get existing or create remote session
boolean	isWebStoreSession() Is it a Web Store Session
void	logout() Session Logout
MQueryLog	queryLog(int AD_Client_ID, int AD_Org_ID, int AD_Table_ID, String whereClause, int recordCount) Create Query Log
MQueryLog	queryLog(int AD_Client_ID, int AD_Org_ID, int AD_Table_ID, String whereClause, int recordCount, Object parameter) Create Query Log
MQueryLog	queryLog(int AD_Client_ID, int AD_Org_ID, int AD_Table_ID, String whereClause, int recordCount, Object[] parameters) Create Query Log
MQueryLog	queryLog(int AD_Client_ID, int AD_Org_ID, int AD_Table_ID, String whereClause, int recordCount, String parameter) Create Query Log
void	setWebStoreSession(boolean webStoreSession) Set Web Store Session
String	toString() String Representation
MWindowLog	windowLog(int AD_Client_ID, int AD_Org_ID, int AD_Window_ID, int AD_Form_ID) Create Window Log

Methods inherited from class org.compiere.model.X_AD_Session

get_AccessLevel, getAD_Role_ID, getAD_Session_ID, getDescription, getKeyNamePair, getRemote_Addr, getRemote_Host, getWebSession, initPO, isProcessed, setAD_Role_ID, setAD_Session_ID, setDescription, setProcessed, setRemote_Addr, setRemote_Host, setWebSession

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, beforeSave, compare, convertToBigDecimal, convertToBoolean, convertToInt, convertToTimestamp, copy, copyValues, copyValues, createAttachment, delete_Accounting, delete, delete, dump, dump, equals, get_ChangeVO, get_ColumnCount, get_ColumnDescription, get_ColumnDisplayType, get_ColumnIndex, get_ColumnLabel, get_ColumnLookup, get_ColumnName, get_DisplayValue, get_EntityType, get_HashMap, get_ID, get_IDOld, get_Info, get_KeyColumns, get_Logger, get_Table_ID, get_Table_ID, get_TableName, get_Translation, get_TrxName, get_Value, get_Value, get_ValueAsInt, get_ValueAsInt, get_ValueAsString, get_ValueDifference, get_ValueDifference, get_ValueOfColumn, get_ValueOld, get_ValueOld, get_ValueOldAsInt, get_ValuesAsString, get_WhereClause, get_xmlDocument, get_xmlString, get_xmlString, getAD_Client_ID, getAD_Org_ID, getAllIDs, getAttachment, getAttachment, getAttachmentData, getCreated, getCreatedBy, getCtx, getFindParameter, getPdfAttachment, getUpdated, getUpdatedBy, getVO, hashCode, insert_Accounting, is_Changed, is_KeyColumn, is_new, is_ValueChanged, is_ValueChanged, isActive, isAttachment, isColumnMandatory, isColumnUpdateable, isMandatoryOK, isPdfAttachment, load, load, load, load, loadComplete, loadDefaults, loadSpecial, lock, save, save, saveNew_getID, saveNewInsertSQL, saveNewSpecial, saveUpdate, set_ChangeVO, set_ColumnUpdateable, set_CustomColumn, set_TrxName, set_Value, set_Value, set_ValueE, set_ValueNoCheck, set_ValueNoCheckE, set_ValueOfColumn, set_ValueString, setAD_Client_ID, setAD_Org_ID, setClientOrg, setClientOrg, setContext, setCtx, setDocWorkflowMgr, setIsActive, setStandardDefaults, setUpdateable, setUpdatedBy, toStringX, unlock, update

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

MSession

public MSession(Ctx ctx,
                int AD_Session_ID,
                String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Session_ID - id

trxName - transaction

MSession

public MSession(Ctx ctx,
                ResultSet rs,
                String trxName)

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

MSession

public MSession(Ctx ctx,
                String Remote_Addr,
                String Remote_Host,
                String WebSession,
                String trxName)

New (remote) Constructor

Parameters:

ctx - context

Remote_Addr - remote address

Remote_Host - remote host

WebSession - web session

trxName - transaction

MSession

public MSession(Ctx ctx,
                String trxName)

New (local) Constructor

Parameters:

ctx - context

trxName - transaction

Method Detail

get

public static MSession get(Ctx ctx,
                           boolean createNew)

Get existing or create local session

Parameters:

ctx - context

createNew - create if not found

Returns:

session session

get

public static MSession get(Ctx ctx,
                           String Remote_Addr,
                           String Remote_Host,
                           String WebSession)

Get existing or create remote session

Parameters:

ctx - context

Remote_Addr - remote address

Remote_Host - remote host

WebSession - web session

Returns:

session

isWebStoreSession

public boolean isWebStoreSession()

Is it a Web Store Session

Returns:

Returns true if Web Store Session.

setWebStoreSession

public void setWebStoreSession(boolean webStoreSession)

Set Web Store Session

Parameters:

webStoreSession - The webStoreSession to set.

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_Session

Returns:

info

logout

public void logout()

Session Logout

changeLog

public MChangeLog changeLog(String TrxName,
                            int AD_ChangeLog_ID,
                            int AD_Table_ID,
                            int AD_Column_ID,
                            Object keyInfo,
                            int AD_Client_ID,
                            int AD_Org_ID,
                            Object OldValue,
                            Object NewValue,
                            String tableName,
                            String type)

Create Change Log only if table is logged

Parameters:

TrxName - transaction name

AD_ChangeLog_ID - 0 for new change log

AD_Table_ID - table

AD_Column_ID - column

keyInfo - key value(s)

AD_Client_ID - client

AD_Org_ID - org

OldValue - old

NewValue - new

Returns:

saved change log or null

queryLog

public MQueryLog queryLog(int AD_Client_ID,
                          int AD_Org_ID,
                          int AD_Table_ID,
                          String whereClause,
                          int recordCount,
                          String parameter)

Create Query Log

Parameters:

AD_Client_ID - login client

AD_Org_ID - login org

AD_Table_ID - table

whereClause - where

recordCount - records

parameter - parameter

Returns:

Log

queryLog

public MQueryLog queryLog(int AD_Client_ID,
                          int AD_Org_ID,
                          int AD_Table_ID,
                          String whereClause,
                          int recordCount)

Create Query Log

Parameters:

AD_Client_ID - login client

AD_Org_ID - login org

AD_Table_ID - table

whereClause - where

recordCount - records

Returns:

Log

queryLog

public MQueryLog queryLog(int AD_Client_ID,
                          int AD_Org_ID,
                          int AD_Table_ID,
                          String whereClause,
                          int recordCount,
                          Object parameter)

Create Query Log

Parameters:

AD_Client_ID - login client

AD_Org_ID - login org

AD_Table_ID - table

whereClause - where

recordCount - records

parameter - parameter

Returns:

Log

queryLog

public MQueryLog queryLog(int AD_Client_ID,
                          int AD_Org_ID,
                          int AD_Table_ID,
                          String whereClause,
                          int recordCount,
                          Object[] parameters)

Create Query Log

Parameters:

AD_Client_ID - login client

AD_Org_ID - login org

AD_Table_ID - table

whereClause - where

recordCount - records

parameters - parameter

Returns:

Log

windowLog

public MWindowLog windowLog(int AD_Client_ID,
                            int AD_Org_ID,
                            int AD_Window_ID,
                            int AD_Form_ID)

Create Window Log

Parameters:

AD_Client_ID - client

AD_Org_ID - org

AD_Window_ID - window

AD_Form_ID - form

Returns:

Log