Coverage Report

Coverage Report - org.kuali.student.r2.core.search.infc.SearchRequest

Classes in this File

 /*
  * Copyright 2010 The Kuali Foundation 
  *
  * Licensed under the Educational Community License, Version 2.0 (the
  * "License"); you may not use this file except in compliance with the
  * License. You may obtain a copy of the License at
  *
  * http://www.osedu.org/licenses/ECL-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
  * implied. See the License for the specific language governing
  * permissions and limitations under the License.
  */
 
 package org.kuali.student.r2.core.search.infc;
 
 import java.util.List;
 
 import org.kuali.student.r2.core.search.dto.SortDirection;
 
 public interface SearchRequest {
 
     /**
      * The search key.
      *
      * @name Search Key
      * @required
      */
     public String getSearchKey();
 
     /**
      * The search parameters.
      *
      * @name Search Paramaeters
      * @required
      */    
     public List<? extends SearchParam> getParams();
 
     /**
      * The sort column.
      *
      * @name Sort Column
      */    
     public String getSortColumn();
 
     /**
      * The sort column direction.
      *
      * @name Sort Direction
      */    
     public SortDirection getSortDirection();
 
     /**
      * The starting position of the results.
      *
      * @name Starting Position
      */    
     public Integer getStartAt();
 
     /**
      * The maximum number of results.
      *
      * @name Maximum Results
      */    
     public Integer getMaxResults();
 
     /**
      * The minimum number of needed results.
      *
      * @name Neeed Total Results
      */    
     public Boolean getNeededTotalResults();
 }

1		/*
2		* Copyright 2010 The Kuali Foundation
3		*
4		* Licensed under the Educational Community License, Version 2.0 (the
5		* "License"); you may not use this file except in compliance with the
6		* License. You may obtain a copy of the License at
7		*
8		* http://www.osedu.org/licenses/ECL-2.0
9		*
10		* Unless required by applicable law or agreed to in writing, software
11		* distributed under the License is distributed on an "AS IS" BASIS,
12		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
13		* implied. See the License for the specific language governing
14		* permissions and limitations under the License.
15		*/
16
17		package org.kuali.student.r2.core.search.infc;
18
19		import java.util.List;
20
21		import org.kuali.student.r2.core.search.dto.SortDirection;
22
23		public interface SearchRequest {
24
25		/**
26		* The search key.
27		*
28		* @name Search Key
29		* @required
30		*/
31		public String getSearchKey();
32
33		/**
34		* The search parameters.
35		*
36		* @name Search Paramaeters
37		* @required
38		*/
39		public List<? extends SearchParam> getParams();
40
41		/**
42		* The sort column.
43		*
44		* @name Sort Column
45		*/
46		public String getSortColumn();
47
48		/**
49		* The sort column direction.
50		*
51		* @name Sort Direction
52		*/
53		public SortDirection getSortDirection();
54
55		/**
56		* The starting position of the results.
57		*
58		* @name Starting Position
59		*/
60		public Integer getStartAt();
61
62		/**
63		* The maximum number of results.
64		*
65		* @name Maximum Results
66		*/
67		public Integer getMaxResults();
68
69		/**
70		* The minimum number of needed results.
71		*
72		* @name Neeed Total Results
73		*/
74		public Boolean getNeededTotalResults();
75		}