001/**
002 * Copyright 2005-2018 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 */
016package org.kuali.rice.kew.api.peopleflow;
017
018import org.kuali.rice.core.api.delegation.DelegationType;
019import org.kuali.rice.core.api.membership.MemberType;
020import org.kuali.rice.kew.api.action.ActionRequestPolicy;
021
022public interface PeopleFlowDelegateContract {
023
024    String getMemberId();
025
026    MemberType getMemberType();
027
028    /**
029     * Returns the action request policy to use for this people flow member.  This value is only applicable in the
030     * case where the {@code MemberType} is {@code ROLE}.  If the member type is anything else, this value will not
031     * be considered and should ideally be set to null
032     *
033     * @return the action request policy to use for this people flow member if it is a role member, null if this
034     * member has no request policy
035     */
036    ActionRequestPolicy getActionRequestPolicy();
037
038    DelegationType getDelegationType();
039
040    /**
041     * Returns the responsibility id of this people flow delegate member.  This is a unique id which KEW can use to help
042     * identify and track the responsibility represented by this delegation.  It will be associated with any action
043     * requests that are generated from this people flow delegation.
044     *
045     * @return the responsibility id for this people flow membership delegate
046     */
047    String getResponsibilityId();
048
049}