001/**
002 * Copyright 2005-2016 The Kuali Foundation
003 *
004 * Licensed under the Educational Community License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 * http://www.opensource.org/licenses/ecl2.php
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016package org.kuali.rice.krad.dao;
017
018import java.util.List;
019
020import org.kuali.rice.krad.maintenance.MaintenanceLock;
021import org.kuali.rice.krad.util.LegacyDataFramework;
022
023/**
024 * This interface defines basic methods that MaintenanceDocument Dao's must provide
025 * @deprecated use new KRAD Data framework {@link org.kuali.rice.krad.data.DataObjectService}
026 */
027@Deprecated
028@LegacyDataFramework
029public interface MaintenanceDocumentDao {
030    /**
031     * 
032     * This method looks for a document that is locking the given lockingRepresentation. If one is found, then it
033     * retrieves the documentNumber, and returns it.
034     * 
035     * @param lockingRepresentation - locking representation to check for
036     * @param documentNumber - document number to ignore, optional argument
037     * @return returns an empty string if no locking document is found, otherwise returns the documentNumber of the locking document
038     * 
039     */
040    public String getLockingDocumentNumber(String lockingRepresentation, String documentNumber);
041
042}