001/*
002 * Copyright 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.coa.service;
017
018import org.kuali.ole.coa.businessobject.OrganizationReversion;
019import org.kuali.ole.coa.businessobject.OrganizationReversionCategory;
020
021/**
022 * Services needed to inactivate organization reversion details when one of their respective parents -
023 * either the organization reversion or the category that they relate to - are inactivated
024 */
025public interface OrganizationReversionDetailTrickleDownInactivationService {
026    /**
027     * Inactivates organization reversion details whose containing organization reversion is being inactivated,
028     * and writes notes on the Organization Reversion maintenance document about it
029     * @param organizationReversion the deactivating organization reversion
030     * @param documentNumber the document id of the organization reversion document causing an inactivation
031     */
032    public abstract void trickleDownInactiveOrganizationReversionDetails(OrganizationReversion organizationReversion, String documentNumber);
033    
034    /**
035     * Inactivates (or "boxes") organization reversion details whose related organization reversion category is being inactivated,
036     * and writes notes on the Organization Reversion Category maintenance document about it
037     * @param organizationReversionCategory the deactivating organization reversion category
038     * @param documentNumber the document id of the organization reversion category document causing an inactivation
039     */
040    public abstract void trickleDownInactiveOrganizationReversionDetails(OrganizationReversionCategory organizationReversionCategory, String documentNumber);
041    
042    /**
043     * Activates organization reversion details whose containing organization reversion is being inactivated,
044     * and writes notes on the Organization Reversion maintenance document about it
045     * @param organizationReversion the deactivating organization reversion
046     * @param documentNumber the document id of the organization reversion document causing an inactivation
047     */
048    public abstract void trickleDownActiveOrganizationReversionDetails(OrganizationReversion organizationReversion, String documentNumber);
049    
050    /**
051     * Activates (or "boxes") organization reversion details whose related organization reversion category is being inactivated,
052     * and writes notes on the Organization Reversion Category maintenance document about it
053     * @param organizationReversionCategory the deactivating organization reversion category
054     * @param documentNumber the document id of the organization reversion category document causing an inactivation
055     */
056    public abstract void trickleDownActiveOrganizationReversionDetails(OrganizationReversionCategory organizationReversionCategory, String documentNumber);
057}