com.day.cq.workflow.exec.filter.WorkItemFilter Maven / Gradle / Ivy

/*
 * Copyright 1997-2008 Day Management AG
 * Barfuesserplatz 6, 4001 Basel, Switzerland
 * All Rights Reserved.
 *
 * This software is the confidential and proprietary information of
 * Day Management AG, ("Confidential Information"). You shall not
 * disclose such Confidential Information and shall use it only in
 * accordance with the terms of the license agreement you entered into
 * with Day.
 */
package com.day.cq.workflow.exec.filter;

import com.day.cq.workflow.exec.WorkItem;

/**
 * The WorkItemFilter interface allows filter implementations
 * that can be used to filter specific {@link WorkItem}s
 */
public interface WorkItemFilter {
    /**
     * This method returns true if the given {@link WorkItem}
     * matches the filter criteria.
     *
     * @param workItem {@link WorkItem} to check
     *
     * @return true if the given {@link WorkItem}
     * matches the filter criteria.
     */
    boolean doInclude(WorkItem workItem);
}