diff options
Diffstat (limited to 'pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java')
-rw-r--r-- | pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java | 89 |
1 files changed, 47 insertions, 42 deletions
diff --git a/pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java b/pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java index a5041c2f..8e627520 100644 --- a/pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java +++ b/pki/base/common/src/com/netscape/certsrv/dbs/IDBVirtualList.java @@ -17,21 +17,24 @@ // --- END COPYRIGHT BLOCK --- package com.netscape.certsrv.dbs; + import com.netscape.certsrv.base.EBaseException; + /** - * A interface represents a virtual list of search results. Note that this class - * must be used with DS4.0. - * + * A interface represents a virtual list of search results. + * Note that this class must be used with DS4.0. + * * @version $Revision$, $Date$ */ public interface IDBVirtualList { /** - * Sets the paging size of this virtual list. The page size here is just a - * buffer size. A buffer is kept around that is three times as large as the - * number of visible entries. That way, you can scroll up/down several - * items(up to a page-full) without refetching entries from the directory. + * Sets the paging size of this virtual list. + * The page size here is just a buffer size. A buffer is kept around + * that is three times as large as the number of visible entries. + * That way, you can scroll up/down several items(up to a page-full) + * without refetching entries from the directory. * * @param size the page size */ @@ -39,7 +42,7 @@ public interface IDBVirtualList { /** * Sets the sort key - * + * * @param sortKey the attribute to sort by * @exception EBaseException failed to set */ @@ -47,93 +50,95 @@ public interface IDBVirtualList { /** * Sets the sort key - * + * * @param sortKeys the attributes to sort by * @exception EBaseException failed to set */ public void setSortKey(String[] sortKeys) throws EBaseException; /** - * Retrieves the size of this virtual list. Recommend to call getSize() - * before getElementAt() or getElements() since you'd better check if the - * index is out of bound first. - * + * Retrieves the size of this virtual list. + * Recommend to call getSize() before getElementAt() or getElements() + * since you'd better check if the index is out of bound first. + * * @return current size in list */ public int getSize(); /** * Returns current index. - * + * * @return current index */ public int getSizeBeforeJumpTo(); - public int getSizeAfterJumpTo(); public int getCurrentIndex(); - /** - * Get a page starting at "first" (although we may also fetch some preceding - * entries) Recommend to call getSize() before getElementAt() or - * getElements() since you'd better check if the index is out of bound - * first. - * + /** + * Get a page starting at "first" (although we may also fetch + * some preceding entries) + * Recommend to call getSize() before getElementAt() or getElements() + * since you'd better check if the index is out of bound first. + * * @param first the index of the first entry of the page you want to fetch */ public boolean getPage(int first); - /** - * Called by application to scroll the list with initial letters. Consider - * text to be an initial substring of the attribute of the primary sorting - * key(the first one specified in the sort key array) of an entry. If no - * entries match, the one just before(or after, if none before) will be - * returned as mSelectedIndex - * + /** + * Called by application to scroll the list with initial letters. + * Consider text to be an initial substring of the attribute of the + * primary sorting key(the first one specified in the sort key array) + * of an entry. + * If no entries match, the one just before(or after, if none before) + * will be returned as mSelectedIndex + * * @param text the prefix of the first entry of the page you want to fetch */ public boolean getPage(String text); - /** - * Fetchs data of a single list item Recommend to call getSize() before - * getElementAt() or getElements() since you'd better check if the index is - * out of bound first. If the index is out of range of the virtual list, an - * exception will be thrown and return null - * + /** + * Fetchs data of a single list item + * Recommend to call getSize() before getElementAt() or getElements() + * since you'd better check if the index is out of bound first. + * If the index is out of range of the virtual list, an exception + * will be thrown and return null + * * @param index the index of the element to fetch */ public Object getElementAt(int index); /** * Retrieves and jumps to element in the given position. - * + * * @param i position * @return object */ public Object getJumpToElementAt(int i); /** - * Processes elements as soon as it arrives. It is more memory-efficient. - * + * Processes elements as soon as it arrives. It is + * more memory-efficient. + * * @param startidx starting index * @param endidx ending index * @param ep object to call * @exception EBaseException failed to process elements */ public void processElements(int startidx, int endidx, IElementProcessor ep) - throws EBaseException; + throws EBaseException; - /** + /** * Gets the virutal selected index - * + * * @return selected index */ public int getSelectedIndex(); - /** + /** * Gets the top of the buffer - * + * * @return first index */ public int getFirstIndex(); |