Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.alfresco.service.cmr.search
Interface ResultSetMetaData

@org.alfresco.api.AlfrescoPublicApi
public interface ResultSetMetaData
Meta Data associated with a result set.
Author:
Andy Hind

Method Summary
org.alfresco.service.cmr.search.ResultSetColumn
getColumn(String name)
          Get the column meta-data by column name.
getColumnNames()
          Get the column names.
org.alfresco.service.cmr.search.ResultSetColumn[]
getColumns()
          The column meta-data.
getLimitedBy()
          Return how, in fact, the result set was limited.
getPermissionEvaluationMode()
          Return how permission evaluations are being made.
org.alfresco.service.cmr.search.ResultSetType
getResultSetType()
          Get the result set type
getSearchParameters()
          Get the parameters that were specified to define this search.
org.alfresco.service.cmr.search.ResultSetSelector
getSelector(String name)
          Get the selector meta-data by name.
getSelectorNames()
          Get the names of the selectors.
org.alfresco.service.cmr.search.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
org.alfresco.service.cmr.search.ResultSetType getResultSetType()
Get the result set type
Returns:
ResultSetType

getSelectors
org.alfresco.service.cmr.search.ResultSetSelector[] getSelectors()
The selector meta-data.
Returns:
- the selector meta-data.

getColumns
org.alfresco.service.cmr.search.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
org.alfresco.service.cmr.search.ResultSetSelector getSelector(String name)
Get the selector meta-data by name.
Parameters:
name - String
Returns:
- the selector meta-data.

getColumn
org.alfresco.service.cmr.search.ResultSetColumn getColumn(String name)
Get the column meta-data by column name.
Parameters:
name - String
Returns:
- the column meta-data.

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    All Classes
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2005–2018 Alfresco Software. All rights reserved.

Java API documentation generated with DocFlex/Javadoc 1.6.1 using JavadocPro template set.