1 /**
2 * Copyright 2005-2012 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.peopleflow;
17
18 import org.kuali.rice.core.api.membership.MemberType;
19 import org.kuali.rice.kew.api.action.ActionRequestPolicy;
20
21 import java.util.List;
22
23 /**
24 * Interface contract for PeopleFlowDefinition members.
25 *
26 * @author Kuali Rice Team (rice.collab@kuali.org)
27 */
28 public interface PeopleFlowMemberContract {
29
30 /**
31 * @return the id of the member. This will key in to different types depending on the {@link MemberType} of the
32 * instance.
33 */
34 String getMemberId();
35
36 /**
37 * @return the {@link MemberType} of this member. Never null.
38 */
39 MemberType getMemberType();
40
41 /**
42 * Returns the action request policy to use for this people flow member. This value is only applicable in the
43 * case where the {@code MemberType} is {@code ROLE}. If the member type is anything else, this value will not
44 * be considered and should ideally be set to null
45 *
46 * @return the action request policy to use for this people flow member if it is a role member, null if this
47 * member has no request policy
48 */
49 ActionRequestPolicy getActionRequestPolicy();
50
51 /**
52 * @return the priority of the member. This is equivalent to the sequential stop in the PeopleFlowDefinition, which means
53 * lower integer value equates to higher priority. The minimum priority is 1.
54 */
55 int getPriority();
56
57 /**
58 * Returns the responsibility id of this member. This is a unique id which KEW can use to help identify and track
59 * the responsibility represented by this people flow member. It will be associated with any action requests that
60 * are generated from this people flow membership.
61 *
62 * @return the responsibility id for this people flow membership
63 */
64 String getResponsibilityId();
65
66 /**
67 * @return the list of delegates for this member. Should never be null but may be an empty list in the case where
68 * this member has no delegates
69 */
70 List<? extends PeopleFlowDelegateContract> getDelegates();
71
72 }