org.geomajas.security.AreaAuthorization Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of geomajas-api Show documentation
Geomajas server: Main - api
There is a newer version: 1.18.5
/*
 * This is part of Geomajas, a GIS framework, http://www.geomajas.org/.
 *
 * Copyright 2008-2015 Geosparc nv, http://www.geosparc.com/, Belgium.
 *
 * The program is available in open source according to the GNU Affero
 * General Public License. All contributions in this program are covered
 * by the Geomajas Contributors License Agreement. For full licensing
 * details, see LICENSE.txt in the project root.
 */

package org.geomajas.security;

import org.geomajas.annotation.Api;
import org.geomajas.annotation.UserImplemented;

import com.vividsolutions.jts.geom.Geometry;

/**
 * Authorizations based on area.
 *
 * @author Joachim Van der Auwera
 * @since 1.6.0
 */
@Api(allMethods = true)
@UserImplemented
public interface AreaAuthorization extends BaseAuthorization {

	/**
	 * Get the visible area for a layer.
	 * 
	 * Note that returning null means that the entire layer is invisible.
	 * 

	 * The return value should be consistent with the isLayerVisible() method. If isLayerVisible() is false,
	 * this method should return null. If isLayerVisible() is true, a Geometry should be returned.
	 * 

	 * Geometry coordinates need to be in layer coordinate space.
	 *
	 * @param layerId layer id for which the visible area should be returned
	 * @return geometry which indicates the visible area or null when nothing is visible
	 */
	Geometry getVisibleArea(String layerId);

	/**
	 * Indicates whether features which only partly fall inside the visible area are still considered visible.
	 *
	 * @param layerId layer id for which the status needs to be checked
	 * @return true when any feature which intersects the visible area is considered visible, false when a feature
	 * 		needs to be inside the visible area to be considered visible.
	 */
	boolean isPartlyVisibleSufficient(String layerId);

	/**
	 * Get the area of the layer where updating features is allowed.
	 * 

	 * Note that returning null means that the entire layer prohibits updates.
	 * 

	 * The return value should be consistent with the isLayerUpdateAuthorized() method. If isLayerUpdateAuthorized() is
	 * false, this method should return null. If isLayerUpdateAuthorized() is true, a Geometry should be returned.
	 * 

	 * The return value should also be consistent with getVisibleArea(). The returned area should be contained in the
	 * visible area.
	 * 

	 * Geometry coordinates need to be in layer coordinate space.
	 *
	 * @param layerId layer id for which the area where updates are allowed should be returned
	 * @return geometry which indicates the updatable area or null when nothing is updatable
	 */
	Geometry getUpdateAuthorizedArea(String layerId);

	/**
	 * Indicates whether features which only partly fall inside the updatable area are still considered updatable.
	 *
	 * @param layerId layer id for which the status needs to be checked
	 * @return true when any feature which intersects the visible area is considered updatable, false when a feature
	 * 		needs to be inside the updatable area to be considered updatable.
	 */
	boolean isPartlyUpdateAuthorizedSufficient(String layerId);

	/**
	 * Get the area of the layer where creating features is allowed.
	 * 

	 * Note that returning null means that the entire layer prohibits creation.
	 * 

	 * The return value should be consistent with the isLayerCreateAuthorized() method. If isLayerCreateAuthorized() is
	 * false, this method should return null. If isLayerCreateAuthorized() is true, a Geometry should be returned.
	 * 

	 * The return value should also be consistent with getVisibleArea(). The returned area should be contained in the
	 * visible area.
	 * 

	 * Geometry coordinates need to be in layer coordinate space.
	 *
	 * @param layerId layer id for which the area where creating features is allowed should be returned
	 * @return geometry which indicates the area where creation is allowed or null when nothing can be created
	 */
	Geometry getCreateAuthorizedArea(String layerId);

	/**
	 * Indicates whether features which only partly fall inside the area where creation is allowed are still allowed
	 * to be created.
	 *
	 * @param layerId layer id for which the status needs to be checked
	 * @return true when any feature which intersects the createAuthorized area is allowed to be created, false when a
	 *      feature needs to be inside the creatable area to be created.
	 */
	boolean isPartlyCreateAuthorizedSufficient(String layerId);

	/**
	 * Get the area of the layer where deleting features is allowed.
	 * 

	 * Note that returning null means that the entire layer prohibits deletion.
	 * 

	 * The return value should be consistent with the isLayerDeleteAuthorized() method. If isLayerDeleteAuthorized() is
	 * false, this method should return null. If isLayerDeleteAuthorized() is true, a Geometry should be returned.
	 * 

	 * The return value should also be consistent with getVisibleArea(). The returned area should be contained in the
	 * visible area.
	 * 
	 * Geometry coordinates need to be in layer coordinate space.
	 *
	 * @param layerId layer id for which the area where creating features is allowed should be returned
	 * @return geometry which indicates the area in which deletion is allowed or null when nothing can be deleted
	 */
	Geometry getDeleteAuthorizedArea(String layerId);

	/**
	 * Indicates whether features which only partly fall inside the deletable area are still considered deletable.
	 *
	 * @param layerId layer id for which the status needs to be checked
	 * @return true when any feature which intersects the deletable area is considered deletable, false when a feature
	 * 		needs to be inside the deletable area to be considered deletable.
	 */
	boolean isPartlyDeleteAuthorizedSufficient(String layerId);
}