org.jboss.soa.esb.common.bizclasses
Class BatchProcess

java.lang.Object
  org.jboss.soa.esb.util.BaseBusinessObject
      org.jboss.soa.esb.common.bizclasses.BatchProcess

public class BatchProcess
extends BaseBusinessObject

Nested Class Summary

static class	BatchProcess.ATTRIB
static class	BatchProcess.CHLD_LIST

Field Summary

java.util.List<OneValue>	m_olHeaders
java.util.List<OneValue>	m_olItems

Constructor Summary

BatchProcess(BobjStdDTO p_oDto)

BatchProcess(java.lang.String p_sElem, long p_lUid)

Method Summary

void	addChildUid(long p_l) Add a reference to a BusinessObject (it's UID) to the list of batch items BusinessObjects
void	addHeaderUid(long p_l) Add a reference to a BusinessObject (it's UID) to the list of batch header BusinessObjects
long	getChildAt(int p_i) Get an object from the item list
int	getChildCount() Return the number of item objects in this batch
java.lang.String	getField(BatchProcess.ATTRIB pKey)
long	getHeaderAt(int p_i) Get an object from the header list
int	getHeaderCount() Return the number of header objects in this batch
java.lang.String[]	locator() Obtain a String[] of 'human readable' attributes that will help identify the BatchProcess object.
long	rmvChildAt(int p_i) Remove an object from the item list
long	rmvHeaderAt(int p_i) Remove an object from the header list
java.lang.String	setField(BatchProcess.ATTRIB pKey, java.lang.String pVal)
protected java.lang.String	showStamp(BatchProcess.ATTRIB pFld)
BobjStdDTO	toDTO()

Methods inherited from class org.jboss.soa.esb.util.BaseBusinessObject

allLocators, getBatchNum, getDtoList, getElemNm, getFromDTO, getRole, getRoleFromList, getSnap, getSnapDate, getStamp, getUid, hasUid, setBatchNum, setElemNm, setPackage, setRole, setSnap, setSnapDate, setStamp, setUid, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_olHeaders

public java.util.List<OneValue> m_olHeaders

m_olItems

public java.util.List<OneValue> m_olItems

Constructor Detail

BatchProcess

public BatchProcess(java.lang.String p_sElem,
                    long p_lUid)

Parameters:

p_sElem - String

p_lUid - long

See Also:

BaseBusinessObject.BaseBusinessObject(String,long)

BatchProcess

public BatchProcess(BobjStdDTO p_oDto)
             throws java.lang.Exception

Parameters:

p_oDto - BobjStdDTO

Throws:

java.lang.Exception

See Also:

BaseBusinessObject.BaseBusinessObject(BobjStdDTO)

Method Detail

toDTO

public BobjStdDTO toDTO()
                 throws java.lang.Exception

Overrides:

toDTO in class BaseBusinessObject

Returns:

BobjStdDTO

Throws:

java.lang.Exception

See Also:

BusinessObject#toDTO()

addHeaderUid

public void addHeaderUid(long p_l)

Add a reference to a BusinessObject (it's UID) to the list of batch header BusinessObjects

Parameters:

p_l - long - The UID of the BusinessObject to add to the header list

See Also:

m_olHeaders

rmvHeaderAt

public long rmvHeaderAt(int p_i)

Remove an object from the header list

Parameters:

p_i - int - index of header to remove

Returns:

long - UID of the object removed

See Also:

addHeaderUid(long)

addChildUid

public void addChildUid(long p_l)

Add a reference to a BusinessObject (it's UID) to the list of batch items BusinessObjects

Parameters:

p_l - long - The UID of the BusinessObject to add to the item list

See Also:

m_olItems

rmvChildAt

public long rmvChildAt(int p_i)

Remove an object from the item list

Parameters:

p_i - int - index of item to remove

Returns:

long - UID of the object removed

See Also:

addChildUid(long)

getHeaderCount

public int getHeaderCount()

Return the number of header objects in this batch

Returns:

int - The size of the header list

See Also:

m_olHeaders

getHeaderAt

public long getHeaderAt(int p_i)

Get an object from the header list

Parameters:

p_i - int - index of header object to get

Returns:

long - UID of the object at requested position - or minus 1 (-1) if invalid index

See Also:

m_olHeaders

getChildCount

public int getChildCount()

Return the number of item objects in this batch

Returns:

int - The size of the item list

See Also:

m_olItems

getChildAt

public long getChildAt(int p_i)

Get an object from the item list

Parameters:

p_i - int - index of item object to get

Returns:

long - UID of the object at requested position - or minus 1 (-1) if invalid index

See Also:

m_olItems

showStamp

protected final java.lang.String showStamp(BatchProcess.ATTRIB pFld)

locator

public java.lang.String[] locator()

Obtain a String[] of 'human readable' attributes that will help identify the BatchProcess object.

These attributes will be stored in the batch_index table in the Object store to allow for standard SQL queries. Once the desired object is identified, we can access the Object table using the Object's that are referenced in the batch_index table UID

Overrides:

locator in class BaseBusinessObject

Returns:

String[] - Batch number, Creation time, Commit time

setField

public java.lang.String setField(BatchProcess.ATTRIB pKey,
                                 java.lang.String pVal)

getField

public java.lang.String getField(BatchProcess.ATTRIB pKey)