org.camunda.bpm.engine.filter.Filter 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.filter;
import java.util.Map;
import org.camunda.bpm.engine.query.Query;
/**
* @author Sebastian Menski
*/
public interface Filter {
/**
* @return the id of the filer
*/
String getId();
/**
* @return the resource type fo the filter
*/
String getResourceType();
/**
* @return the name of the filter
*/
String getName();
/**
* @param name the name of the filter
* @return this filter
*/
Filter setName(String name);
/**
* @return the owner of the filter
*/
String getOwner();
/**
* @param owner the owner of the filter
* @return this filter
*/
Filter setOwner(String owner);
/**
* @return the saved query as query object
*/
> T getQuery();
/**
* @param query the saved query as query object
* @return this filter
*/
> Filter setQuery(T query);
/**
* Extends the query with the additional query. The query of the filter is therefore modified
* and if the filter is saved the query is updated.
*
* @param extendingQuery the query to extend the filter with
* @return a copy of this filter with the extended query
*/
> Filter extend(T extendingQuery);
/**
* @return the properties as map
*/
Map getProperties();
/**
* @param properties the properties to set as map
* @return this filter
*/
Filter setProperties(Map properties);
}