View Javadoc

1   /**
2    * Copyright 2005-2013 The Kuali Foundation
3    *
4    * Licensed under the Educational Community License, Version 2.0 (the "License");
5    * you may not use this file except in compliance with the License.
6    * You may obtain a copy of the License at
7    *
8    * http://www.opensource.org/licenses/ecl2.php
9    *
10   * Unless required by applicable law or agreed to in writing, software
11   * distributed under the License is distributed on an "AS IS" BASIS,
12   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13   * See the License for the specific language governing permissions and
14   * limitations under the License.
15   */
16  package org.kuali.rice.kew.api.document.search;
17  
18  import javax.xml.bind.annotation.XmlEnum;
19  import javax.xml.bind.annotation.XmlRootElement;
20  import javax.xml.bind.annotation.XmlType;
21  
22  /**
23   * Defines flags that can be used during document search to indicate what relation the route node name being searched on
24   * should have to the current route node of the documents being searched.
25   *
26   * @author Kuali Rice Team (rice.collab@kuali.org)
27   */
28  @XmlRootElement(name = "routeNodeLookupLogic")
29  @XmlType(name = "RouteNodeLookupLogicType")
30  @XmlEnum
31  public enum RouteNodeLookupLogic {
32  
33      /**
34       * Indicates that the document should be exactly at the specified route node in it's route path.
35       */
36      EXACTLY,
37  
38      /**
39       * Indicates that the document should currently be somewhere before the specified route node in it's route path.
40       */
41      BEFORE,
42  
43      /**
44       * Indicates that the document should currently be somewhere after the specified route node in it's route path.
45       */
46      AFTER
47  
48  }