Image getAlbumImage();
/**
- * Sets the ID of the album image.
- *
- * @param id
- * The ID of the album image
- * @return This album
- */
- Album setAlbumImage(String id);
-
- /**
* Returns whether this album contains any other albums or images.
*
* @return {@code true} if this album is empty, {@code false} otherwise
String getTitle();
/**
- * Sets the title of this album.
+ * Returns the description of this album.
*
- * @param title
- * The title of this album
- * @return This album
+ * @return The description of this album
*/
- Album setTitle(String title);
+ String getDescription();
/**
- * Returns the description of this album.
+ * Returns a modifier for this album.
*
- * @return The description of this album
+ * @return A modifier for this album
+ * @throws IllegalStateException
+ * if this album can not be modified
*/
- String getDescription();
+ Modifier modify() throws IllegalStateException;
/**
- * Sets the description of this album.
+ * Allows modifying an album. Modifications are only performed once {@link
+ * #update()} has succesfully returned a new album with the modifications
+ * made.
*
- * @param description
- * The description of this album
- * @return This album
+ * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
*/
- Album setDescription(String description);
+ interface Modifier {
+
+ Modifier setTitle(String title);
+
+ Modifier setDescription(String description);
+
+ Modifier setAlbumImage(String imageId);
+
+ Album update() throws IllegalStateException;
+
+ }
}