org.activiti.engine.task.IdentityLink Maven / Gradle / Ivy
/* Licensed under the Apache 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.apache.org/licenses/LICENSE-2.0
*
* 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.activiti.engine.task;
import org.activiti.engine.api.internal.Internal;
/**
* An identity link is used to associate a task with a certain identity.
*
* For example: - a user can be an assignee (= identity link type) for a task - a group can be a candidate-group (= identity link type) for a task
*
*/
@Internal
public interface IdentityLink {
/**
* Returns the type of link. See {@link IdentityLinkType} for the native supported types by Activiti.
*/
String getType();
/**
* If the identity link involves a user, then this will be a non-null id of a user. That userId can be used to query for user information through the {@link UserQuery} API.
*/
String getUserId();
/**
* If the identity link involves a group, then this will be a non-null id of a group. That groupId can be used to query for user information through the {@link GroupQuery} API.
*/
String getGroupId();
/**
* The id of the task associated with this identity link.
*/
String getTaskId();
/**
* The process definition id associated with this identity link.
*/
String getProcessDefinitionId();
/**
* The process instance id associated with this identity link.
*/
String getProcessInstanceId();
}