org.activiti.engine.impl.ProcessDefinitionQueryImpl 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.impl;
import org.activiti.api.runtime.shared.identity.UserGroupManager;
import org.activiti.engine.ActivitiException;
import org.activiti.engine.ActivitiIllegalArgumentException;
import org.activiti.engine.impl.context.Context;
import org.activiti.engine.impl.interceptor.CommandContext;
import org.activiti.engine.impl.interceptor.CommandExecutor;
import org.activiti.engine.impl.persistence.entity.SuspensionState;
import org.activiti.engine.repository.ProcessDefinition;
import org.activiti.engine.repository.ProcessDefinitionQuery;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import java.util.List;
import java.util.Set;
public class ProcessDefinitionQueryImpl extends AbstractQuery implements ProcessDefinitionQuery {
private static final long serialVersionUID = 1L;
private static final Logger log = LoggerFactory.getLogger(ProcessDefinitionQueryImpl.class);
private String id;
private Set ids;
private String category;
private String categoryLike;
private String categoryNotEquals;
private String name;
private String nameLike;
private String deploymentId;
private Set deploymentIds;
private String key;
private String keyLike;
private Set keys;
private String resourceName;
private String resourceNameLike;
private Integer version;
private Integer versionGt;
private Integer versionGte;
private Integer versionLt;
private Integer versionLte;
private boolean latest;
private SuspensionState suspensionState;
private String authorizationUserId;
private String procDefId;
private String tenantId;
private String tenantIdLike;
private boolean withoutTenantId;
private String eventSubscriptionName;
private String eventSubscriptionType;
public ProcessDefinitionQueryImpl() {
}
public ProcessDefinitionQueryImpl(CommandContext commandContext) {
super(commandContext);
}
public ProcessDefinitionQueryImpl(CommandExecutor commandExecutor) {
super(commandExecutor);
}
public ProcessDefinitionQueryImpl processDefinitionId(String processDefinitionId) {
this.id = processDefinitionId;
return this;
}
@Override
public ProcessDefinitionQuery processDefinitionIds(Set processDefinitionIds) {
this.ids = processDefinitionIds;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionCategory(String category) {
if (category == null) {
throw new ActivitiIllegalArgumentException("category is null");
}
this.category = category;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionCategoryLike(String categoryLike) {
if (categoryLike == null) {
throw new ActivitiIllegalArgumentException("categoryLike is null");
}
this.categoryLike = categoryLike;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionCategoryNotEquals(String categoryNotEquals) {
if (categoryNotEquals == null) {
throw new ActivitiIllegalArgumentException("categoryNotEquals is null");
}
this.categoryNotEquals = categoryNotEquals;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionName(String name) {
if (name == null) {
throw new ActivitiIllegalArgumentException("name is null");
}
this.name = name;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionNameLike(String nameLike) {
if (nameLike == null) {
throw new ActivitiIllegalArgumentException("nameLike is null");
}
this.nameLike = nameLike;
return this;
}
public ProcessDefinitionQueryImpl deploymentId(String deploymentId) {
if (deploymentId == null) {
throw new ActivitiIllegalArgumentException("id is null");
}
this.deploymentId = deploymentId;
return this;
}
public ProcessDefinitionQueryImpl deploymentIds(Set deploymentIds) {
if (deploymentIds == null) {
throw new ActivitiIllegalArgumentException("ids are null");
}
this.deploymentIds = deploymentIds;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionKey(String key) {
if (key == null) {
throw new ActivitiIllegalArgumentException("key is null");
}
this.key = key;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionKeys(Set keys) {
if (keys == null) {
throw new ActivitiIllegalArgumentException("keys is null");
}
this.keys = keys;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionKeyLike(String keyLike) {
if (keyLike == null) {
throw new ActivitiIllegalArgumentException("keyLike is null");
}
this.keyLike = keyLike;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionResourceName(String resourceName) {
if (resourceName == null) {
throw new ActivitiIllegalArgumentException("resourceName is null");
}
this.resourceName = resourceName;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionResourceNameLike(String resourceNameLike) {
if (resourceNameLike == null) {
throw new ActivitiIllegalArgumentException("resourceNameLike is null");
}
this.resourceNameLike = resourceNameLike;
return this;
}
public ProcessDefinitionQueryImpl processDefinitionVersion(Integer version) {
checkVersion(version);
this.version = version;
return this;
}
public ProcessDefinitionQuery processDefinitionVersionGreaterThan(Integer processDefinitionVersion) {
checkVersion(processDefinitionVersion);
this.versionGt = processDefinitionVersion;
return this;
}
public ProcessDefinitionQuery processDefinitionVersionGreaterThanOrEquals(Integer processDefinitionVersion) {
checkVersion(processDefinitionVersion);
this.versionGte = processDefinitionVersion;
return this;
}
public ProcessDefinitionQuery processDefinitionVersionLowerThan(Integer processDefinitionVersion) {
checkVersion(processDefinitionVersion);
this.versionLt = processDefinitionVersion;
return this;
}
public ProcessDefinitionQuery processDefinitionVersionLowerThanOrEquals(Integer processDefinitionVersion) {
checkVersion(processDefinitionVersion);
this.versionLte = processDefinitionVersion;
return this;
}
protected void checkVersion(Integer version) {
if (version == null) {
throw new ActivitiIllegalArgumentException("version is null");
} else if (version <= 0) {
throw new ActivitiIllegalArgumentException("version must be positive");
}
}
public ProcessDefinitionQueryImpl latestVersion() {
this.latest = true;
return this;
}
public ProcessDefinitionQuery active() {
this.suspensionState = SuspensionState.ACTIVE;
return this;
}
public ProcessDefinitionQuery suspended() {
this.suspensionState = SuspensionState.SUSPENDED;
return this;
}
public ProcessDefinitionQuery processDefinitionTenantId(String tenantId) {
if (tenantId == null) {
throw new ActivitiIllegalArgumentException("processDefinition tenantId is null");
}
this.tenantId = tenantId;
return this;
}
public ProcessDefinitionQuery processDefinitionTenantIdLike(String tenantIdLike) {
if (tenantIdLike == null) {
throw new ActivitiIllegalArgumentException("process definition tenantId is null");
}
this.tenantIdLike = tenantIdLike;
return this;
}
public ProcessDefinitionQuery processDefinitionWithoutTenantId() {
this.withoutTenantId = true;
return this;
}
public ProcessDefinitionQuery messageEventSubscription(String messageName) {
return eventSubscription("message",
messageName);
}
public ProcessDefinitionQuery messageEventSubscriptionName(String messageName) {
return eventSubscription("message",
messageName);
}
public ProcessDefinitionQuery processDefinitionStarter(String procDefId) {
this.procDefId = procDefId;
return this;
}
public ProcessDefinitionQuery eventSubscription(String eventType,
String eventName) {
if (eventName == null) {
throw new ActivitiIllegalArgumentException("event name is null");
}
if (eventType == null) {
throw new ActivitiException("event type is null");
}
this.eventSubscriptionType = eventType;
this.eventSubscriptionName = eventName;
return this;
}
public List getAuthorizationGroups() {
// Similar behaviour as the TaskQuery.taskCandidateUser() which
// includes the groups the candidate
// user is part of
if (authorizationUserId != null) {
UserGroupManager userGroupManager = Context.getProcessEngineConfiguration().getUserGroupManager();
if (userGroupManager != null) {
return userGroupManager.getUserGroups(authorizationUserId);
} else {
log.warn("No UserGroupManager set on ProcessEngineConfiguration. Tasks queried only where user is directly related, not through groups.");
}
}
return null;
}
// sorting ////////////////////////////////////////////
public ProcessDefinitionQuery orderByDeploymentId() {
return orderBy(ProcessDefinitionQueryProperty.DEPLOYMENT_ID);
}
public ProcessDefinitionQuery orderByProcessDefinitionKey() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_KEY);
}
public ProcessDefinitionQuery orderByProcessDefinitionCategory() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_CATEGORY);
}
public ProcessDefinitionQuery orderByProcessDefinitionId() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_ID);
}
public ProcessDefinitionQuery orderByProcessDefinitionVersion() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_VERSION);
}
public ProcessDefinitionQuery orderByProcessDefinitionName() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_NAME);
}
public ProcessDefinitionQuery orderByTenantId() {
return orderBy(ProcessDefinitionQueryProperty.PROCESS_DEFINITION_TENANT_ID);
}
// results ////////////////////////////////////////////
public long executeCount(CommandContext commandContext) {
checkQueryOk();
return commandContext.getProcessDefinitionEntityManager().findProcessDefinitionCountByQueryCriteria(this);
}
public List executeList(CommandContext commandContext,
Page page) {
checkQueryOk();
return commandContext.getProcessDefinitionEntityManager().findProcessDefinitionsByQueryCriteria(this,
page);
}
public void checkQueryOk() {
super.checkQueryOk();
}
// getters ////////////////////////////////////////////
public String getDeploymentId() {
return deploymentId;
}
public Set getDeploymentIds() {
return deploymentIds;
}
public String getId() {
return id;
}
public Set getIds() {
return ids;
}
public String getName() {
return name;
}
public String getNameLike() {
return nameLike;
}
public String getKey() {
return key;
}
public String getKeyLike() {
return keyLike;
}
public Set getKeys() { return keys; }
public Integer getVersion() {
return version;
}
public Integer getVersionGt() {
return versionGt;
}
public Integer getVersionGte() {
return versionGte;
}
public Integer getVersionLt() {
return versionLt;
}
public Integer getVersionLte() {
return versionLte;
}
public boolean isLatest() {
return latest;
}
public String getCategory() {
return category;
}
public String getCategoryLike() {
return categoryLike;
}
public String getResourceName() {
return resourceName;
}
public String getResourceNameLike() {
return resourceNameLike;
}
public SuspensionState getSuspensionState() {
return suspensionState;
}
public void setSuspensionState(SuspensionState suspensionState) {
this.suspensionState = suspensionState;
}
public String getCategoryNotEquals() {
return categoryNotEquals;
}
public String getTenantId() {
return tenantId;
}
public String getTenantIdLike() {
return tenantIdLike;
}
public boolean isWithoutTenantId() {
return withoutTenantId;
}
public String getAuthorizationUserId() {
return authorizationUserId;
}
public String getProcDefId() {
return procDefId;
}
public String getEventSubscriptionName() {
return eventSubscriptionName;
}
public String getEventSubscriptionType() {
return eventSubscriptionType;
}
public ProcessDefinitionQueryImpl startableByUser(String userId) {
if (userId == null) {
throw new ActivitiIllegalArgumentException("userId is null");
}
this.authorizationUserId = userId;
return this;
}
}