1 /**
2 * Copyright 2005-2011 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.document.MaintenanceLock;
21
22 /**
23 * This interface defines basic methods that MaintenanceDocument Dao's must provide
24 *
25 *
26 */
27 public interface MaintenanceDocumentDao {
28
29 // public Collection getPendingDocumentsForClass(Class dataObjectClass);
30
31 /**
32 *
33 * This method looks for a document that is locking the given lockingRepresentation. If one is found, then it
34 * retrieves the documentNumber, and returns it.
35 *
36 * @param lockingRepresentation - locking representation to check for
37 * @param documentNumber - document number to ignore, optional argument
38 * @return returns an empty string if no locking document is found, otherwise returns the documentNumber of the locking document
39 *
40 */
41 public String getLockingDocumentNumber(String lockingRepresentation, String documentNumber);
42
43 /**
44 * This method deletes the locks for the given document number. It is called when the document is final,
45 * thus it can be unlocked, or when the locks need to be regenerated (thus they get cleared first).
46 *
47 * @param documentNumber - document number whose locks should be deleted
48 */
49 public void deleteLocks(String documentNumber);
50
51 /**
52 * This method stores the given list of maintenance locks. Typically these will all be for the same document.
53 *
54 * @param maintenanceLocks - the list of maintenance locks to be stored
55 */
56 public void storeLocks(List<MaintenanceLock> maintenanceLocks);
57
58 }