Merged in deprecatedGueltigkeitszeitraum-XPLANBOX-2302 (pull request #119)

Deprecated Gueltigkeitszeitraum XPLANBOX-2302

Approved-by: stenger
Approved-by: Torsten Friebe

xplan-api/xplan-api-manager/src/main/java/de/latlon/xplanbox/api/manager/handler/EditGueltigkeitHandler.java

@@ -32,6 +32,7 @@ import java.util.Collections;
 /**
  * Handles editing of Zeitraum.
  *
+ * @deprecated will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz </a>
  */
 @Component

xplan-api/xplan-api-manager/src/main/java/de/latlon/xplanbox/api/manager/v1/PlanGueltigkeitApi.java

@@ -41,6 +41,7 @@ import javax.ws.rs.Produces;
 /**
  * Controller class for handling access to the gueltigkeit resource of a plan.
  *
+ * @deprecated will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz </a>
  * @since 4.4
  */
@@ -59,11 +60,9 @@ public class PlanGueltigkeitApi {
 					@ApiResponse(responseCode = "400",
 							description = "Unsupported plan version or planID is not a valid int value"),
 					@ApiResponse(responseCode = "404", description = "Invalid planID, plan not found"),
-					@ApiResponse(responseCode = "406", description = "Requested format is not available"), })
-	public Zeitraum getGueltigkeit(
-			@PathParam("planId") @Parameter(description = "ID of the plan gueltigkeit to be returned",
-					example = "123") String planId)
-			throws Exception {
+					@ApiResponse(responseCode = "406", description = "Requested format is not available"), },
+			description = "deprecated: Gueltigkeitszeitraum will be removed in a future version.", deprecated = true)
+	public Zeitraum getGueltigkeit(@PathParam("planId") @Parameter(example = "123") String planId) throws Exception {
 		return editGueltigkeitHandler.retrieveGueltigkeit(planId);
 	}
 
@@ -80,7 +79,8 @@ public class PlanGueltigkeitApi {
 					@ApiResponse(responseCode = "406", description = "Requested format is not available"),
 					@ApiResponse(responseCode = "422", description = "Request body contains invalid content") },
 			requestBody = @RequestBody(content = {
-					@Content(mediaType = "application/json", schema = @Schema(implementation = Zeitraum.class)) }))
+					@Content(mediaType = "application/json", schema = @Schema(implementation = Zeitraum.class)) }),
+			description = "deprecated: Gueltigkeitszeitraum will be removed in a future version.", deprecated = true)
 	public Zeitraum replaceGueltigkeit(@PathParam("planId") @Parameter(description = "ID of the plan to be returned",
 			example = "123") String planId, @Valid Zeitraum zeitraum) throws Exception {
 		return editGueltigkeitHandler.replaceGueltigkeit(planId, zeitraum);

xplan-api/xplan-api-manager/src/main/java/de/latlon/xplanbox/api/manager/v1/model/Zeitraum.java

@@ -33,6 +33,7 @@ import java.util.Objects;
 /**
  * Datatype for Zeitraum.
  *
+ * @deprecated will be removed in a future version.
  * @since 4.4
  */
 @XmlRootElement

xplan-configuration/xplan-manager-config/src/main/resources/managerWebConfiguration.properties

@@ -23,7 +23,7 @@
 activateInternalIdDialog=${isInternalIdDialogActivated}
 # enables the legislative status dialog
 activateLegislationStatusDialog=${isLegislationStatusDialogActivated}
-# enables the validity period dialog
+# enables the validity period dialog (deprecated)
 activateValidityPeriodDialog=${isValidityPeriodDialogActivated}
 # activates the editor function
 activateEditor=${isEditorActivated}

xplan-core/xplan-commons/src/main/java/de/latlon/xplan/commons/feature/FeatureCollectionManipulator.java

@@ -52,8 +52,14 @@ public class FeatureCollectionManipulator {
 
 	private static final String XPLAN_MGR_PLAN_ID_PROP_NAME = "xplanMgrPlanId";
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	private static final String START_DATE_TIME_PROP_NAME = "gueltigkeitBeginn";
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	private static final String END_DATE_TIME_PROP_NAME = "gueltigkeitEnde";
 
 	/**
@@ -142,6 +148,9 @@ public class FeatureCollectionManipulator {
 			addDateProperty(feature, featureType, WMS_SORT_DATE_PROP_NAME, releaseDate);
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	private void addStartAndEndDateTimeProperty(Date beginValidity, Date endValidity, Feature feature,
 			FeatureType featureType) {
 		if (beginValidity != null)

xplan-core/xplan-commons/src/main/java/de/latlon/xplan/manager/web/shared/edit/ValidityPeriod.java

@@ -26,6 +26,7 @@ import java.util.Date;
 /**
  * Encapsulates the validity period of a plan.
  *
+ * @deprecated will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz</a>
  * @version $Revision: $, $Date: $
  */

xplan-core/xplan-commons/src/main/java/de/latlon/xplan/manager/web/shared/edit/XPlanToEdit.java

@@ -72,6 +72,7 @@ public class XPlanToEdit {
 	}
 
 	/**
+	 * @deprecated will be removed in a future version.
 	 * @return the validityPeriod, never <code>null</code>
 	 */
 	public ValidityPeriod getValidityPeriod() {
@@ -81,6 +82,7 @@ public class XPlanToEdit {
 	}
 
 	/**
+	 * @deprecated will be removed in a future version.
 	 * @param validityPeriod the validityPeriod to set, may be <code>null</code>
 	 */
 	public void setValidityPeriod(ValidityPeriod validityPeriod) {

xplan-core/xplan-core-manager-db/src/main/java/de/latlon/xplan/core/manager/db/model/Plan.java

@@ -310,27 +310,45 @@ public class Plan {
 		return this;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public Date getGueltigkeitbeginn() {
 		return gueltigkeitbeginn;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public void setGueltigkeitbeginn(Date gueltigkeitbeginn) {
 		this.gueltigkeitbeginn = gueltigkeitbeginn;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public Plan gueltigkeitbeginn(Date gueltigkeitbeginn) {
 		this.gueltigkeitbeginn = gueltigkeitbeginn;
 		return this;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public Date getGueltigkeitende() {
 		return gueltigkeitende;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public void setGueltigkeitende(Date gueltigkeitende) {
 		this.gueltigkeitende = gueltigkeitende;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	public Plan gueltigkeitende(Date gueltigkeitende) {
 		this.gueltigkeitende = gueltigkeitende;
 		return this;

xplan-core/xplan-manager-core/src/main/java/de/latlon/xplan/manager/edit/XPlanToEditFactory.java

@@ -122,6 +122,9 @@ public class XPlanToEditFactory {
 		return xPlanToEdit;
 	}
 
+	/**
+	 * @deprecated will be removed in a future version.
+	 */
 	private void setValidityPeriod(AdditionalPlanData additionalPlanData, XPlanToEdit xPlanToEdit) {
 		if (additionalPlanData != null) {
 			additionalPlanData.getStartDateTime();

xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanManager_Web.adoc

@@ -120,6 +120,8 @@ unbeabsichtigt zu einer Zustandsänderung des Plans kommen kann!
 Entsprechung im XPlanGML. Die Angabe des Zeitraums, wie sie beim Import
 erfolgt ist, wird beim Ändern des Zeitraums überschrieben.
 
+IMPORTANT: Die Möglichkeit einen Gültigkeitszeitraum anzugeben ist veraltet, das Editieren des Gültigkeitszeitraum wird in zukünftigen Versionen der xPlanBox entfernt.
+
 *Änderungen*
 
 bis XPlanGML 5.4:

xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/XPlanWMS.adoc

@@ -226,6 +226,8 @@ Wird der XPlanWMSInAufstellung innerhalb des gewählten Zeitraums angefragt, so
 
 NOTE: Ausnahme: Die Sichtbarkeit der Layer, die den Geltungsbereich darstellen, werden nicht über den Gültigkeitszeitraum verändert und werden immer angezeigt.
 
+IMPORTANT: Die Möglichkeit einen Gültigkeitszeitraum anzugeben ist veraltet und wird in zukünftigen Versionen der xPlanBox entfernt.
+
 [[xplanwms-getfeatureinfo]]
 ==== GetFeatureInfo
 

xplan-documentation/xplan-benutzerhandbuch/src/main/asciidoc/bekannteProbleme.adoc

@@ -34,7 +34,7 @@ ein FPlan mit Rasterdaten.
 
 === XPlanWMS - Darstellung von Plänen mit Gültigkeitszeitraum
 
-Wenn beim Import eines Plans über den XPlanManager ein Gültigkeitszeitraum angegeben wird, werden derzeit keine Vektordaten bei GetMap-Anfragen an den XPlanWMS angezeigt. Dies gilt für alle XPlanWMS unabhängig vom Planststatus.
+Wenn beim Import eines Plans über den XPlanManager ein Gültigkeitszeitraum angegeben wird, werden derzeit keine Vektordaten bei GetMap-Anfragen an den XPlanWMS angezeigt. Dies gilt für alle XPlanWMS unabhängig vom Planstatus.
 
 === XPlanManagerWeb - Anzeige der Pläne auf der letzten Seite
 

xplan-documentation/xplan-betriebshandbuch/src/main/asciidoc/konfiguration/manager/gueltigkeitszeitraum.adoc

@@ -28,4 +28,6 @@ Dazu ist folgender Abschnitt in der Datei _<DEEGREE_WORKSPACE_ROOT>/xplansyn-wms
   <wms:CategoryLayerIdentifier>SO_Planraster</wms:CategoryLayerIdentifier>
   <wms:CategoryLayerIdentifier>soplanraster_sortiert</wms:CategoryLayerIdentifier>
 </wms:VisibilityInspector>
-----
\ No newline at end of file
+----
+
+IMPORTANT: Die Möglichkeit einen Gültigkeitszeitraum für einen Plan anzugeben ist veraltet, die dazugehörigen Konfigurationsmöglichkeiten werden in zukünftigen Versionen der xPlanBox entfernt.
\ No newline at end of file

xplan-webapps/xplan-manager-web/src/main/java/de/latlon/xplan/manager/web/client/gui/dialog/ValidityPeriodDialog.java

@@ -20,22 +20,21 @@
  */
 package de.latlon.xplan.manager.web.client.gui.dialog;
 
-import java.util.Date;
-
 import com.google.gwt.core.client.GWT;
 import com.google.gwt.user.client.ui.Label;
 import com.google.gwt.user.client.ui.Panel;
 import com.google.gwt.user.client.ui.VerticalPanel;
-
 import de.latlon.xplan.manager.web.client.gui.widget.Validable;
 import de.latlon.xplan.manager.web.client.gui.widget.ValidityPeriodInput;
 import de.latlon.xplan.manager.web.client.i18n.XPlanWebMessages;
 
+import java.util.Date;
+
 /**
  * Dialog to set the validity period of a plan.
  *
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz</a>
- * @version $Revision: $, $Date: $
+ * @deprecated class will be removed in a future version.
  */
 public class ValidityPeriodDialog extends WizardDialogBox implements Validable {
 

xplan-webapps/xplan-manager-web/src/main/java/de/latlon/xplan/manager/web/client/gui/editor/validityPeriod/ValidityPeriodPanel.java

@@ -20,23 +20,23 @@
  */
 package de.latlon.xplan.manager.web.client.gui.editor.validityPeriod;
 
-import static com.google.gwt.user.client.ui.HasHorizontalAlignment.ALIGN_CENTER;
-
-import java.util.Date;
-
 import com.google.gwt.core.client.GWT;
 import com.google.gwt.user.client.ui.CaptionPanel;
 import com.google.gwt.user.client.ui.VerticalPanel;
 import com.google.gwt.user.client.ui.Widget;
-
 import de.latlon.xplan.manager.web.client.gui.widget.Validable;
 import de.latlon.xplan.manager.web.client.gui.widget.ValidityPeriodInput;
 import de.latlon.xplan.manager.web.client.i18n.XPlanWebMessages;
 import de.latlon.xplan.manager.web.shared.edit.ValidityPeriod;
 
+import java.util.Date;
+
+import static com.google.gwt.user.client.ui.HasHorizontalAlignment.ALIGN_CENTER;
+
 /**
  * CaptionPanel with editor for the validity period section.
  *
+ * @deprecated will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz</a>
  */
 public class ValidityPeriodPanel extends CaptionPanel implements Validable {

xplan-webapps/xplan-manager-web/src/main/java/de/latlon/xplan/manager/web/shared/ManagerWebConfiguration.java

@@ -109,6 +109,7 @@ public class ManagerWebConfiguration implements Serializable {
 	/**
 	 * @return <code>true</code> if the dialog to select the validity period of a plan
 	 * should be activated, <code>false</code> otherwise
+	 * @deprecated method will be removed in a future version.
 	 */
 	public boolean isValidityPeriodActivated() {
 		return validityPeriodActivated;

xplan-webapps/xplan-manager-web/src/main/resources/de/latlon/xplan/manager/web/server/configuration/managerWebConfiguration.properties

@@ -23,7 +23,7 @@
 activateInternalIdDialog=false
 # enables the legislative status dialog
 activateLegislationStatusDialog=true
-# enables the validity period dialog
+# enables the validity period dialog (deprecated)
 activateValidityPeriodDialog=true
 # activates the editor function
 activateEditor=true

xplan-webservices/xplan-wms/src/main/java/de/latlon/xplan/wms/visibility/ArchiveValidityPeriodInspector.java

@@ -23,6 +23,7 @@ package de.latlon.xplan.wms.visibility;
 /**
  * A {@link ValidityPeriodInspector} for schema 'xplansynarchive'
  *
+ * @deprecated The VisibilityInspector will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz </a>
  */
 public class ArchiveValidityPeriodInspector extends ValidityPeriodInspector {

xplan-webservices/xplan-wms/src/main/java/de/latlon/xplan/wms/visibility/DefaultValidityPeriodInspector.java

@@ -23,6 +23,7 @@ package de.latlon.xplan.wms.visibility;
 /**
  * A {@link ValidityPeriodInspector} for schema 'xplansyn'
  *
+ * @deprecated The VisibilityInspector will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz </a>
  */
 public class DefaultValidityPeriodInspector extends ValidityPeriodInspector {

xplan-webservices/xplan-wms/src/main/java/de/latlon/xplan/wms/visibility/PreValidityPeriodInspector.java

@@ -23,6 +23,7 @@ package de.latlon.xplan.wms.visibility;
 /**
  * A {@link ValidityPeriodInspector} for schema 'xplansynpre'
  *
+ * @deprecated The VisibilityInspector will be removed in a future version.
  * @author <a href="mailto:goltz@lat-lon.de">Lyn Goltz </a>
  */
 public class PreValidityPeriodInspector extends ValidityPeriodInspector {