org.compiere.model
Class MClient

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_AD_Client
          org.compiere.model.MClient

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MClient
extends X_AD_Client

Client Model

Version:

$Id: MClient.java,v 1.2 2006/07/30 00:58:37 jjanke Exp $

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

Fields inherited from class org.compiere.model.X_AD_Client

accessLevel, AD_LANGUAGE_AD_Reference_ID, AUTOARCHIVE_AD_Reference_ID, AUTOARCHIVE_AllReportsDocuments, AUTOARCHIVE_Documents, AUTOARCHIVE_ExternalDocuments, AUTOARCHIVE_None, MMPOLICY_AD_Reference_ID, MMPOLICY_FiFo, MMPOLICY_LiFo, 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

MClient(Ctx ctx, int AD_Client_ID, boolean createNew, String trxName)
Standard Constructor

MClient(Ctx ctx, int AD_Client_ID, String trxName)
Standard Constructor

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

Method Summary

EMail	createEMail(MUser from, MUser to, String subject, String message) Create EMail from User
EMail	createEMail(MUser from, String toEMail, String toName, String subject, String message) Create EMail from User
EMail	createEMail(String toEMail, String toName, String subject, String message) Create EMail from Request User
static MClient	get(Ctx ctx) Get optionally cached client
static MClient	get(Ctx ctx, int AD_Client_ID) Get client
MAcctSchema	getAcctSchema() Get Primary Accounting Schema
String	getAD_Language() Get AD_Language
static MClient[]	getAll(Ctx ctx) Get all clients
int	getC_Currency_ID() Get Default Accounting Currency
MClientInfo	getInfo() Get Client Info
Language	getLanguage() Get Language
Locale	getLocale() Get Locale
int	getSetup_AD_Tree_Account_ID() Get AD_Tree_Account_ID created in setup client info
String	getSmtpHost() Get SMTP Host
int	getSmtpPort() Get SMTP Port
boolean	isAutoArchive() Is Auto Archive on
boolean	isAutoUpdateTrl(String TableName) Update Trl Tables automatically?
boolean	save() Save
boolean	sendEMail(int AD_User_ID, String subject, String message, File attachment) Send EMail from Request User - with trace
boolean	sendEMail(MUser from, MUser to, String subject, String message, File attachment) Send EMail from User
boolean	sendEMail(String toEMail, String toName, String subject, String message, File attachment) Send EMail from Request User - no trace
void	setAD_Language(String AD_Language) Set AD_Language
boolean	setupClientInfo(String language) Create Trees and Setup Client Info
String	testEMail() Test EMail
String	toString() String Representation

Methods inherited from class org.compiere.model.X_AD_Client

get_AccessLevel, getAutoArchive, getDescription, getDocumentDir, getEMailTest, getKeyNamePair, getLDAPQuery, getMMPolicy, getModelValidationClasses, getName, getRequestEMail, getRequestFolder, getRequestUser, getRequestUserPW, getValue, initPO, isAutoArchiveValid, isCostImmediate, isMMPolicyValid, isMultiLingualDocument, isPostImmediate, isServerEMail, isSmtpAuthorization, isSmtpTLS, isUseBetaFunctions, setAutoArchive, setDescription, setDocumentDir, setEMailTest, setIsCostImmediate, setIsMultiLingualDocument, setIsPostImmediate, setIsServerEMail, setIsSmtpAuthorization, setIsSmtpTLS, setIsUseBetaFunctions, setLDAPQuery, setMMPolicy, setModelValidationClasses, setName, setRequestEMail, setRequestFolder, setRequestUser, setRequestUserPW, setSmtpHost, setSmtpPort, setValue

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, 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

MClient

public MClient(Ctx ctx,
               int AD_Client_ID,
               boolean createNew,
               String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Client_ID - id

createNew - create new

trxName - transaction

MClient

public MClient(Ctx ctx,
               int AD_Client_ID,
               String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Client_ID - id

trxName - transaction

MClient

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

get

public static MClient get(Ctx ctx,
                          int AD_Client_ID)

Get client

Parameters:

ctx - context

AD_Client_ID - id

Returns:

client

getAll

public static MClient[] getAll(Ctx ctx)

Get all clients

Parameters:

ctx - context

Returns:

clients

get

public static MClient get(Ctx ctx)

Get optionally cached client

Parameters:

ctx - context

Returns:

client

getSmtpHost

public String getSmtpHost()

Get SMTP Host

Overrides:

getSmtpHost in class X_AD_Client

Returns:

SMTP or loaclhost

getSmtpPort

public int getSmtpPort()

Get SMTP Port

Overrides:

getSmtpPort in class X_AD_Client

Returns:

port (default 25)

getInfo

public MClientInfo getInfo()

Get Client Info

Returns:

Client Info

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_Client

Returns:

info

getC_Currency_ID

public int getC_Currency_ID()

Get Default Accounting Currency

Returns:

currency or 0

getLanguage

public Language getLanguage()

Get Language

Returns:

client language

setAD_Language

public void setAD_Language(String AD_Language)

Set AD_Language

Overrides:

setAD_Language in class X_AD_Client

Parameters:

AD_Language - new language

getAD_Language

public String getAD_Language()

Get AD_Language

Overrides:

getAD_Language in class X_AD_Client

Returns:

Language

getLocale

public Locale getLocale()

Get Locale

Returns:

locale

setupClientInfo

public boolean setupClientInfo(String language)

Create Trees and Setup Client Info

Parameters:

language - language

Returns:

true if created

getSetup_AD_Tree_Account_ID

public int getSetup_AD_Tree_Account_ID()

Get AD_Tree_Account_ID created in setup client info

Returns:

Account Tree ID

isAutoArchive

public boolean isAutoArchive()

Is Auto Archive on

Returns:

true if auto archive

isAutoUpdateTrl

public boolean isAutoUpdateTrl(String TableName)

Update Trl Tables automatically?

Parameters:

TableName - table name

Returns:

true if automatically translated

getAcctSchema

public MAcctSchema getAcctSchema()

Get Primary Accounting Schema

Returns:

Acct Schema or null

save

public boolean save()

Save

Overrides:

save in class PO

Returns:

true if saved

testEMail

public String testEMail()

Test EMail

Returns:

OK or error

sendEMail

public boolean sendEMail(int AD_User_ID,
                         String subject,
                         String message,
                         File attachment)

Send EMail from Request User - with trace

Parameters:

AD_User_ID - recipient

subject - subject

message - message

attachment - optional attachment

Returns:

true if sent

sendEMail

public boolean sendEMail(String toEMail,
                         String toName,
                         String subject,
                         String message,
                         File attachment)

Send EMail from Request User - no trace

Parameters:

toEMail - recipient email address

subject - subject

message - message

attachment - optional attachment

Returns:

true if sent

sendEMail

public boolean sendEMail(MUser from,
                         MUser to,
                         String subject,
                         String message,
                         File attachment)

Send EMail from User

Parameters:

from - sender

to - recipient

subject - subject

message - message

attachment - optional attachment

Returns:

true if sent

createEMail

public EMail createEMail(String toEMail,
                         String toName,
                         String subject,
                         String message)

Create EMail from Request User

Parameters:

to - recipient

subject - subject

message - message

Returns:

EMail or null

createEMail

public EMail createEMail(MUser from,
                         MUser to,
                         String subject,
                         String message)

Create EMail from User

Parameters:

from - optional sender

to - recipient

subject - subject

message - message

Returns:

EMail

createEMail

public EMail createEMail(MUser from,
                         String toEMail,
                         String toName,
                         String subject,
                         String message)

Create EMail from User

Parameters:

from - optional sender

toEMail - recipient

subject - sunject

message - nessage

Returns:

EMail or null