Edit trash handler Javadoc

Oeppinger · Oct 25, 2012 · 50dfc68 · 50dfc68
1 parent 627f983
commit 50dfc68
Show file tree

Hide file tree

Showing 11 changed files with 641 additions and 364 deletions.
diff --git a/portal-impl/src/META-INF/javadocs-all.xml b/portal-impl/src/META-INF/javadocs-all.xml
diff --git a/portal-impl/src/META-INF/javadocs-rt.xml b/portal-impl/src/META-INF/javadocs-rt.xml
diff --git a/portal-impl/src/com/liferay/portlet/blogs/trash/BlogsEntryTrashHandler.java b/portal-impl/src/com/liferay/portlet/blogs/trash/BlogsEntryTrashHandler.java
@@ -24,24 +24,14 @@
 import com.liferay.portlet.blogs.service.permission.BlogsEntryPermission;
 
 /**
- * Represents the trash handler for blogs entries entity.
+ * Implements trash handling for the blogs entry entity.
  *
  * @author Zsolt Berentey
  */
 public class BlogsEntryTrashHandler extends BaseTrashHandler {
 
 	public static final String CLASS_NAME = BlogsEntry.class.getName();
 
-	/**
-	 * Deletes all blogs entries with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the blogs entries to be deleted
-	 * @param  checkPermission whether to check permission before deleting each
-	 *         blog entry
-	 * @throws PortalException if any one of the blogs entries could not be
-	 *         found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		throws PortalException, SystemException {
 
@@ -55,11 +45,6 @@ public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		}
 	}
 
-	/**
-	 * Returns the blogs entry entity's class name
-	 *
-	 * @return the blogs entry entity's class name
-	 */
 	public String getClassName() {
 		return CLASS_NAME;
 	}
@@ -72,14 +57,6 @@ public boolean isInTrash(long classPK)
 		return entry.isInTrash();
 	}
 
-	/**
-	 * Restores all blogs entries with the matching primary keys.
-	 *
-	 * @param  classPKs the primary key of the blogs entry to be restored
-	 * @throws PortalException if any one of the blogs entries could not be
-	 *         found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void restoreTrashEntries(long[] classPKs)
 		throws PortalException, SystemException {
 

diff --git a/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFileEntryTrashHandler.java b/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFileEntryTrashHandler.java
@@ -45,7 +45,7 @@
 import javax.portlet.PortletRequest;
 
 /**
- * Represents the trash handler for the file entry entity.
+ * Implements trash handling for the file entry entity.
  *
  * @author Alexander Chow
  * @author Manuel de la Peña
@@ -89,15 +89,6 @@ public void checkDuplicateTrashEntry(
 		}
 	}
 
-	/**
-	 * Deletes all file entries with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the file entries to be deleted
-	 * @param  checkPermission whether to check permission before deleting each
-	 *         file entry
-	 * @throws PortalException if any one of the file entries could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		throws PortalException, SystemException {
 
@@ -111,18 +102,13 @@ public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		}
 	}
 
-	/**
-	 * Returns the file entry entity's class name
-	 *
-	 * @return the file entry entity's class name
-	 */
 	public String getClassName() {
 		return CLASS_NAME;
 	}
 
 	@Override
 	public String getDeleteMessage() {
-		return "found-in-deleted-folder-x";
+		return "found-in-deleted-file-entry-x";
 	}
 
 	@Override
@@ -175,13 +161,6 @@ public boolean isInTrash(long classPK)
 		return false;
 	}
 
-	/**
-	 * Restores all file entries with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the file entries to be deleted
-	 * @throws PortalException if any one of the file entries could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void restoreTrashEntries(long[] classPKs)
 		throws PortalException, SystemException {
 

diff --git a/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFileShortcutTrashHandler.java b/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFileShortcutTrashHandler.java
@@ -32,27 +32,14 @@
 import javax.portlet.PortletRequest;
 
 /**
- * Represents the trash handler for the file shortcut entity.
+ * Implements trash handling for the file shortcut entity.
  *
  * @author Zsolt Berentey
  */
 public class DLFileShortcutTrashHandler extends BaseTrashHandler {
 
-	/**
-	 * The class name of the file shortcut entity.
-	 */
 	public static final String CLASS_NAME = DLFileShortcut.class.getName();
 
-	/**
-	 * Deletes all file shortcuts with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the file shortcuts to be deleted
-	 * @param  checkPermission whether to check permission before deleting each
-	 *         file shortcut
-	 * @throws PortalException if any one of the file shortcuts could not be
-	 *         found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		throws PortalException, SystemException {
 
@@ -66,18 +53,13 @@ public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		}
 	}
 
-	/**
-	 * Returns the file entry entity's class name.
-	 *
-	 * @return the file entry entity's class name
-	 */
 	public String getClassName() {
 		return CLASS_NAME;
 	}
 
 	@Override
 	public String getDeleteMessage() {
-		return "found-in-deleted-folder-x";
+		return "found-in-deleted-file-shortcut-x";
 	}
 
 	@Override
@@ -102,14 +84,6 @@ public String getRestoreMessage(PortletRequest portletRequest, long classPK)
 			portletRequest, fileShortcut.getFolderId());
 	}
 
-	/**
-	 * Returns the trash renderer for the entity with the primary key.
-	 *
-	 * @param  classPK the primary key of the file shortcut
-	 * @return Returns the trash renderer
-	 * @throws PortalException if the file shortcut could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	@Override
 	public TrashRenderer getTrashRenderer(long classPK)
 		throws PortalException, SystemException {
@@ -148,14 +122,6 @@ public boolean isInTrash(long classPK)
 		return false;
 	}
 
-	/**
-	 * Restores all file entries with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the file shortcuts to be deleted
-	 * @throws PortalException if any one of the file shortcuts could not be
-	 *         found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void restoreTrashEntries(long[] classPKs)
 		throws PortalException, SystemException {
 

diff --git a/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFolderTrashHandler.java b/portal-impl/src/com/liferay/portlet/documentlibrary/trash/DLFolderTrashHandler.java
@@ -42,7 +42,7 @@
 import javax.portlet.PortletRequest;
 
 /**
- * Represents the trash handler for the folder entity.
+ * Implements trash handling for the folder entity.
  *
  * @author Alexander Chow
  * @author Zsolt Berentey
@@ -84,15 +84,6 @@ public void checkDuplicateTrashEntry(
 		}
 	}
 
-	/**
-	 * Deletes all folders with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the folders to be deleted
-	 * @param  checkPermission whether to check permission before deleting each
-	 *         folder
-	 * @throws PortalException if any one of the folders could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		throws PortalException, SystemException {
 
@@ -106,11 +97,6 @@ public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		}
 	}
 
-	/**
-	 * Returns the folder entity's class name
-	 *
-	 * @return the folder entity's class name
-	 */
 	public String getClassName() {
 		return CLASS_NAME;
 	}
@@ -140,14 +126,6 @@ public String getRestoreMessage(PortletRequest portletRequest, long classPK)
 			portletRequest, dlFolder.getParentFolderId());
 	}
 
-	/**
-	 * Returns the trash renderer associated to the trash entry.
-	 *
-	 * @param  classPK the primary key of the folder
-	 * @return the trash renderer associated to the folder
-	 * @throws PortalException if the folder could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	@Override
 	public TrashRenderer getTrashRenderer(long classPK)
 		throws PortalException, SystemException {
@@ -184,13 +162,6 @@ public boolean isInTrash(long classPK)
 		return false;
 	}
 
-	/**
-	 * Restores all folders with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the folders to be deleted
-	 * @throws PortalException if any one of the folders could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void restoreTrashEntries(long[] classPKs)
 		throws PortalException, SystemException {
 

diff --git a/portal-impl/src/com/liferay/portlet/messageboards/trash/MBThreadTrashHandler.java b/portal-impl/src/com/liferay/portlet/messageboards/trash/MBThreadTrashHandler.java
@@ -37,7 +37,7 @@
 import javax.portlet.PortletRequest;
 
 /**
- * Represents the trash handler for message boards threads.
+ * Implements trash handling for message boards thread entity.
  *
  * @author Zsolt Berentey
  */

diff --git a/portal-impl/src/com/liferay/portlet/wiki/trash/WikiNodeTrashHandler.java b/portal-impl/src/com/liferay/portlet/wiki/trash/WikiNodeTrashHandler.java
@@ -30,6 +30,8 @@
 import com.liferay.portlet.wiki.service.permission.WikiNodePermission;
 
 /**
+ * Implements trash handling for the wiki node entity.
+ *
  * @author Eudaldo Alonso
  */
 public class WikiNodeTrashHandler extends BaseTrashHandler {
@@ -66,15 +68,6 @@ public void checkDuplicateTrashEntry(
 		}
 	}
 
-	/**
-	 * Deletes all wiki nodes with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the wiki nodes to be deleted
-	 * @param  checkPermission whether to check permission before deleting each
-	 *         folder
-	 * @throws PortalException if any one of the wiki nodes could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		throws PortalException, SystemException {
 
@@ -88,23 +81,10 @@ public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
 		}
 	}
 
-	/**
-	 * Returns the wiki node entity's class name
-	 *
-	 * @return the wiki node entity's class name
-	 */
 	public String getClassName() {
 		return CLASS_NAME;
 	}
 
-	/**
-	 * Returns the trash renderer associated to the trash entry.
-	 *
-	 * @param  classPK the primary key of the wiki node
-	 * @return the trash renderer associated to the wiki node
-	 * @throws PortalException if the wiki node could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	@Override
 	public TrashRenderer getTrashRenderer(long classPK)
 		throws PortalException, SystemException {
@@ -122,13 +102,6 @@ public boolean isInTrash(long classPK)
 		return node.isInTrash();
 	}
 
-	/**
-	 * Restores all wiki nodes with the matching primary keys.
-	 *
-	 * @param  classPKs the primary keys of the wiki nodes to be deleted
-	 * @throws PortalException if any one of the wiki nodes could not be found
-	 * @throws SystemException if a system exception occurred
-	 */
 	public void restoreTrashEntries(long[] classPKs)
 		throws PortalException, SystemException {