001/**
002 * Copyright 2005-2018 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.maintenance;
017
018import java.io.Serializable;
019import java.util.List;
020import java.util.Map;
021
022/**
023 * Provides contract for the data object of the bulk update maintenance document.
024 *
025 * @author Kuali Rice Team (rice.collab@kuali.org)
026 */
027public interface BulkUpdateMaintenanceDataObject extends Serializable {
028
029    /**
030     * Returns the list of fields of the maintenance documents to be updated along with the new value.
031     *
032     * @return map where the key is the maintenance document field to be updated and the value is the new value of the
033     *         field
034     */
035    Map<String, ?> getUpdateFieldValues();
036
037    /**
038     * Returns the list of data objects of the maintenance documents that are to be updated.
039     *
040     * @return list of data objects to be updated
041     */
042    List<?> getTargetUpdateDataObjects();
043}