View Javadoc
1   /**
2    * Copyright 2005-2014 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.delegation.DelegationType;
19  import org.kuali.rice.core.api.membership.MemberType;
20  import org.kuali.rice.kew.api.action.ActionRequestPolicy;
21  
22  public interface PeopleFlowDelegateContract {
23  
24      String getMemberId();
25  
26      MemberType getMemberType();
27  
28      /**
29       * Returns the action request policy to use for this people flow member.  This value is only applicable in the
30       * case where the {@code MemberType} is {@code ROLE}.  If the member type is anything else, this value will not
31       * be considered and should ideally be set to null
32       *
33       * @return the action request policy to use for this people flow member if it is a role member, null if this
34       * member has no request policy
35       */
36      ActionRequestPolicy getActionRequestPolicy();
37  
38      DelegationType getDelegationType();
39  
40      /**
41       * Returns the responsibility id of this people flow delegate member.  This is a unique id which KEW can use to help
42       * identify and track the responsibility represented by this delegation.  It will be associated with any action
43       * requests that are generated from this people flow delegation.
44       *
45       * @return the responsibility id for this people flow membership delegate
46       */
47      String getResponsibilityId();
48  
49  }