001    /**
002     * Copyright 2005-2014 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.rice.kew.api.rule;
017    
018    
019    /**
020     * This is an interface to define a Role Name for a role assigned to a RoleAttribute.
021     *
022     * @author Kuali Rice Team (rice.collab@kuali.org)
023     */
024    public interface RoleNameContract {
025        /**
026         * This is the composite name value for the Role on an attribute.  It consists of
027         * of the roleAttribute's class name + '!' + roleBaseName
028         *
029         * @return name
030         */
031        String getName();
032    
033        /**
034         * This is the base name value for the Role on an attribute.  It consists of
035         * of the name of the Role
036         *
037         * @return baseName
038         */
039        String getBaseName();
040    
041        /**
042         * This is the return URL for the given Role for a role attribute
043         *
044         * @return returnUrl
045         */
046        String getReturnUrl();
047    
048        /**
049         * A label for the Role on an attribute.
050         *
051         * @return label
052         */
053        String getLabel();
054    }