|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTQueryResult
IPTQueryResult are returned by many server calls. They contain 2D arrays of "raw" data, as well as descriptive metadata (such as sorting information, the properties that are included in the results, etc.) The data is arranged into rows and columns. Each row corresponds to a data set, and each column corresponds to a property about the data set (a property as defined in PT_PROPIDS.) For example, when use the User Object Manager to request a list of User objects in an Administrative Folder, the resulting IPTQueryResult will have a row for each User, and columns for properties like PT_PROPID_OBJECTID and PT_PROPID_NAME When requesting data from a IPTQueryResult, the client typically knows the property that's desired , but does not necessarily know what column stores that data. The IPTQueryResult interface abstracts away the need to know which column contains what data- when requesting a cell from the IPTQueryResult, the client only has to specify row and property ID.
PT_PROPIDS
Method Summary | |
---|---|
int[] |
Columns()
Returns an array which contains the PT_PROPIDS constant describing the contents of each column. |
boolean |
ContainsPropID(int nPropID)
Returns a boolean indicating if the specified property (from PT_PROPIDS) is in this IPTQueryResult. |
java.lang.Object[][] |
Data()
Returns the raw data underlying this QueryResult. |
int |
IsOrdered()
The Plumtree Server will attempt to order result sets before returning them through IPTQueryResult. |
double |
ItemAsDouble(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
float |
ItemAsFloat(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
int |
ItemAsInt(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
java.lang.Object |
ItemAsObject(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
java.lang.String |
ItemAsString(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
com.plumtree.openfoundation.util.XPDateTime |
ItemAsXPDateTime(int nRow,
int nPropID)
Returns the value of a "cell" in this IPTQueryResult. |
int[][] |
OrderedBy()
Calls that return IPTQueryResults generally order the data before returning it. |
int |
RowCount()
Returns the number of rows in this IPTQueryResult |
Methods inherited from interface com.plumtree.server.IPTUnknown |
---|
GetInterfaces |
Method Detail |
---|
int[] Columns()
PT_PROPIDS
java.lang.Object[][] Data()
int IsOrdered()
int[][] OrderedBy()
PT_PROPIDS
,
PT_ORDERBY_SETTINGS
int RowCount()
int ItemAsInt(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
java.lang.String ItemAsString(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
com.plumtree.openfoundation.util.XPDateTime ItemAsXPDateTime(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
float ItemAsFloat(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
double ItemAsDouble(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
java.lang.Object ItemAsObject(int nRow, int nPropID)
nRow
- the row number (a zero based index)nPropID
- the property ID of the desired property (from PT_PROPIDS)
boolean ContainsPropID(int nPropID)
nPropID
- the property desired, from PT_PROPIDS
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |