View Javadoc

1   /**
2    * Copyright 2005-2015 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.rule;
17  
18  import org.kuali.rice.core.api.uif.RemotableAttributeError;
19  import org.kuali.rice.kew.rule.bo.RuleBaseValuesLookupableImpl;
20  import org.kuali.rice.kns.web.ui.Row;
21  
22  import java.util.List;
23  import java.util.Map;
24  
25  /**
26   * An interface which can be implemented by a {@link WorkflowRuleAttribute} implementation which allows
27   * a different List of {@link Row} objects to be returned for rendering on the rule lookup screen.
28   * 
29   * @see RuleBaseValuesLookupableImpl
30   *
31   * @author Kuali Rice Team (rice.collab@kuali.org)
32   */
33  public interface WorkflowRuleSearchAttribute extends WorkflowRuleAttribute{
34  
35      /**
36       * If your attribute is an OddSearchAttribute this method will be used to get search rows instead of the
37       * usually called get RuleRows.  Generally this is used for Attributes that want to expose drop downs
38       * for Rule Entry but need special wild card fields for searches that wouldn't work for rule entry.
39       */
40      List<Row> getSearchRows();
41      
42      /** 
43       * validate search data and populate attribute with search data
44       * @param paramMap
45       * @return
46       */
47      List<RemotableAttributeError> validateSearchData(Map<String, String> paramMap);
48      
49  }