Part 1 of initial load

TIS.GSP.Business.Interfaces/IAlbum.cs

@@ -0,0 +1,212 @@
+using System;
+using GalleryServerPro.Business.Metadata;
+
+namespace GalleryServerPro.Business.Interfaces
+{
+	/// <summary>
+	/// Represents an album in Gallery Server Pro. An album may contain any object that implements <see cref="IGalleryObject" />.
+	/// </summary>
+	public interface IAlbum : IGalleryObject
+	{
+		/// <summary>
+		/// Gets or sets the starting date for this album.
+		/// </summary>
+		/// <value>The starting date for this album.</value>
+		DateTime DateStart
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the ending date for this album.
+		/// </summary>
+		/// <value>The ending date for this album.</value>
+		DateTime DateEnd
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the name of the directory where the album is stored. Example: summervacation.
+		/// </summary>
+		/// <value>The directory where the album is stored. Example: summervacation..</value>
+		string DirectoryName
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the user name of this gallery object's owner. This property and OwnerRoleName
+		/// are closely related and both should be populated or both be empty.
+		/// </summary>
+		/// <value>The user name of this gallery object's owner.</value>
+		string OwnerUserName
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets the owners the current album inherits from parent albums. Guaranteed to not return null.
+		/// Will be empty when there aren't any inherited owners.
+		/// </summary>
+		/// <value>A collection of strings.</value>
+		string[] InheritedOwners
+		{
+			get;
+		}
+
+		/// <summary>
+		/// Gets or sets the name of the role associated with this gallery object's owner. This property and 
+		/// OwnerUserName are closely related and both should be populated or both be empty.
+		/// </summary>
+		/// <value>The name of the role associated with this gallery object's owner.</value>
+		string OwnerRoleName
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets a value indicating whether this album is the top level album in the gallery.
+		/// </summary>
+		/// <value>
+		/// 	<c>true</c> if this instance is a root album; otherwise, <c>false</c>.
+		/// </value>
+		bool IsRootAlbum
+		{
+			get;
+		}
+
+		/// <summary>
+		/// Gets or sets a value indicating whether this album is a virtual album used only as a container for objects that are
+		/// spread across multiple albums. A virtual album does not map to a physical folder and cannot be saved to the
+		/// data store. Virtual albums are used as containers for search results and to contain the top level albums
+		/// that a user has authorization to view.
+		/// </summary>
+		/// <value>
+		/// 	<c>true</c> if this instance is a virtual album; otherwise, <c>false</c>.
+		/// </value>
+		bool IsVirtualAlbum
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the type of the virtual album for this instance. Applies only when <see cref="IsVirtualAlbum" /> is <c>true</c>.
+		/// </summary>
+		/// <value>The type of the virtual album.</value>
+		VirtualAlbumType VirtualAlbumType { get; set; }
+
+		/// <summary>
+		/// Gets or sets a value indicating whether metadata is to be loaded from the data store when an object is inflated. Setting
+		/// this to false when metadata is not needed can improve performance, especially when large numbers of objects are being
+		/// loading, such as during maintenance and synchronizations. The default value is <c>true</c>. When <c>false</c>, metadata
+		/// is not extracted from the database and the <see cref="IGalleryObject.MetadataItems" /> collection is empty. As objects are lazily loaded,
+		/// this value is inherited from its parent object.
+		/// </summary>
+		/// <value>
+		/// 	<c>true</c> to allow metadata to be retrieved from the data store; otherwise, <c>false</c>.
+		/// </value>
+		bool AllowMetadataLoading
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the media object ID whose thumbnail image should be used as the thumbnail image to represent this album.
+		/// </summary>
+		/// <value>The thumbnail media object id.</value>
+		int ThumbnailMediaObjectId
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets the metadata property to sort the album by.
+		/// </summary>
+		/// <value>The metadata property to sort the album by.</value>
+		MetadataItemName SortByMetaName
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets a value indicating whether the contents of the album are sorted in ascending order. A <c>false</c> value indicates
+		/// a descending sort.
+		/// </summary>
+		/// <value><c>true</c> if an album's contents are sorted in ascending order; <c>false</c> if descending order.</value>
+		bool SortAscending
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Gets or sets a value indicating whether the child albums have been added, and for media objects, whether they have been
+		/// added and inflated for this album. Note that it is possible for child albums to have been added to this album but not
+		/// inflated, while the child media objects have been added but not inflated. This is because the
+		/// <see cref="Inflate" /> method adds both child albums and media objects, but inflates only the media
+		/// objects.
+		/// </summary>
+		/// <value><c>true</c> if this album is inflated; otherwise, <c>false</c>.</value>
+		bool AreChildrenInflated
+		{
+			get;
+			set;
+		}
+
+		/// <summary>
+		/// Sorts the gallery objects in this album by the <see cref="SortByMetaName" /> field in the order specified by
+		/// <see cref="SortAscending" />, optionally persisting the changes to the database, activing recursively and - when
+		/// acting recursively, optionally replacing the sort field and direction on child albums with the values from the 
+		/// current album. This method updates the <see cref="IGalleryObject.Sequence" /> property of each gallery object.
+		/// </summary>
+		/// <param name="persistToDataStore">if set to <c>true</c> persist the album and the new sequence of each child
+		/// gallery object to the database.</param>
+		/// <param name="userName">Name of the user. This is for auditing and used only when <paramref name="persistToDataStore" />
+		/// is <c>true</c>; otherwise you may specify null.</param>
+		/// <param name="isRecursive">If set to <c>true</c> act recursively on child albums. Defaults to <c>false</c>
+		/// when not specified. This value is ignored when <paramref name="persistToDataStore" /> is <c>false</c>.</param>
+		/// <param name="replaceChildSortFields">When <c>true</c>, replace the sort field and direction on child albums with 
+		/// the values from the current album. This value is applied only when <paramref name="persistToDataStore" /> and
+		/// <paramref name="isRecursive" /> are both <c>true</c>.</param>
+		/// <exception cref="System.ArgumentException">Thrown when <paramref name="persistToDataStore" /> is <c>true</c>
+		/// and <paramref name="userName" /> is null or empty.</exception>
+		void Sort(bool persistToDataStore, string userName, bool isRecursive = false, bool replaceChildSortFields = false);
+
+		/// <summary>
+		/// Sorts the gallery objects in this album by the <see cref="SortByMetaName" /> field in the order specified by
+		/// <see cref="SortAscending" />, optionally persisting the changes to the database, activing recursively and - when
+		/// acting recursively, optionally replacing the sort field and direction on child albums with the values from the 
+		/// current album. This method updates the <see cref="IGalleryObject.Sequence" /> property of each gallery object. 
+		/// It runs asynchronously and returns immediately.
+		/// </summary>
+		/// <param name="persistToDataStore">if set to <c>true</c> persist the album and the new sequence of each child
+		/// gallery object to the database.</param>
+		/// <param name="userName">Name of the user. This is for auditing and used only when <paramref name="persistToDataStore" />
+		/// is <c>true</c>; otherwise you may specify null.</param>
+		/// <param name="isRecursive">If set to <c>true</c> act recursively on child albums. Defaults to <c>false</c>
+		/// when not specified. This value is ignored when <paramref name="persistToDataStore" /> is <c>false</c>.</param>
+		/// <param name="replaceChildSortFields">When <c>true</c>, replace the sort field and direction on child albums with 
+		/// the values from the current album. This value is applied only when <paramref name="persistToDataStore" /> and
+		/// <paramref name="isRecursive" /> are both <c>true</c>.</param>
+		/// <exception cref="System.ArgumentException">Thrown when <paramref name="persistToDataStore" /> is <c>true</c>
+		/// and <paramref name="userName" /> is null or empty.</exception>
+		void SortAsync(bool persistToDataStore, string userName, bool isRecursive = false, bool replaceChildSortFields = false);
+
+		/// <summary>
+		/// Inflate the current object by loading all properties from the data store. If the object is already inflated (GalleryObject.IsInflated=true), no action is taken.
+		/// </summary>
+		/// <param name="inflateChildMediaObjects">When true, the child media objects are added and inflated. Note that child albums are added
+		/// but not inflated.</param>
+		void Inflate(bool inflateChildMediaObjects);
+	}
+}

TIS.GSP.Business.Interfaces/IAlbumProfile.cs

@@ -0,0 +1,35 @@
+using GalleryServerPro.Business.Metadata;
+
+namespace GalleryServerPro.Business.Interfaces
+{
+	/// <summary>
+	/// Defines an object that contains user preferences for an album.
+	/// </summary>
+	public interface IAlbumProfile
+	{
+		/// <summary>
+		/// Gets or sets the album ID.
+		/// </summary>
+		/// <value>An integer.</value>
+		int AlbumId { get; set; }
+
+		/// <summary>
+		/// Gets or sets the metadata name to sort the album by.
+		/// </summary>
+		/// <value>An instance of <see cref="MetadataItemName" />.</value>
+		MetadataItemName SortByMetaName { get; set; }
+
+		/// <summary>
+		/// Indicates the direction the album is to be sorted. A value of <c>true</c> indicates ascending 
+		/// order; a value of <c>false</c> indicates descending order.
+		/// </summary>
+		/// <value><c>true</c> if ascending order; otherwise, <c>false</c>.</value>
+		bool SortAscending { get; set; }
+
+		/// <summary>
+		/// Perform a deep copy of this item.
+		/// </summary>
+		/// <returns>Returns a deep copy of this item.</returns>
+		IAlbumProfile Copy();
+	}
+}

TIS.GSP.Business.Interfaces/IAlbumProfileCollection.cs

@@ -0,0 +1,45 @@
+using System;
+
+namespace GalleryServerPro.Business.Interfaces
+{
+	/// <summary>
+	/// A collection of <see cref="IAlbumProfile" /> objects.
+	/// </summary>
+	public interface IAlbumProfileCollection : System.Collections.Generic.ICollection<IAlbumProfile>
+	{
+		/// <summary>
+		/// Adds the specified <paramref name="item" />.
+		/// </summary>
+		/// <param name="item">The item to add.</param>
+		/// <exception cref="System.ArgumentNullException">Thrown when <paramref name="item" /> is null.</exception>
+		new void Add(IAlbumProfile item);
+
+		/// <summary>
+		/// Adds the <paramref name="items" /> to the current collection.
+		/// </summary>
+		/// <param name="items">The items to add to the current collection.</param>
+		/// <exception cref="ArgumentNullException">Thrown when <paramref name="items" /> is null.</exception>
+		void AddRange(System.Collections.Generic.IEnumerable<IAlbumProfile> items);
+
+		/// <summary>
+		/// Find the album profile in the collection that matches the specified <paramref name="albumId" />. If no matching object is found,
+		/// null is returned.
+		/// </summary>
+		/// <param name="albumId">The ID for the album to find.</param>
+		/// <returns>Returns an <see cref="IAlbumProfile" />object from the collection that matches the specified <paramref name="albumId" />,
+		/// or null if no matching object is found.</returns>
+		IAlbumProfile Find(int albumId);
+
+		/// <summary>
+		/// Generates as string representation of the items in the collection.
+		/// </summary>
+		/// <returns>Returns a string representation of the items in the collection.</returns>
+		string Serialize();
+
+		/// <summary>
+		/// Perform a deep copy of this collection.
+		/// </summary>
+		/// <returns>Returns a deep copy of this collection.</returns>
+		IAlbumProfileCollection Copy();
+	}
+}