com.plumtree.server
Interface IPTListManager

public interface IPTListManager

General interface which is mean to be used for the addition, deletion, and edit of a list of simple "objects". These methods are meant to directly modify the database so there is no in-memory representation of the "object".

Author:

Joseph Chen

Method Summary

int	AddItem(java.lang.Object[][] itemProperties) Adds a new item to the list.
void	DeleteItem(int itemID) Delete an existing item from the list.
IPTQueryResult	QueryItems(int propIDMask, int skipRows, int maxRows, java.lang.Object[][] queryFilter) Query for an item in the list.
void	SetItem(int itemID, java.lang.Object itemProperties) Modifies the characteristics of an item in list.

Method Detail

SetItem

void SetItem(int itemID,
             java.lang.Object itemProperties)

Modifies the characteristics of an item in list.

Parameters:

itemID - Activity ID

itemProperties - 2D Object array containing 2 columns (property ID, property value) and 1-3 rows. Array is in [COL][ROW] format.

AddItem

int AddItem(java.lang.Object[][] itemProperties)

Adds a new item to the list.

Parameters:

itemProperties - Array of item properties

Returns:

ID of newly created item

DeleteItem

void DeleteItem(int itemID)

Delete an existing item from the list.

Parameters:

itemID - Activity ID

QueryItems

IPTQueryResult QueryItems(int propIDMask,
                          int skipRows,
                          int maxRows,
                          java.lang.Object[][] queryFilter)

Query for an item in the list.

Parameters:

propIDMask - PropID mask

skipRows - Number of rows to skip

maxRows - Maximum number of rows to return or -1 to return all rows

queryFilter - Query filter

Returns:

Query result value containing list values