001/*
002 * Copyright 2007 The Kuali Foundation
003 * 
004 * Licensed under the Educational Community License, Version 2.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/ecl2.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 */
016package org.kuali.ole.gl.web.struts;
017
018import java.util.Map;
019import java.util.Set;
020
021import javax.servlet.http.HttpServletRequest;
022
023public 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(int pageNumberBeingViewedForMultivalueLookups);
036
037    public String getLookupResultsSequenceNumber();
038
039    public void setLookupResultsSequenceNumber(String lookupResultSequenceNumber);
040
041    public int getTotalNumberOfPages();
042
043    public void setTotalNumberOfPages(int totalNumberOfPages);
044
045    public int getFirstRowIndex();
046
047    public void setFirstRowIndex(int firstRowIndex);
048
049    public int getLastRowIndex();
050
051    public void setLastRowIndex(int lastRowIndex);
052
053    public int getSwitchToPageNumber();
054
055    public Set<String> getPreviouslySelectedObjectIdSet();
056
057    public void setPreviouslySelectedObjectIdSet(Set<String> previouslySelectedObjectIds);
058
059    public Set<String> getSelectedObjectIdSet();
060
061    public void setSelectedObjectIdSet(Set<String> selectedObjectIdSet);
062
063    public Set<String> getDisplayedObjectIdSet();
064
065    public void setDisplayedObjectIdSet(Set<String> displayedObjectIdSet);
066
067    public Map<String, String> getCompositeObjectIdMap();
068
069    public void setCompositeObjectIdMap(Map<String, String> compositeObjectIdMap);
070
071    public int getColumnToSortIndex();
072
073    public void setColumnToSortIndex(int columnToSortIndex);
074
075    public String getPreviouslySortedColumnIndex();
076
077    public void setPreviouslySortedColumnIndex(String previouslySortedColumnIndex);
078
079    /**
080     * gets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
081     * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
082     * be returned.
083     * 
084     * @return String
085     */
086    public String getLookedUpCollectionName();
087
088    /**
089     * sets the name of the collection being looked up by the calling page. This value will be returned unmodified to the calling
090     * page (indicated by super.getBackLocation()), which should use it to determine in which collection the selected results will
091     * be returned
092     * 
093     * @param lookedUpCollectionName
094     */
095    public void setLookedUpCollectionName(String lookedUpCollectionName);
096
097    public int getResultsActualSize();
098
099    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}