KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > alfresco > service > cmr > search > ResultSetMetaData


1 /*
2  * Copyright (C) 2005 Alfresco, Inc.
3  *
4  * Licensed under the Mozilla Public License version 1.1
5  * with a permitted attribution clause. You may obtain a
6  * copy of the License at
7  *
8  * http://www.alfresco.org/legal/license.txt
9  *
10  * Unless required by applicable law or agreed to in writing,
11  * software distributed under the License is distributed on an
12  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
13  * either express or implied. See the License for the specific
14  * language governing permissions and limitations under the
15  * License.
16  */
17 package org.alfresco.service.cmr.search;
18
19 /**
20  * Meta Data associated with a result set.
21  *
22  * @author Andy Hind
23  */
24 public interface ResultSetMetaData
25 {
26     
27     /**
28      * Return how, <b>in fact</b>, the result set was limited.
29      * This may not be how it was requested.
30      *
31      * If a limit of 100 were requested and there were 100 or less actual results
32      * this will report LimitBy.UNLIMITED.
33      *
34      * @return
35      */
36     public LimitBy getLimitedBy();
37     
38     /**
39      * Return how permission evaluations are being made.
40      *
41      * @return
42      */
43     public PermissionEvaluationMode getPermissionEvaluationMode();
44     
45     /**
46      * Get the parameters that were specified to define this search.
47      *
48      * @return
49      */
50     public SearchParameters getSearchParameters();
51     
52 }
53
Popular Tags