Minor javadoc tweak

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@4728 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Derek Hulley
2007-01-04 17:10:46 +00:00
parent 0a76193084
commit 08bf759565

View File

@@ -23,14 +23,14 @@ import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.Path; import org.alfresco.service.cmr.repository.Path;
/** /**
* An iterable result set from a searcher query. TODO: Expose meta data and XML * An iterable result set from a searcher query.<b/>
* Implementations must implement the indexes as zero-based.<b/>
* TODO: Expose meta data and XML
* *
* @author andyh * @author andyh
* *
*/ */
public interface ResultSet extends Iterable<ResultSetRow> // Specfic iterator public interface ResultSet extends Iterable<ResultSetRow> // Specfic iterator over ResultSetRows
// over
// ResultSetRows
{ {
/** /**
* Get the relative paths to all the elements contained in this result set * Get the relative paths to all the elements contained in this result set
@@ -61,37 +61,26 @@ public interface ResultSet extends Iterable<ResultSetRow> // Specfic iterator
/** /**
* Get a row from the result set by row index, starting at 0. * Get a row from the result set by row index, starting at 0.
*
* @param i
* @return
*/ */
ResultSetRow getRow(int i); ResultSetRow getRow(int i);
/** /**
* Get a list of all the node refs in the result set * Get a list of all the node refs in the result set
* @return
*/ */
List<NodeRef> getNodeRefs(); List<NodeRef> getNodeRefs();
/** /**
* Get a list of all the child associations in the results set. * Get a list of all the child associations in the results set.
*
* @return
*/ */
List<ChildAssociationRef> getChildAssocRefs(); List<ChildAssociationRef> getChildAssocRefs();
/** /**
* Get the child assoc ref for a particular row. * Get the child assoc ref for a particular row.
*
* @param n
* @return
*/ */
ChildAssociationRef getChildAssocRef(int n); ChildAssociationRef getChildAssocRef(int n);
/** /**
* Get the meta data for the results set. * Get the meta data for the results set.
*
* @return
*/ */
ResultSetMetaData getResultSetMetaData(); ResultSetMetaData getResultSetMetaData();
} }