Processable.java example

Explorer
anudc-master
/*******************************************************************************
 * Australian National University Data Commons
 * Copyright (C) 2013  The Australian National University
 * 
 * This file is part of Australian National University Data Commons.
 * 
 * Australian National University Data Commons is free software: you
 * can redistribute it and/or modify it under the terms of the GNU
 * General Public License as published by the Free Software Foundation,
 * either version 3 of the License, or (at your option) any later
 * version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ******************************************************************************/

package au.edu.anu.datacommons.webservice;

import java.util.Map;

import au.edu.anu.datacommons.webservice.bindings.DcRequest;
import au.edu.anu.datacommons.webservice.bindings.FedoraItem;

/**
 * Interface that identifies a class that is able to generate DcRequest objects for submission to the Data Commons Web Service along with their relation to
 * other records.
 */
public interface Processable
{
	/**
	 * Generates a Map of DcRequest objects with the relations of the object created/updated in that request to other records.
	 * 
	 * @return Map<DcRequest, Map<String, FedoraItem>>
	 */
	public Map<DcRequest, Map<String, FedoraItem>> generateDcRequests();
}