View Javadoc
1   /*
2    * Copyright 2007 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.ole.gl.web.struts;
17  
18  import java.util.Map;
19  import java.util.Set;
20  
21  import javax.servlet.http.HttpServletRequest;
22  
23  public interface LookupResultsSelectable {
24      public void populate(HttpServletRequest request);
25  
26      /**
27       * This method converts the composite object IDs into a String
28       * 
29       * @return String
30       */
31      public String getCompositeSelectedObjectIds();
32  
33      public int getViewedPageNumber();
34  
35      public void setViewedPageNumber(int pageNumberBeingViewedForMultivalueLookups);
36  
37      public String getLookupResultsSequenceNumber();
38  
39      public void setLookupResultsSequenceNumber(String lookupResultSequenceNumber);
40  
41      public int getTotalNumberOfPages();
42  
43      public void setTotalNumberOfPages(int totalNumberOfPages);
44  
45      public int getFirstRowIndex();
46  
47      public void setFirstRowIndex(int firstRowIndex);
48  
49      public int getLastRowIndex();
50  
51      public void setLastRowIndex(int lastRowIndex);
52  
53      public int getSwitchToPageNumber();
54  
55      public Set<String> getPreviouslySelectedObjectIdSet();
56  
57      public void setPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds);
58  
59      public Set<String> getSelectedObjectIdSet();
60  
61      public void setSelectedObjectIdSet(Set<String> selectedObjectIdSet);
62  
63      public Set<String> getDisplayedObjectIdSet();
64  
65      public void setDisplayedObjectIdSet(Set<String> displayedObjectIdSet);
66  
67      public Map<String, String> getCompositeObjectIdMap();
68  
69      public void setCompositeObjectIdMap(Map<String, String> compositeObjectIdMap);
70  
71      public int getColumnToSortIndex();
72  
73      public void setColumnToSortIndex(int columnToSortIndex);
74  
75      public String getPreviouslySortedColumnIndex();
76  
77      public void setPreviouslySortedColumnIndex(String previouslySortedColumnIndex);
78  
79      /**
80       * gets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
81       * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
82       * be returned.
83       * 
84       * @return String
85       */
86      public String getLookedUpCollectionName();
87  
88      /**
89       * sets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
90       * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
91       * be returned
92       * 
93       * @param lookedUpCollectionName
94       */
95      public void setLookedUpCollectionName(String lookedUpCollectionName);
96  
97      public int getResultsActualSize();
98  
99      public void setResultsActualSize(int resultsActualSize);
100 
101     public int getResultsLimitedSize();
102 
103     public void setResultsLimitedSize(int resultsLimitedSize);
104 
105     public void jumpToFirstPage(int listSize, int maxRowsPerPage);
106 
107     public void jumpToLastPage(int listSize, int maxRowsPerPage);
108 
109     public void jumpToPage(int pageNumber, int listSize, int maxRowsPerPage);
110 }