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.endow.dataaccess;
017    
018    import java.util.Collection;
019    import java.util.Iterator;
020    import java.util.List;
021    
022    import org.kuali.kfs.module.endow.businessobject.HoldingTaxLot;
023    
024    public interface HoldingTaxLotDao {
025    
026        /**
027         * Gets all tax lots with positive units that meet the given criteria on kemid, security id, registration code and
028         * income/principal indicator
029         * 
030         * @param kemid
031         * @param securityId
032         * @param registrationCode
033         * @param incomePrincipalIndicator
034         * @return a collection of tax lots that meet the criteria
035         */
036        public Collection<HoldingTaxLot> getAllTaxLotsWithPositiveUnits(String kemid, String securityId, String registrationCode, String incomePrincipalIndicator);
037    
038        /**
039         * Gets all tax lots with positive cost that meet the given criteria on kemid, security id, registration code and
040         * income/principal indicator
041         * 
042         * @param kemid
043         * @param securityId
044         * @param registrationCode
045         * @param incomePrincipalIndicator
046         * @return a collection of tax lots that meet the criteria
047         */
048        public Collection<HoldingTaxLot> getAllTaxLotsWithPositiveCost(String kemid, String securityId, String registrationCode, String incomePrincipalIndicator);
049    
050        /**
051         * Gets all the tax lots for the given security that have units greater than zero.
052         * 
053         * @param securityId
054         * @return all tax lots that meet the criteria
055         */
056        public List<HoldingTaxLot> getTaxLotsPerSecurityIDWithUnitsGreaterThanZero(String securityId);
057    
058        /**
059         * Gets all the tax lots for the given security that have accrued income greater than zero.
060         * 
061         * @param securityId
062         * @return
063         */
064        public List<HoldingTaxLot> getTaxLotsWithAccruedIncomeGreaterThanZeroPerSecurity(String securityId);
065    }