Checkpoint checkin of patch code.

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2119 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/admin/patch/Patch.java

@@ -0,0 +1,58 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.admin.patch;
+
+import java.util.List;
+
+import org.alfresco.service.cmr.admin.PatchException;
+
+/**
+ * A patch is an executable class that makes a change to persisted data.
+ * <p>
+ * Auditing information is not maintained by the patch - rather it is solely
+ * responsible for the execution of the processes necessary to apply the patch.
+ * <p>
+ * Patches must not be reappliable.  It is up to the patch management systems
+ * to ensure that patches are <b>never reapplied</b>.
+ * 
+ * @since 1.2
+ * @author Derek Hulley
+ */
+public interface Patch
+{
+    public String getId();
+    
+    public String getDescription();
+    
+    public String getApplyAfterVersion();
+    
+    /**
+     * Get patches that this patch depends on
+     * 
+     * @return Returns a list of patches
+     */
+    public List<Patch> getDependsOn();
+    
+    /**
+     * Applies the patch.  Typically this will be within the bounds of a new
+     * transaction.
+     * 
+     * @return Returns the patch execution report
+     * @throws PatchException if the patch failed to be applied
+     */
+    public String apply() throws PatchException;
+}