001    /*
002     * Copyright 2011 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     */
016    package org.kuali.kfs.module.ld.document.web.struts;
017    
018    /**
019     * Interface for defining a <code>{@link ActionForm}</code> that has multiple value lookups on it; however, it should not be
020     * implemented by a class that extends <code>{@link LookupForm}</code> or <code>{@link MultipleValueLookupForm}</code> unless
021     * you have a really, really good reason.
022     * 
023     * @see MultipleValueLookupForm
024     */
025    public interface MultipleValueLookupBroker {
026    
027        /**
028         * @see org.kuali.rice.kns.web.struts.form.KualiForm#getRefreshCaller()
029         */
030        public String getRefreshCaller();
031    
032        /**
033         * Get lookup results sequence number.
034         * 
035         * @return String
036         */
037        public String getLookupResultsSequenceNumber();
038    
039    
040        /**
041         * Set lookup results sequence number.
042         * 
043         * @param lookupResultsSequenceNumber
044         */
045        public void setLookupResultsSequenceNumber(String lookupResultsSequenceNumber);
046    
047    
048        /**
049         * Get lookup results business object class name.
050         * 
051         * @return String
052         */
053        public String getLookupResultsBOClassName();
054    
055    
056        /**
057         * Set lookup results business object class name.
058         * 
059         * @param lookupResultsSequenceNumber
060         */
061        public void setLookupResultsBOClassName(String lookupResultsBOClassName);
062    
063    
064        /**
065         * Get looked up collection name.
066         * 
067         * @return String
068         */
069        public String getLookedUpCollectionName();
070    
071    
072        /**
073         * Set looked up collection name.
074         * 
075         * @param lookupResultsSequenceNumber
076         */
077        public void setLookedUpCollectionName(String lookedUpCollectionName);
078    }