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.bc.identity;
017    
018    import org.kuali.kfs.module.bc.document.BudgetConstructionDocument;
019    import org.kuali.rice.kim.bo.Person;
020    import org.kuali.rice.kns.util.MessageMap;
021    
022    /**
023     * Interface for role types services that can set no access messages for budget construction.
024     */
025    public interface BudgetConstructionNoAccessMessageSetting {
026    
027        /**
028         * Assumes the given user does not have view access for the given document and adds a message to given MessageList to indicate
029         * why the user does not.
030         * 
031         * @param document Budget document that access was requested for
032         * @param user Person who requested access
033         * @param messageMap MessageMap for adding message to
034         */
035        public void setNoAccessMessage(BudgetConstructionDocument document, Person user, MessageMap messageMap);
036    }