Package org.alfresco.service.cmr.search
Interface ResultSetMetaData
-
@AlfrescoPublicApi public interface ResultSetMetaData
Meta Data associated with a result set.- Author:
- Andy Hind
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description ResultSetColumn
getColumn(String name)
Get the column meta-data by column name.String[]
getColumnNames()
Get the column names.ResultSetColumn[]
getColumns()
The column meta-data.LimitBy
getLimitedBy()
Return how, in fact, the result set was limited.PermissionEvaluationMode
getPermissionEvaluationMode()
Return how permission evaluations are being made.ResultSetType
getResultSetType()
Get the result set typeSearchParameters
getSearchParameters()
Get the parameters that were specified to define this search.ResultSetSelector
getSelector(String name)
Get the selector meta-data by name.String[]
getSelectorNames()
Get the names of the selectors.ResultSetSelector[]
getSelectors()
The selector meta-data.
-
-
-
Method Detail
-
getLimitedBy
LimitBy getLimitedBy()
Return how, in fact, the result set was limited. This may not be how it was requested. If a limit of 100 were requested and there were 100 or less actual results this will report LimitBy.UNLIMITED.- Returns:
- LimitBy
-
getPermissionEvaluationMode
PermissionEvaluationMode getPermissionEvaluationMode()
Return how permission evaluations are being made.- Returns:
- PermissionEvaluationMode
-
getSearchParameters
SearchParameters getSearchParameters()
Get the parameters that were specified to define this search.- Returns:
- SearchParameters
-
getResultSetType
ResultSetType getResultSetType()
Get the result set type- Returns:
- ResultSetType
-
getSelectors
ResultSetSelector[] getSelectors()
The selector meta-data.- Returns:
- - the selector meta-data.
-
getColumns
ResultSetColumn[] getColumns()
The column meta-data.- Returns:
- - the column meta-data.
-
getSelectorNames
String[] getSelectorNames()
Get the names of the selectors.- Returns:
- - the selector names.
-
getColumnNames
String[] getColumnNames()
Get the column names.- Returns:
- - the names of the columns.
-
getSelector
ResultSetSelector getSelector(String name)
Get the selector meta-data by name.- Parameters:
name
- String- Returns:
- - the selector meta-data.
-
getColumn
ResultSetColumn getColumn(String name)
Get the column meta-data by column name.- Parameters:
name
- String- Returns:
- - the column meta-data.
-
-