org.camunda.bpm.engine.identity.GroupQuery 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.engine.identity;
import org.camunda.bpm.engine.query.Query;
/**
* Allows to programmatically query for {@link Group}s.
*
* @author Joram Barrez
*/
public interface GroupQuery extends Query {
/** Only select {@link Group}s with the given id. */
GroupQuery groupId(String groupId);
/** Only select {@link Group}s with the given ids */
GroupQuery groupIdIn(String... ids);
/** Only select {@link Group}s with the given name. */
GroupQuery groupName(String groupName);
/** Only select {@link Group}s where the name matches the given parameter.
* The syntax to use is that of SQL, eg. %activiti%. */
GroupQuery groupNameLike(String groupNameLike);
/** Only select {@link Group}s which have the given type. */
GroupQuery groupType(String groupType);
/** Only selects {@link Group}s where the given user is a member of. */
GroupQuery groupMember(String groupMemberUserId);
/** Only select {@link Group}S that are potential starter for the given process definition. */
GroupQuery potentialStarter(String procDefId);
/** Only select {@link Group}s that belongs to the given tenant. */
GroupQuery memberOfTenant(String tenantId);
//sorting ////////////////////////////////////////////////////////
/** Order by group id (needs to be followed by {@link #asc()} or {@link #desc()}). */
GroupQuery orderByGroupId();
/** Order by group name (needs to be followed by {@link #asc()} or {@link #desc()}). */
GroupQuery orderByGroupName();
/** Order by group type (needs to be followed by {@link #asc()} or {@link #desc()}). */
GroupQuery orderByGroupType();
}