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.ar.dataaccess;
017    
018    import java.util.Iterator;
019    
020    import org.kuali.kfs.module.ar.businessobject.Lockbox;
021    
022    public interface LockboxDao {
023        
024        /**
025         * Retrieves a Lockbox object by primary key.
026         * 
027         * @param invoiceSequenceNumber - primary key
028         * @return Lockbox
029         */
030        public Lockbox getByPrimaryId(Long invoiceSequenceNumber);
031    
032        public Iterator<Lockbox> getByLockboxNumber(String lockboxNumber);
033        
034        public Iterator<Lockbox> getAllLockboxes();
035        
036        /**
037         * 
038         * Returns the highest (numerically) value for the Lockbox 
039         * invoiceSequenceNumber.
040         * 
041         * @return The max Lockbox.invoiceSequenceNumber
042         */
043        public Long getMaxLockboxSequenceNumber();
044        
045    }