001/*
002 * Copyright 2008-2009 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 */
016package org.kuali.ole.module.purap.dataaccess;
017
018import org.kuali.ole.module.purap.businessobject.ElectronicInvoiceItemMapping;
019import org.kuali.ole.module.purap.businessobject.ItemType;
020
021import java.util.List;
022
023/**
024 * @author This dao and its implementation is used for data retrieval/insertion/deletion by the
025 *         ElectronicInvoiceItemMappingService which is used by the maintenance page for Electronic Invoice Item Mapping.
026 */
027public interface ElectronicInvoiceItemMappingDao {
028
029    /**
030     * Get list of all ElectronicInvoiceItemMappings
031     */
032    public List getAll();
033
034    /**
035     * Get an ElectronicInvoiceItemMapping by primary key.
036     *
037     * @param id the id to lookup
038     */
039    public ElectronicInvoiceItemMapping getById(String id);
040
041    /**
042     * Get an ElectronicInvoiceItemMapping based on the 3 unique keys. This method is used to ensure that the user is not inserting
043     * a row that contains the same 3 keys that have already existed in the database
044     *
045     * @param headerId        the vendorHeaderGeneratedId
046     * @param detailId        the vendorDetailAssignedId
047     * @param invoiceTypeCode the electronicInvoiceTypeCode
048     * @return
049     */
050    public ElectronicInvoiceItemMapping getByUniqueKeys(Integer headerId, Integer detailId, String invoiceTypeCode);
051
052    /**
053     * Delete a ElectronicInvoiceItemMapping.
054     *
055     * @param row
056     */
057    public void delete(ElectronicInvoiceItemMapping row);
058
059    /**
060     * This method returns a list of all Item Types from the PUR_AP_ITM_TYP_T table
061     *
062     * @return
063     */
064    public List getAllItemTypes();
065
066    public ItemType getItemTypeByCode(String code);
067}