View Javadoc
1   /**
2    * Copyright 2005-2014 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.krad.dao;
17  
18  import java.util.List;
19  
20  import org.kuali.rice.krad.maintenance.MaintenanceLock;
21  import org.kuali.rice.krad.util.LegacyDataFramework;
22  
23  /**
24   * This interface defines basic methods that MaintenanceDocument Dao's must provide
25   * @deprecated use new KRAD Data framework {@link org.kuali.rice.krad.data.DataObjectService}
26   */
27  @Deprecated
28  @LegacyDataFramework
29  public interface MaintenanceDocumentDao {
30      /**
31       * 
32       * This method looks for a document that is locking the given lockingRepresentation. If one is found, then it
33       * retrieves the documentNumber, and returns it.
34       * 
35       * @param lockingRepresentation - locking representation to check for
36       * @param documentNumber - document number to ignore, optional argument
37       * @return returns an empty string if no locking document is found, otherwise returns the documentNumber of the locking document
38       * 
39       */
40      public String getLockingDocumentNumber(String lockingRepresentation, String documentNumber);
41  
42  }