|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.plumtree.uiinfrastructure.arraywrapper.PTSortedArrayWrapper com.plumtree.portaluiinfrastructure.resultwrapper.APTQueryWrapper com.plumtree.portaluiinfrastructure.resultwrapper.PTSortedDocumentsQueryWrapper
public class PTSortedDocumentsQueryWrapper
APTSortedQueryWrapper: The PTSortedDocumentsQueryWrapper class wraps the IPTTurboQueryResult Server object that's returned by the various Query methods of IPTFolder. This wrapper handles the details of retrieving a subset of the data, sorting on the client when necessary, etc.
Field Summary | |
---|---|
protected boolean |
m_bShowUnapproved
RP- false to show only approved docs, true to show unapproved docs also |
protected int |
m_iPropIDMask
MES- The Property ID mask we're using, if we need to requery to resort |
protected int |
m_nSkippedRows
SCC - Number of rows to skip (used when doing displaying ranges of Documents |
protected IPTFolder |
m_ptFolder
MES- The Folder ID we're using, if we need to requery to resort |
protected java.lang.Object[][] |
m_ptqf
DH- The query filter we're using, if we need to requery to resort |
Fields inherited from class com.plumtree.portaluiinfrastructure.resultwrapper.APTQueryWrapper |
---|
m_iMaxRows, m_iMode, PTTQRW_DEFAULT_MAX_ROWS, PTTQRW_MODE_CLIENT, PTTQRW_MODE_TRUNCATED |
Fields inherited from class com.plumtree.uiinfrastructure.arraywrapper.PTSortedArrayWrapper |
---|
m_arrData, m_arrSort, m_bSortOptimized, m_hashPropIDtoColumn, m_lstRowMapping, PTSAW_NEWITEMSINFO_INDEX, PTSAW_NEWITEMSINFO_NEWVALUE, PTSAW_NEWITEMSINFO_PROPERTYID, PTSAW_SORT_ASCENDING, PTSAW_SORT_DESCENDING, PTSAW_SORT_ROW_DIRECTION, PTSAW_SORT_ROW_PROPID |
Constructor Summary | |
---|---|
PTSortedDocumentsQueryWrapper(IPTFolder ptFolder)
RP- The constructor is used by clients to attach this instance to a Catalog Folder. |
Method Summary | |
---|---|
void |
Initialize(int[] arrColumnIDs,
java.lang.Object[][] arrData,
int[][] arrSort,
boolean bRequiresSort)
MES- This version of Initialize masks the Initialize of our superclass- we want to make sure that clients don't call the wrong version of Initialize. |
boolean |
QueryCards(int iPropIDMask,
boolean bShowUnapproved,
int[][] arrSort,
java.lang.Object[][] queryFilter)
MES- Query wraps the IPTFolder call of the same name |
void |
SetSkippedRows(int nSkippedRows)
Set the number of rows to skip when Querying Cards |
void |
Sort(int[][] arrSort)
MES- Sort is used to resort the data. |
Methods inherited from class com.plumtree.portaluiinfrastructure.resultwrapper.APTQueryWrapper |
---|
GetFields, IsComplete, MaxRows, SetMaxRows |
Methods inherited from class com.plumtree.uiinfrastructure.arraywrapper.PTSortedArrayWrapper |
---|
ContainsPropID, GetCount, GetItem, GetSort, MapColumnIDs, SetItem, SetItems, SortInternal |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.plumtree.portaluiinfrastructure.resultwrapper.IASQueryResult |
---|
GetCount |
Field Detail |
---|
protected IPTFolder m_ptFolder
protected java.lang.Object[][] m_ptqf
protected int m_iPropIDMask
protected boolean m_bShowUnapproved
protected int m_nSkippedRows
Constructor Detail |
---|
public PTSortedDocumentsQueryWrapper(IPTFolder ptFolder)
ptFolder
- is the folder we should be queryingMethod Detail |
---|
public void Initialize(int[] arrColumnIDs, java.lang.Object[][] arrData, int[][] arrSort, boolean bRequiresSort)
Initialize
in class PTSortedArrayWrapper
arrColumnIDs
- is not usedarrData
- is not usedarrSort
- is not usedbRequiresSort
- is not used
XPException
- is not usedpublic boolean QueryCards(int iPropIDMask, boolean bShowUnapproved, int[][] arrSort, java.lang.Object[][] queryFilter)
iPropIDMask
- is a bitmask of the properties to be returned as
columnsiShowUnapproved
- arrSort
- is a 2D int array of PropertyIDs to sort by. It should
contain a column for each sort. The first row holds the
PropertyID, and the second row holds the sort direction,
PTSAW_SORT_ASCENDING or PTSAW_SORT_DESCENDINGqueryFilter
- is a 2D Object array that is a query filter
public void SetSkippedRows(int nSkippedRows)
public void Sort(int[][] arrSort)
Sort
in class PTSortedArrayWrapper
arrSort
- is a 2D int array of PropertyIDs to sort by. It should
contain a column for each sort. The first row holds the
PropertyID, and the second row holds the sort direction,
PTSAW_SORT_ASCENDING or PTSAW_SORT_DESCENDING
XPException
|
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |