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    
017    package org.kuali.kfs.sys.service;
018    
019    import java.util.Collection;
020    import java.util.Set;
021    
022    import org.kuali.rice.kns.bo.PersistableBusinessObject;
023    import org.kuali.rice.kns.lookup.LookupResultsService;
024    import org.kuali.rice.kns.service.DateTimeService;
025    
026    /**
027     * Used for segemented lookup results
028     */
029    public interface SegmentedLookupResultsService extends LookupResultsService {
030    
031        /**
032         * Retrieve the Date Time Service
033         * 
034         * @return Date Time Service
035         */
036        public DateTimeService getDateTimeService();
037    
038        /**
039         * Assign the Date Time Service
040         * 
041         * @param dateTimeService
042         */
043        public void setDateTimeService(DateTimeService dateTimeService);
044    
045        /**
046         * @param lookupResultsSequenceNumber
047         * @param personId
048         * @return Set<String>
049         */
050        public Set<String> retrieveSetOfSelectedObjectIds(String lookupResultsSequenceNumber, String personId) throws Exception;
051    
052        /**
053         * @param lookupResultsSequenceNumber
054         * @param setOfSelectedObjIds
055         * @param boClass
056         * @param personId
057         * @return Collection<PersistableBusinessObject>
058         */
059        public Collection<PersistableBusinessObject> retrieveSelectedResultBOs(String lookupResultsSequenceNumber, Set<String> setOfSelectedObjIds, Class boClass, String personId) throws Exception;
060    }
061