org.camunda.bpm.client.topic.TopicSubscription Maven / Gradle / Ivy
/*
* Copyright Camunda Services GmbH and/or licensed to Camunda Services GmbH
* under one or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information regarding copyright
* ownership. Camunda licenses this file to you under the Apache License,
* Version 2.0; 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.camunda.bpm.client.topic;
import org.camunda.bpm.client.task.ExternalTaskHandler;
import java.util.List;
import java.util.Map;
/**
* Subscription to a topic
*
* @author Tassilo Weidner
*/
public interface TopicSubscription {
/**
* The client has been unsubscribed from the topic.
* NB! It can happen, that the changes are not applied immediately, in case the client is currently iterating over the bunch of fetched and locked external tasks.
* The changes will have affect starting from the next bunch only.
*/
void close();
/**
* @return the topic name of the subscription
*/
String getTopicName();
/**
* @return
* - the duration of the lock applied to the topic
*
- if {@code null}, the client or the default lock duration is applied
*
*/
Long getLockDuration();
/**
* @return the external task handler of the topic
*/
ExternalTaskHandler getExternalTaskHandler();
/**
* @return a list of variable names which are supposed to be retrieved
*/
List getVariableNames();
/**
* @return whether or not variables from greater scopes than the external task
* are fetched. false means all variables visible in the
* scope of the external task will be fetched, true means
* only local variables (to the scope of the external task) will be
* fetched.
*/
boolean isLocalVariables();
/**
* @return the business key associated with the external tasks which are supposed to be fetched and locked
*/
String getBusinessKey();
/**
* @return the process definition id associated with the external tasks which are supposed to be fetched and locked
*/
String getProcessDefinitionId();
/**
* @return the process definition ids associated with the external tasks which are supposed to be fetched and locked
*/
List getProcessDefinitionIdIn();
/**
* @return the process definition key associated with the external tasks which are supposed to be fetched and locked
*/
String getProcessDefinitionKey();
/**
* @return the process definition keys associated with the external tasks which are supposed to be fetched and locked
*/
List getProcessDefinitionKeyIn();
/**
* @return the process definition version tag associated with the external task which are supposed to be fetched and locked
*/
String getProcessDefinitionVersionTag();
/**
* @return the process variables associated with the external task which are supposed to be fetched and locked
*/
Map getProcessVariables();
/**
* @return the tenant id presence for the external tasks which are supposed to be fetched and locked
*/
boolean isWithoutTenantId();
/**
* @return the tenant ids associated with the external tasks which are supposed to be fetched and locked
*/
List getTenantIdIn();
/**
* @return whether or not custom extension properties defined in the external
* task activity are included. The default is false,
* which means that no extension properties will be available within
* the external-task-client. true means that all defined
* extension properties are fetched and provided.
*/
boolean isIncludeExtensionProperties();
}