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.gl.batch.service;
017    
018    import org.kuali.kfs.coa.businessobject.ObjectCode;
019    
020    /**
021     * An interface that represents the logic of a category associated with the Organization Reversion Process
022     */
023    public interface OrganizationReversionCategoryLogic {
024        
025        /**
026         * Given an object code, determins if balances with the object code should be added to the bucket
027         * for this category or not
028         * 
029         * @param oc the object code of a balance
030         * @return true if object code indicates that the balance should be added to this category, false if not
031         */
032        public boolean containsObjectCode(ObjectCode oc);
033    
034        /**
035         * Returns the code of the organization reversion category this logic is associated with
036         * 
037         * @return the category code of this organization reversion category
038         */
039        public String getCode();
040    
041        /**
042         * Returns the name of the organization reversion category this logic is associated with?
043         * 
044         * @return the name of this organization reversion category
045         */
046        public String getName();
047    
048        /**
049         * Does this category represent an expense?
050         * 
051         * @return true if it represents an expense, false if not
052         */
053        public boolean isExpense();
054    }