Coverage Report

Coverage Report - org.kuali.rice.kim.api.responsibility.ResponsibilityActionContract

Classes in this File

 /*
  * Copyright 2008 The Kuali Foundation
  *
  * Licensed under the Educational Community License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
  *
  * http://www.opensource.org/licenses/ecl2.php
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
 package org.kuali.rice.kim.api.responsibility;
 
 import org.kuali.rice.core.api.mo.common.Attributes;
 import org.kuali.rice.kim.api.common.delegate.DelegateContract;
 
 import java.util.List;
 
 /**
  * Contains information related to responsibilities in the kim system.
  */
 public interface ResponsibilityActionContract {
 
     /**
      * The principalId the responsibility action is associated with.
      * <p>
      * Can be null as long as the {@link #getGroupId()} is not null.
      * </p>
      * <p>
      * When this is set the {@link #getGroupId()} will not be.
      * </p>
      * @return the principalId
      */
     String getPrincipalId();
 
     /**
      * The groupId the responsibility action is associated with.
      *
      * <p>
      * Can be null as long as the {@link #getPrincipalId()} is not null.
      * </p>
      * <p>
      * When this is set the {@link #getPrincipalId()} will not be.
      * </p>
      *
      * @return the groupId
      */
         String getGroupId();
 
     /**
      * The roleResponsibilityActionId the responsibility action is associated with.  Can be null.
      *
      * @return the roleResponsibilityActionId
      */
         String getRoleResponsibilityActionId();
 
     /**
      * The parallelRoutingGroupingCode the responsibility action is associated with.  Can be null.
      *
      * @return the parallelRoutingGroupingCode
      */
     String getParallelRoutingGroupingCode();
 
     /**
      * The actionTypeCode the responsibility action is associated with.  Can be null.
      *
      * @return the actionTypeCode
      */
     String getActionTypeCode();
 
     /**
      * The actionPolicyCode the responsibility action is associated with.  Can be null.
      *
      * @return the actionPolicyCode
      */
         String getActionPolicyCode();
 
     /**
      * The priorityNumber the responsibility action is associated with.  Can be null.
      *
      * @return the priorityNumber
      */
     Integer getPriorityNumber();
 
     /**
      * The memberRoleId the responsibility action is associated with.  Cannot be null or blank.
      *
      * @return the memberRoleId
      */
         String getMemberRoleId();
 
     /**
      * The responsibilityName the responsibility action is associated with.  Cannot be null or blank.
      *
      * @return the responsibilityName
      */
         String getResponsibilityName();
 
     /**
      * The responsibilityId the responsibility action is associated with.  Cannot be null or blank.
      *
      * @return the responsibilityId
      */
     String getResponsibilityId();
 
     /**
      * The responsibilityNamespaceCode the responsibility action is associated with.  Cannot be null or blank.
      *
      * @return the responsibilityNamespaceCode
      */
     String getResponsibilityNamespaceCode();
 
     /**
      * Whether is responsibility action is a force action.
      * @return true if is a force action
      */
         boolean isForceAction();
 
     /**
      * The qualifying attributes for the responsibility action.  Cannot be null.
      * @return attributes
      */
         Attributes getQualifier();
 
     /**
      * The delegates for this responsibility action. Cannot be null but can be an empty list.
      * @return delegates
      */
         List<? extends DelegateContract> getDelegates();
 
     /**
      * The roleId the responsibility action is associated with.  Cannot be null or blank.
      *
      * @return the roleId
      */
     String getRoleId();
 }

1		/*
2		* Copyright 2008 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.kim.api.responsibility;
17
18		import org.kuali.rice.core.api.mo.common.Attributes;
19		import org.kuali.rice.kim.api.common.delegate.DelegateContract;
20
21		import java.util.List;
22
23		/**
24		* Contains information related to responsibilities in the kim system.
25		*/
26		public interface ResponsibilityActionContract {
27
28		/**
29		* The principalId the responsibility action is associated with.
30		* <p>
31		* Can be null as long as the {@link #getGroupId()} is not null.
32		* </p>
33		* <p>
34		* When this is set the {@link #getGroupId()} will not be.
35		* </p>
36		* @return the principalId
37		*/
38		String getPrincipalId();
39
40		/**
41		* The groupId the responsibility action is associated with.
42		*
43		* <p>
44		* Can be null as long as the {@link #getPrincipalId()} is not null.
45		* </p>
46		* <p>
47		* When this is set the {@link #getPrincipalId()} will not be.
48		* </p>
49		*
50		* @return the groupId
51		*/
52		String getGroupId();
53
54		/**
55		* The roleResponsibilityActionId the responsibility action is associated with. Can be null.
56		*
57		* @return the roleResponsibilityActionId
58		*/
59		String getRoleResponsibilityActionId();
60
61		/**
62		* The parallelRoutingGroupingCode the responsibility action is associated with. Can be null.
63		*
64		* @return the parallelRoutingGroupingCode
65		*/
66		String getParallelRoutingGroupingCode();
67
68		/**
69		* The actionTypeCode the responsibility action is associated with. Can be null.
70		*
71		* @return the actionTypeCode
72		*/
73		String getActionTypeCode();
74
75		/**
76		* The actionPolicyCode the responsibility action is associated with. Can be null.
77		*
78		* @return the actionPolicyCode
79		*/
80		String getActionPolicyCode();
81
82		/**
83		* The priorityNumber the responsibility action is associated with. Can be null.
84		*
85		* @return the priorityNumber
86		*/
87		Integer getPriorityNumber();
88
89		/**
90		* The memberRoleId the responsibility action is associated with. Cannot be null or blank.
91		*
92		* @return the memberRoleId
93		*/
94		String getMemberRoleId();
95
96		/**
97		* The responsibilityName the responsibility action is associated with. Cannot be null or blank.
98		*
99		* @return the responsibilityName
100		*/
101		String getResponsibilityName();
102
103		/**
104		* The responsibilityId the responsibility action is associated with. Cannot be null or blank.
105		*
106		* @return the responsibilityId
107		*/
108		String getResponsibilityId();
109
110		/**
111		* The responsibilityNamespaceCode the responsibility action is associated with. Cannot be null or blank.
112		*
113		* @return the responsibilityNamespaceCode
114		*/
115		String getResponsibilityNamespaceCode();
116
117		/**
118		* Whether is responsibility action is a force action.
119		* @return true if is a force action
120		*/
121		boolean isForceAction();
122
123		/**
124		* The qualifying attributes for the responsibility action. Cannot be null.
125		* @return attributes
126		*/
127		Attributes getQualifier();
128
129		/**
130		* The delegates for this responsibility action. Cannot be null but can be an empty list.
131		* @return delegates
132		*/
133		List<? extends DelegateContract> getDelegates();
134
135		/**
136		* The roleId the responsibility action is associated with. Cannot be null or blank.
137		*
138		* @return the roleId
139		*/
140		String getRoleId();
141		}