1 /**
2 * Copyright 2005-2013 The Kuali Foundation
3 *
4 * Licensed under the Educational Community License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.opensource.org/licenses/ecl2.php
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16 package org.kuali.rice.kew.api.rule;
17
18
19 /**
20 * This is an interface to define a Role Name for a role assigned to a RoleAttribute.
21 *
22 * @author Kuali Rice Team (rice.collab@kuali.org)
23 */
24 public interface RoleNameContract {
25 /**
26 * This is the composite name value for the Role on an attribute. It consists of
27 * of the roleAttribute's class name + '!' + roleBaseName
28 *
29 * @return name
30 */
31 String getName();
32
33 /**
34 * This is the base name value for the Role on an attribute. It consists of
35 * of the name of the Role
36 *
37 * @return baseName
38 */
39 String getBaseName();
40
41 /**
42 * This is the return URL for the given Role for a role attribute
43 *
44 * @return returnUrl
45 */
46 String getReturnUrl();
47
48 /**
49 * A label for the Role on an attribute.
50 *
51 * @return label
52 */
53 String getLabel();
54 }