package org.sigmah.shared.dto.base.mapping;
/*
* #%L
* Sigmah
* %%
* Copyright (C) 2010 - 2016 URD
* %%
* This program 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/gpl-3.0.html>.
* #L%
*/
/**
* Defines a custom mapping for DTO.
*
* @author Tom Miette (tmiette@ideia.fr)
*/
public interface IsMappingMode {
/**
* Gets the unique mapping mode id.
*
* @return The id.
*/
String getMapId();
/**
* Gets the mapping properties of the custom fields for the current mapping mode.
*
* @return The custom fields.
* @see CustomMappingField
*/
CustomMappingField[] getCustomFields();
/**
* Gets the mapping properties of the fields excluded for the current mapping mode.
*
* @return The excluded fields.
* @see MappingField
*/
MappingField[] getExcludedFields();
}