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.document.service;
017    
018    import java.util.Collection;
019    
020    import org.kuali.kfs.module.endow.businessobject.TransactionArchive;
021    
022    public interface TransactionArchiveService {
023    
024        /**
025         * Gets a collection of records from END_TRAN_ARCHV_T table
026         * @return transactionArchives
027         */
028        public Collection<TransactionArchive> getAllTransactionArchives();
029        
030        /**
031         * Gets a transactionArchive by primary keys.
032         * 
033         * @param documentNumber, lineNumber, lineTypeCode
034         * @return a transactionArchive
035         */
036        public TransactionArchive getByPrimaryKey(String documentNumber, int lineNumber, String lineTypeCode);
037    
038        /**
039         * Gets a collection of records from END_TRAN_ARCHV_T table for a given DOC_TYP_NM
040         * @param typeCode The document type name (DOC_TYP_NM in the table)
041         * @return transactionArchives
042         */
043        public Collection<TransactionArchive> getTransactionArchivesByDocumentTypeName(String typeCode);
044    
045        /**
046         * Gets a collection of records from END_TRAN_ARCHV_T table for a given ETranCode
047         * @param etranCode The etranCode (TRAN_ETRAN_CD in the table)
048         * @return transactionArchives
049         */
050        public Collection<TransactionArchive> getTransactionArchivesByETranCode(String etranCode);
051    
052        /**
053         * Gets a collection of records from END_TRAN_ARCHV_T table for a given DOC_TYP_NM and TRAN_ETRAN_CD
054         * @param typeCode The document type name (DOC_TYP_NM in the table)
055         * @param etranCode The etranCode (TRAN_ETRAN_CD in the table)
056         * @return transactionArchives
057         */
058        public Collection<TransactionArchive> getTransactionArchivesByDocumentTypeNameAndETranCode(String typeCode, String etranCode);
059    
060        /**
061         * Gets a collection of records from END_TRAN_ARCHV_T table for a given TRAN_IP_IND_CD
062         * @param incomePrincipalIndicator The income or principal indicator (TRAN_IP_IND_CD in the table)
063         * @return transactionArchives where the indicator is I (income) or P (principal)
064         */
065        public Collection<TransactionArchive> getTransactionArchivesByIncomeOrPrincipalIndicator(String incomeOrPrincipalIndicator);
066    
067        /**
068         * Gets a collection of records from END_TRAN_ARCHV_T table for a given TRAN_IP_IND_CD, DOC_TYP_NM, TRAN_ETRAN_CD
069         * @param typeCode, etranCode
070         * @return transactionArchives where the incomePrincipalIndicator = B
071         */
072        public Collection<TransactionArchive> getAllTransactionArchives(String typeCode, String etranCode);
073        
074    }