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.actiontaken.dao;
17  
18  import org.kuali.rice.kew.actiontaken.ActionTakenValue;
19  import org.kuali.rice.kew.api.action.ActionType;
20  
21  import java.sql.Timestamp;
22  
23  
24  /**
25   * Data Access Object for {@link ActionTakenValue}s.
26   *
27   * @author Kuali Rice Team (rice.collab@kuali.org)
28   */
29  public interface ActionTakenDao {
30  
31      /**
32       * Returns the Timestamp of the last action of the given type taken against the document.
33       *
34       * <p>Both {@code documentId} and {@code actionType} must be supplied to this query. Otherwise an
35       * {@code IllegalArgumentException} will be thrown.</p>
36       *
37       * @param documentId the id of the document to check
38       * @param actionType the type of the action to look for
39       *
40       * @return the Timestamp of the last action of the given type taken against the document, or null if the document
41       * has no actions
42       *
43       * @throws IllegalArgumentException if documentId is null or blank, or if actionType is null
44       */
45      Timestamp getLastActionTakenDate(String documentId, ActionType actionType);
46  
47  }