View Javadoc

1   /**
2    * Copyright 2005-2013 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 org.displaytag.pagination.PaginatedList;
19  import org.displaytag.properties.SortOrderEnum;
20  import org.kuali.rice.kew.actionitem.ActionItemBase;
21  
22  import java.util.List;
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 ActionItemBase> 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 ActionItemBase> 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  	@Override
51      public int getFullListSize() {
52  		return fullListSize;
53  	}
54  
55  	@Override
56      public List getList() {
57  		return list;
58  	}
59  
60  	@Override
61      public int getObjectsPerPage() {
62  		return objectsPerPage;
63  	}
64  
65  	@Override
66      public int getPageNumber() {
67  		return pageNumber;
68  	}
69  
70  	@Override
71      public String getSearchId() {
72  		return searchId;
73  	}
74  
75  	@Override
76      public String getSortCriterion() {
77  		return sortCriterion;
78  	}
79  
80  	@Override
81      public SortOrderEnum getSortDirection() {
82  		return sortDirection;
83  	}
84  
85  }