001: /*
002: * Copyright 2007 The Kuali Foundation.
003: *
004: * Licensed under the Educational Community License, Version 1.0 (the "License");
005: * you may not use this file except in compliance with the License.
006: * You may obtain a copy of the License at
007: *
008: * http://www.opensource.org/licenses/ecl1.php
009: *
010: * Unless required by applicable law or agreed to in writing, software
011: * distributed under the License is distributed on an "AS IS" BASIS,
012: * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013: * See the License for the specific language governing permissions and
014: * limitations under the License.
015: */
016: package org.kuali.module.gl.web.struts.form;
017:
018: import java.util.Map;
019: import java.util.Set;
020:
021: import javax.servlet.http.HttpServletRequest;
022:
023: public interface LookupResultsSelectable {
024: public void populate(HttpServletRequest request);
025:
026: /**
027: * This method converts the composite object IDs into a String
028: *
029: * @return String
030: */
031: public String getCompositeSelectedObjectIds();
032:
033: public int getViewedPageNumber();
034:
035: public void setViewedPageNumber(
036: int pageNumberBeingViewedForMultivalueLookups);
037:
038: public String getLookupResultsSequenceNumber();
039:
040: public void setLookupResultsSequenceNumber(
041: String lookupResultSequenceNumber);
042:
043: public int getTotalNumberOfPages();
044:
045: public void setTotalNumberOfPages(int totalNumberOfPages);
046:
047: public int getFirstRowIndex();
048:
049: public void setFirstRowIndex(int firstRowIndex);
050:
051: public int getLastRowIndex();
052:
053: public void setLastRowIndex(int lastRowIndex);
054:
055: public int getSwitchToPageNumber();
056:
057: public Set<String> getPreviouslySelectedObjectIdSet();
058:
059: public void setPreviouslySelectedObjectIdSet(
060: Set<String> previouslySelectedObjectIds);
061:
062: public Set<String> getSelectedObjectIdSet();
063:
064: public void setSelectedObjectIdSet(Set<String> selectedObjectIdSet);
065:
066: public Set<String> getDisplayedObjectIdSet();
067:
068: public void setDisplayedObjectIdSet(Set<String> displayedObjectIdSet);
069:
070: public Map<String, String> getCompositeObjectIdMap();
071:
072: public void setCompositeObjectIdMap(
073: Map<String, String> compositeObjectIdMap);
074:
075: public int getColumnToSortIndex();
076:
077: public void setColumnToSortIndex(int columnToSortIndex);
078:
079: public String getPreviouslySortedColumnIndex();
080:
081: public void setPreviouslySortedColumnIndex(
082: String previouslySortedColumnIndex);
083:
084: /**
085: * gets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
086: * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
087: * be returned.
088: *
089: * @return String
090: */
091: public String getLookedUpCollectionName();
092:
093: /**
094: * sets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
095: * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
096: * be returned
097: *
098: * @param lookedUpCollectionName
099: */
100: public void setLookedUpCollectionName(String lookedUpCollectionName);
101:
102: public int getResultsActualSize();
103:
104: public void setResultsActualSize(int resultsActualSize);
105:
106: public int getResultsLimitedSize();
107:
108: public void setResultsLimitedSize(int resultsLimitedSize);
109:
110: public void jumpToFirstPage(int listSize, int maxRowsPerPage);
111:
112: public void jumpToLastPage(int listSize, int maxRowsPerPage);
113:
114: public void jumpToPage(int pageNumber, int listSize,
115: int maxRowsPerPage);
116: }
|