org.compiere.model
Class MAttachment

java.lang.Object
  org.compiere.framework.PO
      org.compiere.model.X_AD_Attachment
          org.compiere.model.MAttachment

All Implemented Interfaces:

Serializable, Cloneable, Comparator<PO>, Evaluatee

public class MAttachment
extends X_AD_Attachment

Attachment Model. One Attachment can have multiple entries

Version:

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

Author:

Jorg Janke

See Also:

Serialized Form

Field Summary

static String	NONE Indicator for no data
static String	ZIP Indicator for zip data

Fields inherited from class org.compiere.model.X_AD_Attachment

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

MAttachment(Ctx ctx, int AD_Table_ID, int Record_ID, String trxName)
New Constructor

MAttachment(Ctx ctx, int AD_Attachment_ID, String trxName)
Standard Constructor

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

Method Summary

boolean	addEntry(File file) Add new Data Entry
boolean	addEntry(MAttachmentEntry item) Add Entry
static boolean	addEntry(PO po, File file) Add Attachment Entry for PO
static boolean	addEntry(PO po, URI uri) Add Attachment Entry Reference for PO
boolean	addEntry(String name, byte[] data) Add new Data Entry
boolean	addEntry(URI uri) Add URI Entry
void	addTextMsg(String added) Add to Text Msg
protected boolean	beforeSave(boolean newRecord) Before Save
boolean	deleteAllEntries() Delete All Entries
boolean	deleteEntry(int index) Delete Entry
void	dumpEntryNames() Dump Entry Names
static MAttachment	get(Ctx ctx, int AD_Table_ID, int Record_ID) Get Attachment
MAttachmentEntry[]	getEntries() Get Attachment Entries as array
MAttachmentEntry	getEntry(int index) Get Attachment Entry
int	getEntryCount() Get Entry Count
byte[]	getEntryData(int index) Get Entry Data
File	getEntryFile(int index, File file) Save Entry in File with name
File	getEntryFile(int index, String fileName) Get Entry File with name
String	getEntryName(int index) Get Entry Name
String	getTextMsg() Get Text Msg
static void	main(String[] args) Test
void	setClientOrg(int AD_Client_ID, int AD_Org_ID) Set Client Org
String	toString() String Representation

Methods inherited from class org.compiere.model.X_AD_Attachment

get_AccessLevel, getAD_Attachment_ID, getAD_Table_ID, getBinaryData, getKeyNamePair, getRecord_ID, getTitle, initPO, setAD_Attachment_ID, setAD_Table_ID, setBinaryData, setRecord_ID, setTextMsg, setTitle

Methods inherited from class org.compiere.framework.PO

addAttachment, addAttachment, addError, afterDelete, afterSave, beforeDelete, 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, 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

Field Detail

NONE

public static final String NONE

Indicator for no data

See Also:

Constant Field Values

ZIP

public static final String ZIP

Indicator for zip data

See Also:

Constant Field Values

Constructor Detail

MAttachment

public MAttachment(Ctx ctx,
                   int AD_Attachment_ID,
                   String trxName)

Standard Constructor

Parameters:

ctx - context

AD_Attachment_ID - id

trxName - transaction

MAttachment

public MAttachment(Ctx ctx,
                   int AD_Table_ID,
                   int Record_ID,
                   String trxName)

New Constructor

Parameters:

ctx - context

AD_Table_ID - table

Record_ID - record

trxName - transaction

MAttachment

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

Load Constructor

Parameters:

ctx - context

rs - result set

trxName - transaction

Method Detail

get

public static MAttachment get(Ctx ctx,
                              int AD_Table_ID,
                              int Record_ID)

Get Attachment

Parameters:

ctx - context

AD_Table_ID - table

Record_ID - record

Returns:

attachment or null

addEntry

public static boolean addEntry(PO po,
                               URI uri)

Add Attachment Entry Reference for PO

Parameters:

po - persistent object

uri - url or file reference

Returns:

true if reference added

addEntry

public static boolean addEntry(PO po,
                               File file)

Add Attachment Entry for PO

Parameters:

po - persistent object

file - file to be loaded

Returns:

true if file loaded and added

setClientOrg

public void setClientOrg(int AD_Client_ID,
                         int AD_Org_ID)

Set Client Org

Overrides:

setClientOrg in class PO

Parameters:

AD_Client_ID - client

AD_Org_ID - org

addTextMsg

public void addTextMsg(String added)

Add to Text Msg

Parameters:

added - text

getTextMsg

public String getTextMsg()

Get Text Msg

Overrides:

getTextMsg in class X_AD_Attachment

Returns:

trimmed message

toString

public String toString()

String Representation

Overrides:

toString in class X_AD_Attachment

Returns:

info

addEntry

public boolean addEntry(File file)

Add new Data Entry

Parameters:

file - file

Returns:

true if added

addEntry

public boolean addEntry(URI uri)

Add URI Entry

Parameters:

uri - uri

Returns:

true if added

addEntry

public boolean addEntry(String name,
                        byte[] data)

Add new Data Entry

Parameters:

name - name

data - data

Returns:

true if added

addEntry

public boolean addEntry(MAttachmentEntry item)

Add Entry

Parameters:

item - attachment entry

Returns:

true if added

getEntry

public MAttachmentEntry getEntry(int index)

Get Attachment Entry

Parameters:

index - index of the item

Returns:

Entry or null

getEntries

public MAttachmentEntry[] getEntries()

Get Attachment Entries as array

Returns:

array or null

deleteEntry

public boolean deleteEntry(int index)

Delete Entry

Parameters:

index - index

Returns:

true if deleted

deleteAllEntries

public boolean deleteAllEntries()

Delete All Entries

Returns:

true if deleted

getEntryCount

public int getEntryCount()

Get Entry Count

Returns:

number of entries

getEntryName

public String getEntryName(int index)

Get Entry Name

Parameters:

index - index

Returns:

name or null

dumpEntryNames

public void dumpEntryNames()

Dump Entry Names

getEntryData

public byte[] getEntryData(int index)

Get Entry Data

Parameters:

index - index

Returns:

data or null

getEntryFile

public File getEntryFile(int index,
                         String fileName)

Get Entry File with name

Parameters:

index - index

fileName - optional file name

Returns:

file

getEntryFile

public File getEntryFile(int index,
                         File file)

Save Entry in File with name

Parameters:

index - index

file - file

Returns:

file

beforeSave

protected boolean beforeSave(boolean newRecord)

Before Save

Overrides:

beforeSave in class PO

Parameters:

newRecord - new

Returns:

true if can be saved

main

public static void main(String[] args)

Test

Parameters:

args - ignored