From 194d241b027a48a50cc3d8655113bfd3c8d67cd5 Mon Sep 17 00:00:00 2001
From: Morten Christensen <unknown@kiln.example.com>
Date: Fri, 28 Dec 2012 14:15:12 -0100
Subject: [PATCH] Adding Publish and UnPublish EventArgs

---
 src/Umbraco.Core/Events/PublishEventArgs.cs   | 53 +++++++++++++++++++
 src/Umbraco.Core/Events/SaveEventArgs.cs      |  3 +-
 src/Umbraco.Core/Events/UnPublishEventArgs.cs | 53 +++++++++++++++++++
 .../Models/EntityBase/IUmbracoEntity.cs       | 40 ++++++++++++++
 src/Umbraco.Core/Umbraco.Core.csproj          |  3 ++
 5 files changed, 150 insertions(+), 2 deletions(-)
 create mode 100644 src/Umbraco.Core/Events/PublishEventArgs.cs
 create mode 100644 src/Umbraco.Core/Events/UnPublishEventArgs.cs
 create mode 100644 src/Umbraco.Core/Models/EntityBase/IUmbracoEntity.cs

diff --git a/src/Umbraco.Core/Events/PublishEventArgs.cs b/src/Umbraco.Core/Events/PublishEventArgs.cs
new file mode 100644
index 0000000000..98afede375
--- /dev/null
+++ b/src/Umbraco.Core/Events/PublishEventArgs.cs
@@ -0,0 +1,53 @@
+using System.Collections.Generic;
+
+namespace Umbraco.Core.Events
+{
+    public class PublishEventArgs<TEntity> : CancellableObjectEventArgs<IEnumerable<TEntity>>
+    {
+        /// <summary>
+		/// Constructor accepting multiple entities that are used in the publish operation
+		/// </summary>
+		/// <param name="eventObject"></param>
+		/// <param name="canCancel"></param>
+		public PublishEventArgs(IEnumerable<TEntity> eventObject, bool canCancel)
+			: base(eventObject, canCancel)
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting multiple entities that are used in the publish operation
+		/// </summary>
+		/// <param name="eventObject"></param>
+		public PublishEventArgs(IEnumerable<TEntity> eventObject)
+			: base(eventObject)
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting a single entity instance
+		/// </summary>
+		/// <param name="eventObject"></param>
+		public PublishEventArgs(TEntity eventObject)
+			: base(new List<TEntity> { eventObject })
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting a single entity instance
+		/// </summary>
+		/// <param name="eventObject"></param>
+		/// <param name="canCancel"></param>
+        public PublishEventArgs(TEntity eventObject, bool canCancel)
+			: base(new List<TEntity> { eventObject }, canCancel)
+		{
+		}
+
+		/// <summary>
+		/// Returns all entities that were published during the operation
+		/// </summary>
+		public IEnumerable<TEntity> PublishedEntities
+		{
+			get { return EventObject; }
+		}
+    }
+}
\ No newline at end of file
diff --git a/src/Umbraco.Core/Events/SaveEventArgs.cs b/src/Umbraco.Core/Events/SaveEventArgs.cs
index ea1a94e5b3..a81d96ef06 100644
--- a/src/Umbraco.Core/Events/SaveEventArgs.cs
+++ b/src/Umbraco.Core/Events/SaveEventArgs.cs
@@ -1,5 +1,4 @@
 using System.Collections.Generic;
-using Umbraco.Core.Models.EntityBase;
 
 namespace Umbraco.Core.Events
 {
@@ -44,7 +43,7 @@ namespace Umbraco.Core.Events
 		}
 
 		/// <summary>
-		/// Returns all entities that were deleted during the operation
+		/// Returns all entities that were saved during the operation
 		/// </summary>
 		public IEnumerable<TEntity> SavedEntities
 		{
diff --git a/src/Umbraco.Core/Events/UnPublishEventArgs.cs b/src/Umbraco.Core/Events/UnPublishEventArgs.cs
new file mode 100644
index 0000000000..62e0c054d6
--- /dev/null
+++ b/src/Umbraco.Core/Events/UnPublishEventArgs.cs
@@ -0,0 +1,53 @@
+using System.Collections.Generic;
+
+namespace Umbraco.Core.Events
+{
+    public class UnPublishEventArgs<TEntity> : CancellableObjectEventArgs<IEnumerable<TEntity>>
+    {
+         /// <summary>
+		/// Constructor accepting multiple entities that are used in the unpublish operation
+		/// </summary>
+		/// <param name="eventObject"></param>
+		/// <param name="canCancel"></param>
+		public UnPublishEventArgs(IEnumerable<TEntity> eventObject, bool canCancel)
+			: base(eventObject, canCancel)
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting multiple entities that are used in the unpublish operation
+		/// </summary>
+		/// <param name="eventObject"></param>
+		public UnPublishEventArgs(IEnumerable<TEntity> eventObject)
+			: base(eventObject)
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting a single entity instance
+		/// </summary>
+		/// <param name="eventObject"></param>
+		public UnPublishEventArgs(TEntity eventObject)
+			: base(new List<TEntity> { eventObject })
+		{
+		}
+
+		/// <summary>
+		/// Constructor accepting a single entity instance
+		/// </summary>
+		/// <param name="eventObject"></param>
+		/// <param name="canCancel"></param>
+        public UnPublishEventArgs(TEntity eventObject, bool canCancel)
+			: base(new List<TEntity> { eventObject }, canCancel)
+		{
+		}
+
+		/// <summary>
+		/// Returns all entities that were unpublished during the operation
+		/// </summary>
+		public IEnumerable<TEntity> UnPublishedEntities
+		{
+			get { return EventObject; }
+		}
+    }
+}
\ No newline at end of file
diff --git a/src/Umbraco.Core/Models/EntityBase/IUmbracoEntity.cs b/src/Umbraco.Core/Models/EntityBase/IUmbracoEntity.cs
new file mode 100644
index 0000000000..2810c9a4d3
--- /dev/null
+++ b/src/Umbraco.Core/Models/EntityBase/IUmbracoEntity.cs
@@ -0,0 +1,40 @@
+namespace Umbraco.Core.Models.EntityBase
+{
+    internal interface IUmbracoEntity : IEntity
+    {
+        /// <summary>
+        /// Gets or sets the Id of the Parent entity
+        /// </summary>
+        int ParentId { get; set; }
+
+        /// <summary>
+        /// Gets or sets the sort order of the Entity
+        /// </summary>
+        int SortOrder { get; set; }
+
+        /// <summary>
+        /// Gets or sets the level of the Entity
+        /// </summary>
+        int Level { get; set; }
+
+        /// <summary>
+        /// Gets or sets the path to the Entity
+        /// </summary>
+        string Path { get; set; }
+
+        /// <summary>
+        /// Profile of the user who created this Entity
+        /// </summary>
+        int CreatorId { get; set; }
+
+        /// <summary>
+        /// Boolean indicating whether this Entity is Trashed or not.
+        /// If an Entity is Trashed it will be located in the Recyclebin.
+        /// </summary>
+        /// <remarks>
+        /// When content is trashed it should be unpublished.
+        /// Not all entities support being trashed, they'll always return false.
+        /// </remarks>
+        bool Trashed { get; }
+    }
+}
\ No newline at end of file
diff --git a/src/Umbraco.Core/Umbraco.Core.csproj b/src/Umbraco.Core/Umbraco.Core.csproj
index e1b8fbb05c..c09fb93d35 100644
--- a/src/Umbraco.Core/Umbraco.Core.csproj
+++ b/src/Umbraco.Core/Umbraco.Core.csproj
@@ -125,6 +125,7 @@
     <Compile Include="Events\CancellableObjectEventArgs.cs" />
     <Compile Include="Events\DeleteRevisionsEventArgs.cs" />
     <Compile Include="Events\EventExtensions.cs" />
+    <Compile Include="Events\PublishEventArgs.cs" />
     <Compile Include="Events\TypedEventHandler.cs" />
     <Compile Include="Events\PublishingEventArgs.cs" />
     <Compile Include="Events\MoveEventArgs.cs" />
@@ -133,6 +134,7 @@
     <Compile Include="Events\RollbackEventArgs.cs" />
     <Compile Include="Events\SaveEventArgs.cs" />
     <Compile Include="Events\SendToPublishEventArgs.cs" />
+    <Compile Include="Events\UnPublishEventArgs.cs" />
     <Compile Include="MacroPropertyTypeResolver.cs" />
     <Compile Include="Models\ContentBase.cs" />
     <Compile Include="Models\ContentExtensions.cs" />
@@ -153,6 +155,7 @@
     <Compile Include="Models\Css\TrieNode.cs" />
     <Compile Include="Models\DictionaryItem.cs" />
     <Compile Include="Models\DictionaryTranslation.cs" />
+    <Compile Include="Models\EntityBase\IUmbracoEntity.cs" />
     <Compile Include="Models\File.cs" />
     <Compile Include="Models\IDataTypeDefinition.cs" />
     <Compile Include="Models\IDictionaryItem.cs" />