001/**
002 * Copyright 2005-2018 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.kew.api.document.search;
017
018import javax.xml.bind.annotation.XmlEnum;
019import javax.xml.bind.annotation.XmlRootElement;
020import javax.xml.bind.annotation.XmlType;
021
022/**
023 * Defines flags that can be used during document search to indicate what relation the route node name being searched on
024 * should have to the current route node of the documents being searched.
025 *
026 * @author Kuali Rice Team (rice.collab@kuali.org)
027 */
028@XmlRootElement(name = "routeNodeLookupLogic")
029@XmlType(name = "RouteNodeLookupLogicType")
030@XmlEnum
031public enum RouteNodeLookupLogic {
032
033    /**
034     * Indicates that the document should be exactly at the specified route node in it's route path.
035     */
036    EXACTLY,
037
038    /**
039     * Indicates that the document should currently be somewhere before the specified route node in it's route path.
040     */
041    BEFORE,
042
043    /**
044     * Indicates that the document should currently be somewhere after the specified route node in it's route path.
045     */
046    AFTER
047
048}