View Javadoc

1   /**
2    * Copyright 2005-2015 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
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 implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kew.actionlist;
17  
18  import java.util.List;
19  
20  import org.displaytag.pagination.PaginatedList;
21  import org.displaytag.properties.SortOrderEnum;
22  import org.kuali.rice.kew.actionitem.ActionItemActionListExtension;
23  
24  /**
25   * Implements the display tags paginated list to provide effecient paging for the action list.  
26   * This allows us not to have to fetch an entire action list each time a user pages their list.
27   *
28   * @author Kuali Rice Team (rice.collab@kuali.org)
29   */
30  public class PaginatedActionList implements PaginatedList {
31  
32  	private final List<? extends ActionItemActionListExtension> list;
33  	private final int fullListSize;
34  	private final int pageNumber;
35  	private final int objectsPerPage;
36  	private final String searchId;
37  	private final String sortCriterion;
38  	private final SortOrderEnum sortDirection; 
39  	
40  	public PaginatedActionList(List<? extends ActionItemActionListExtension> list, int fullListSize, int pageNumber, int objectsPerPage, String searchId, String sortCriterion, SortOrderEnum sortDirection) {
41  		this.list = list;
42  		this.fullListSize = fullListSize;
43  		this.pageNumber = pageNumber;
44  		this.objectsPerPage = objectsPerPage;
45  		this.searchId = searchId;
46  		this.sortCriterion = sortCriterion;
47  		this.sortDirection = sortDirection;
48  	}
49  	
50  	public int getFullListSize() {
51  		return fullListSize;
52  	}
53  
54  	public List getList() {
55  		return list;
56  	}
57  
58  	public int getObjectsPerPage() {
59  		return objectsPerPage;
60  	}
61  
62  	public int getPageNumber() {
63  		return pageNumber;
64  	}
65  
66  	public String getSearchId() {
67  		return searchId;
68  	}
69  
70  	public String getSortCriterion() {
71  		return sortCriterion;
72  	}
73  
74  	public SortOrderEnum getSortDirection() {
75  		return sortDirection;
76  	}
77  	
78  }