org.activiti.engine.repository.ModelQuery Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of activiti-engine Show documentation
The newest version!
/* 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.repository;

import org.activiti.engine.api.internal.Internal;
import org.activiti.engine.query.Query;

/**
 * Allows programmatic querying of {@link Model}s.
 *
 */
@Internal
public interface ModelQuery extends Query {

  /** Only select model with the given id. */
  ModelQuery modelId(String modelId);

  /** Only select models with the given category. */
  ModelQuery modelCategory(String modelCategory);

  /**
   * Only select models where the category matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%
   */
  ModelQuery modelCategoryLike(String modelCategoryLike);

  /** Only select models that have a different category then the given one. */
  ModelQuery modelCategoryNotEquals(String categoryNotEquals);

  /** Only select models with the given name. */
  ModelQuery modelName(String modelName);

  /**
   * Only select models where the name matches the given parameter. The syntax that should be used is the same as in SQL, eg. %activiti%
   */
  ModelQuery modelNameLike(String modelNameLike);

  /** Only selects models with the given key. */
  ModelQuery modelKey(String key);

  /** Only select model with a certain version. */
  ModelQuery modelVersion(Integer modelVersion);

  /**
   * Only select models which has the highest version.
   * 
   * Note: if modelKey(key) is not used in this query, all the models with the highest version for each key will be returned (similar to process definitions)
   */
  ModelQuery latestVersion();

  /** Only select models that are the source for the provided deployment */
  ModelQuery deploymentId(String deploymentId);

  /** Only select models that are deployed (ie deploymentId != null) */
  ModelQuery deployed();

  /** Only select models that are not yet deployed */
  ModelQuery notDeployed();

  /**
   * Only select models that have the given tenant id.
   */
  ModelQuery modelTenantId(String tenantId);

  /**
   * Only select models with a tenant id like the given one.
   */
  ModelQuery modelTenantIdLike(String tenantIdLike);

  /**
   * Only select models that do not have a tenant id.
   */
  ModelQuery modelWithoutTenantId();

  // ordering ////////////////////////////////////////////////////////////

  /**
   * Order by the category of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByModelCategory();

  /**
   * Order by the id of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByModelId();

  /**
   * Order by the key of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByModelKey();

  /**
   * Order by the version of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByModelVersion();

  /**
   * Order by the name of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByModelName();

  /**
   * Order by the creation time of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByCreateTime();

  /**
   * Order by the last update time of the models (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByLastUpdateTime();

  /**
   * Order by tenant id (needs to be followed by {@link #asc()} or {@link #desc()}).
   */
  ModelQuery orderByTenantId();

}