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.document.service;
017    
018    import org.kuali.kfs.module.ar.businessobject.CustomerAddress;
019    
020    public interface CustomerAddressService {
021    
022        /**
023         * This method returns a customer address by primary key
024         * 
025         * @param customerNumber
026         * @param customerAddressIdentifier
027         * @return
028         */
029        public CustomerAddress getByPrimaryKey(String customerNumber, Integer customerAddressIdentifier);
030    
031        /**
032         * This method returns true if customer address exists
033         * 
034         * @param customerNumber
035         * @param customerAddressIdentifier
036         * @return
037         */
038        public boolean customerAddressExists(String customerNumber, Integer customerAddressIdentifier);
039    
040        /**
041         * This method gets the next address identifier
042         * @return
043         */
044        public Integer getNextCustomerAddressIdentifier();
045        
046        /**
047         * 
048         * This method returns the CustomerAddress specified as the primary address for a Customer.
049         * @param customerNumber
050         * @return
051         */
052        
053        public CustomerAddress getPrimaryAddress(String customerNumber);
054    
055        /**
056         * This method returns true if customer address is active
057         * 
058         * @param customerNumber
059         * @param customerAddressIdentifier
060         * @return
061         */
062        public boolean customerAddressActive(String customerNumber, Integer customerAddressIdentifier);
063    }