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.coa.service;
017    
018    import java.util.List;
019    import java.util.Map;
020    
021    import org.kuali.kfs.coa.businessobject.OrganizationReversion;
022    import org.kuali.kfs.coa.businessobject.OrganizationReversionCategory;
023    import org.kuali.kfs.gl.batch.service.OrganizationReversionCategoryLogic;
024    
025    /**
026     * 
027     * This service interface defines methods necessary for retrieving fully populated OrganizationReversion business objects from the database
028     * that are necessary for transaction processing in the application. It also defines methods to retrieve org reversion categories
029     */
030    public interface OrganizationReversionService {
031        /**
032         * Get an organization reversion record
033         * 
034         * @param fiscalYear Fiscal Year
035         * @param chartCode Chart
036         * @param organizationCode Organization code
037         * @return Org Reversion record
038         */
039        public OrganizationReversion getByPrimaryId(Integer fiscalYear, String chartCode, String organizationCode);
040    
041        /**
042         * Get org reversion categories
043         * 
044         * @return map of org reversion categories
045         */
046        public Map<String, OrganizationReversionCategoryLogic> getCategories();
047    
048        /**
049         * List of reversion categories in order of the sort code
050         * 
051         * @return list of org reversion category codes
052         */
053        public List<OrganizationReversionCategory> getCategoryList();
054        
055        /**
056         * Determines if the given category code represents an active category
057         * @param categoryCode the category code to check
058         * @return true if the given category code represents an active category; false otherwise
059         */
060        public boolean isCategoryActive(String categoryCode);
061        
062        /**
063         * Determines if the given category name represents an active category
064         * @param categoryName the category name to check
065         * @return true if the given category name represents an active category; false otherwise
066         */
067        public boolean isCategoryActiveByName(String categoryName);
068        
069        /**
070         * 
071         * This method looks up the default object code to populate the Organization Reversion object code if the 
072         * "carry Forward by Object Code" box is not checked.
073         * @return system parameter default value for Organization Reversion detail
074         */
075        public String getOrganizationReversionDetaiFromSystemParameters();
076    }