|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
A SyncBo is a data repository object representing a business object. It has the following parts that are accessible thru the provided methods:
Example:
Inserting a new row in a SyncBo
SyncBo unlinkedCopy = existingSyncBo.createUnlinkedCopy();
Row newRow = unlinkedCopy.createEmptyRow(rowDesc);
//Set some values to the new row
//Insert the row into the syncbo
unlinkedCopy.insertRow(newRow);
//Commit the txn
Method Summary | |
Row |
createEmptyRow(RowDescriptor rowDescriptor)
Returns an empty Row instance for the specified RowDescriptor. |
SyncBo |
createInitialCopy()
Creates an INITIAL copy of this SyncBo instance. |
SyncBo |
createUnlinkedCopy()
Deprecated. for performant write access to SyncBo and its Rows use Row.modifyFieldValue(FieldDescriptor, Object)
in conjunction with modifyRow(Row) instead. |
void |
deleteRow(Row row)
Deletes the specified Row from this SyncBo. |
void |
deleteRow(RowDescriptor rowDescriptor,
java.math.BigInteger primaryKey)
Deletes an existing child Row having the specified RowDescriptor and primary key from this SyncBo. |
void |
deleteRow(RowDescriptor rowDescriptor,
java.lang.String primaryKey)
Deletes an existing child Row having the specified RowDescriptor and primary key from this SyncBo. |
void |
deleteRow(java.lang.String primaryKey)
Deprecated. Use deleteRow(RowDescriptor rowDescriptor, String primaryKey) or deleteRow(Row row) |
PositionStatusType |
getPositionStatus()
Deprecated. This method will be removed in next MI releases. Use getSyncState() instead. |
ProcessingStatusType |
getProcessingStatus()
Deprecated. This method will be removed in next MI releases. Use getSyncState() instead. |
Row |
getRow(RowDescriptor rowDescriptor,
java.math.BigInteger primaryKey)
Returns the child Row instance having the specified primary key of this SyncBo object. |
Row |
getRow(RowDescriptor rowDescriptor,
java.lang.String primaryKey)
Returns the child Row instance having the specified primary key of this SyncBo object. |
Row |
getRow(java.lang.String primaryKey)
Deprecated. Use getRow(RowDescriptor rowDescriptor, String primaryKey). |
RowCollection[] |
getRows()
Returns the array of static collections of all the child Row objects of this SyncBo. |
RowList |
getRows(Query query)
Returns a static list of child Row objects for a specified query from this SyncBo. |
RowCollection |
getRows(RowDescriptor rowDescriptor)
Returns a static collection of all child Row objects for the specified RowDescriptor from this SyncBo. |
java.lang.String |
getStateId()
gets state id of this SyncBo |
StatusType |
getStatus()
Returns the status property of this SyncBo |
SyncBoDescriptor |
getSyncBoDescriptor()
Returns the SyncBoDescriptor of this SyncBo object. |
java.lang.String |
getSyncKey()
Returns the SyncKey value of this SyncBo |
SyncState |
getSyncState()
Get the sync status of this SyncBo. |
java.lang.String |
getTimeStamp()
Deprecated. |
Row |
getTopRow()
Returns the TOP Row object of this SyncBo. |
void |
insertRow(Row row)
Adds the specified Row object to this SyncBo instance. |
void |
modifyRow(Row row)
This method must be called to make the field changes after Row.modifyFieldValue(FieldDescriptor, Object)
persistent. |
void |
replaceRow(Row row)
Replaces an existing child Row in this SyncBo with the specified Row instance. |
int |
size(Query query)
Returns a the number of child Row objects for a specified query from this SyncBo. |
void |
verifyOperation(Row row,
RowChangeActionType action)
verify the operation to this SyncBo |
Method Detail |
public Row createEmptyRow(RowDescriptor rowDescriptor) throws InvalidDescriptorException
rowDescriptor
- the RowDescriptor of the Row object
to be created
InvalidDescriptorException
- is thrown if the RowDescriptor is
not a member of this SyncBo's descriptor or is a TOP row descriptor of this SyncBopublic void insertRow(Row row) throws ModificationNotAllowedException, PersistenceException
row
- the Row to be added to this
SyncBo
ModificationNotAllowedException
- is thrown for the following
cases: - if the specified Row has a non-INITIAL status
- is a TOP row of this SyncBo
- has a RowDescriptor that is not a member of this SyncBo' descriptor
- the SyncBo update is not allowed as defined in the descriptor
- the SyncBo object is in synchronization state or in IN_SYNC state.
PersistenceException
- is thrown if any persistent
layer related error occurred during the insertionpublic void replaceRow(Row row) throws ModificationNotAllowedException, PersistenceException
row
- the Row to be replaced to the
existing child row in this SyncBo
ModificationNotAllowedException
- is thrown for the following
cases: - if the specified Row is not of UNLINKED status
- is a TOP row of this SyncBo
- has a RowDescriptor that is not a member of this SyncBo' descriptor
- the SyncBo update is not allowed as defined in the descriptor.
- the SyncBo object is in synchronization state or in IN_SYNC state.
PersistenceException
- is thrown if any persistent
layer related error occurred during the replace operationpublic void modifyRow(Row row) throws ModificationNotAllowedException, PersistenceException
Row.modifyFieldValue(FieldDescriptor, Object)
persistent.
row
- the Row with the modified fieldValues
ModificationNotAllowedException
PersistenceException
public void deleteRow(Row row) throws ModificationNotAllowedException, PersistenceException
row
- the child Row to be deleted
from this SyncBo
ModificationNotAllowedException
- is thrown for the following
cases: - if the specified Row is of INITIAL or UNLINKED status
- is a TOP row of this SyncBo
- has a RowDescriptor that is not a member of this SyncBo' descriptor
- the SyncBo update is not allowed as defined in the descriptor.
- the SyncBo object is in synchronization state or in IN_SYNC state.
PersistenceException
- is thrown if any persistent
layer related error occurred during the delete operationpublic void deleteRow(java.lang.String primaryKey) throws ModificationNotAllowedException, PersistenceException
primaryKey
- the primary key of the child
Row to be deleted from this SyncBo
ModificationNotAllowedException
- is thrown for the following
cases: - if the specified Row is of INITIAL or UNLINKED status
- is a TOP row of this SyncBo
- has a RowDescriptor that is not a member of this SyncBo' descriptor
- the SyncBo update is not allowed as defined in the descriptor
- the SyncBo object is in synchronization state or in IN_SYNC state.
PersistenceException
- is thrown if any persistent
layer related error occurred during the delete operationpublic void deleteRow(RowDescriptor rowDescriptor, java.lang.String primaryKey) throws ModificationNotAllowedException, PersistenceException
rowDescriptor
- the RowDescriptor of the child Row to be
deleted from this SyncBoprimaryKey
- the primary key of the child Row to be
deleted from this SyncBo in String format
PersistenceException
- is thrown if any persistent
layer related error occurred during the delete operation
ModificationNotAllowedException
public void deleteRow(RowDescriptor rowDescriptor, java.math.BigInteger primaryKey) throws ModificationNotAllowedException, PersistenceException
rowDescriptor
- the RowDescriptor of the child Row to be
deleted from this SyncBoprimaryKey
- the primary key of the child Row to be
deleted from this SyncBo in BigInteger format
PersistenceException
- is thrown if any persistent
layer related error occurred during the delete operation
ModificationNotAllowedException
public Row getRow(java.lang.String primaryKey) throws PersistenceException
primaryKey
- the primary key of the child Row to be
retrieved from this SyncBo
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic Row getRow(RowDescriptor rowDescriptor, java.lang.String primaryKey) throws PersistenceException
rowDescriptor
- the RowDescriptor of the child Row to be
retrieved from this SyncBoprimaryKey
- the primary key of the child Row to be
retrieved from this SyncBo in String format
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic Row getRow(RowDescriptor rowDescriptor, java.math.BigInteger primaryKey) throws PersistenceException
rowDescriptor
- the RowDescriptor of the child Row to be
retrieved from this SyncBoprimaryKey
- the primary key of the child Row to be
retrieved from this SyncBo in BigInteger format
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic RowCollection getRows(RowDescriptor rowDescriptor) throws PersistenceException
rowDescriptor
- the RowDescriptor of the Row objects to be
retrieved
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic RowList getRows(Query query) throws PersistenceException
query
- the Query object that contains the
condtion
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic int size(Query query) throws PersistenceException
query
- the Query object that contains the
condtion
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic SyncBoDescriptor getSyncBoDescriptor()
public Row getTopRow()
public SyncBo createUnlinkedCopy() throws PersistenceException
Row.modifyFieldValue(FieldDescriptor, Object)
in conjunction with modifyRow(Row)
instead.
Creates an UNLINKED copy of this SyncBo instance. This copy has following characteristics:
NOTE:
An initial copy will be returned if the SyncBo to be copied has an INITIAL status.
PersistenceException
- is thrown if any persistent layer related
error occurred during the creationpublic SyncBo createInitialCopy() throws PersistenceException
PersistenceException
- is thrown if any persistent layer related
error occurred during the creationpublic StatusType getStatus()
public RowCollection[] getRows() throws PersistenceException
PersistenceException
- is thrown if any persistent layer related
error occurred during the retrievalpublic java.lang.String getSyncKey()
public void verifyOperation(Row row, RowChangeActionType action) throws ModificationNotAllowedException
row
- row instance of the operationaction
- action type of the operation
ModificationNotAllowedException
- thrown when operation is not allowedpublic java.lang.String getTimeStamp()
public PositionStatusType getPositionStatus()
getSyncState()
instead.
public ProcessingStatusType getProcessingStatus()
getSyncState()
instead.
public java.lang.String getStateId()
public SyncState getSyncState()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |