-
-<route>
- <pattern>/{jspPageName}/{id:\d+}</pattern>
- <generated-parameter name="jspPage">{jspPageName}.jsp</generated-parameter>
-</route>
+
+<route>
+ <pattern>/{jspPageName}/{id:\d+}</pattern>
+ <generated-parameter name="jspPage">{jspPageName}.jsp</generated-parameter>
+</route>
]]>
@@ -93434,11 +93434,11 @@ The most common use of implicit parameters is to specify a parameter that is inc
-
-<route>
- <pattern>/profile/view/{id:\d+}</pattern>
- <implicit-parameter name="jspPage">view_profile.jsp</implicit-parameter>
-</route>
+
+<route>
+ <pattern>/profile/view/{id:\d+}</pattern>
+ <implicit-parameter name="jspPage">view_profile.jsp</implicit-parameter>
+</route>
@@ -163191,8 +163191,8 @@ The pattern can be any string containing named fragments in brackets. The follow
-
-Hi {name}! How are you?
+
+Hi {name}! How are you?
@@ -163201,8 +163201,8 @@ This pattern would match the string "Hi Tom! How are you?". The format
-
-Hi {name:[a-z]+}! How are you?
+
+Hi {name:[a-z]+}! How are you?
@@ -163215,8 +163215,8 @@ If a string parser is set to encode fragments using a {@link StringEncoder}, an
-
-/view_page/{%path:.*}
+
+/view_page/{%path:.*}
@@ -163225,8 +163225,8 @@ The format of the path fragment has also been specified to match anything using
-
-/view_page/root/home/mysite/pages/index.htm
+
+/view_page/root/home/mysite/pages/index.htm
@@ -240339,8 +240339,8 @@ The actionIds attribute stores the bitwise IDs of all the actions a
end - start in
end - start in
end - start in
end - start in
end - start in
end - start in
PortletDataHandler differs from JournalContentPortletDat
PortalException
com.liferay.portal.kernel.exception.PortalException
-
- SystemException
- com.liferay.portal.kernel.exception.SystemException
-
PortletDataHandler differs from JournalContentPortletDat
MBThreadTrashHandler
com.liferay.portlet.messageboards.trash.MBThreadTrashHandler
-
deleteTrashAttachments
@@ -586502,9 +586586,6 @@ This is a modification of JSPWiki's core TableOfContents plugin for use within L
java.lang.String
-
- _log
-
_fileNamespace
@@ -592710,6 +592791,7 @@ This is a modification of JSPWiki's core TableOfContents plugin for use within L
WikiNodeTrashHandler
com.liferay.portlet.wiki.trash.WikiNodeTrashHandler
+
checkDuplicateTrashEntry
@@ -592736,55 +592818,39 @@ This is a modification of JSPWiki's core TableOfContents plugin for use within L
deleteTrashEntries
- classPKs
long[]
- checkPermission
boolean
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
getClassName
-
-
getTrashRenderer
- classPK
long
-
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
@@ -592804,21 +592870,17 @@ This is a modification of JSPWiki's core TableOfContents plugin for use within L
restoreTrashEntries
- classPKs
long[]
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
@@ -592870,18 +592932,8 @@ This is a modification of JSPWiki's core TableOfContents plugin for use within L
WikiPageTrashHandler
com.liferay.portlet.wiki.trash.WikiPageTrashHandler
-
checkDuplicateTrashEntry
@@ -592907,16 +592959,13 @@ details.]]>
deleteTrashAttachments
- group
com.liferay.portal.model.Group
- date
java.util.Date
-
PortalException
@@ -592925,39 +592974,29 @@ details.]]>
SystemException
com.liferay.portal.kernel.exception.SystemException
-
deleteTrashEntries
- classPKs
long[]
- checkPermission
boolean
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
getClassName
-
-
getRestoreLink
@@ -592999,24 +593038,17 @@ details.]]>
getTrashRenderer
- classPK
long
-
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
@@ -593036,21 +593068,17 @@ details.]]>
restoreTrashEntries
- classPKs
long[]
-
PortalException
com.liferay.portal.kernel.exception.PortalException
-
SystemException
com.liferay.portal.kernel.exception.SystemException
-
diff --git a/portal-impl/src/META-INF/javadocs-rt.xml b/portal-impl/src/META-INF/javadocs-rt.xml
index 703bb09797d195..d7a3d6628b1f9f 100644
--- a/portal-impl/src/META-INF/javadocs-rt.xml
+++ b/portal-impl/src/META-INF/javadocs-rt.xml
@@ -72,7 +72,7 @@ in it's life cycle in order to support having pages
UserGroup has 1 Group that can have pages in both of the group's LayoutSets
which are later inherited by users assigned to the UserGroup
-]]>GroupLocalServiceImpl addGroup userId long parentGroupId long className java.lang.String classPK long liveGroupId long name java.lang.String description java.lang.String null )]]>end - start in
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
-
primKey will have different me
Never call the update methods of this service directly, always go through the resource block local service. -
]]>end - start in
Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full result set.
-
sourceFileName and the
Due to legacy code, the names of some file entry properties are not intuitive. Each file entry has both a name and title. The name is a unique identifier for a given file and is generally numeric, whereas the title is the actual name specified by the user (such as "Budget.xls").
-
]]>+ * This method is used to check for duplicates when a trash entry is being + * restored or moved out of the Recycle Bin. + *
+ * + * @param trashEntry the trash entry to check + * @param containerModelId the primary key of the destination (e.g. folder) + * @param newName the new name to be assigned to the trash entry + * (optionallynull to forego renaming the trash entry)
+ * @throws PortalException if a duplicate trash entry already existed in the
+ * destination container
+ * @throws SystemException if a system exception occurred
*/
public void checkDuplicateTrashEntry(
TrashEntry trashEntry, long containerModelId, String newName)
@@ -53,8 +66,13 @@ public void checkDuplicateTrashEntry(
}
/**
- * @throws PortalException
- * @throws SystemException
+ * Deletes the group's attachments that were trashed before the given date.
+ *
+ * @param group ID the primary key of the group
+ * @param date the date from which attachments will be deleted
+ * @throws PortalException if any one of the attachment file paths were
+ * invalid
+ * @throws SystemException if a system exception occurred
*/
public void deleteTrashAttachments(Group group, Date date)
throws PortalException, SystemException {
@@ -79,8 +97,13 @@ public void deleteTrashEntry(long classPK, boolean checkPermission)
}
/**
- * @throws PortalException
- * @throws SystemException
+ * Returns the container model with the primary key.
+ *
+ * @param containerModelId the primary key of the container model
+ * @return the container model with the primary key
+ * @throws PortalException if a container model with the primary key could
+ * not be found
+ * @throws SystemException if a system exception occurred
*/
public ContainerModel getContainerModel(long containerModelId)
throws PortalException, SystemException {
@@ -93,22 +116,62 @@ public String getContainerModelName() {
}
/**
- * @throws PortalException
- * @throws SystemException
+ * Returns a range of all the container models that are children of the
+ * parent container model identified by the container model ID. These
+ * container models must be able to contain the entity identified by the
+ * primary key.
+ *
+ * + * This method checks for the view permission when retrieving the container + * models. + *
+ * + *
+ * Useful when paginating results. Returns a maximum of end -
+ * start instances. The start and end
+ * values are not primary keys but, rather, indexes in the result set. Thus,
+ * 0 refers to the first result in the set. Setting both
+ * start and end to {@link
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
+ * result set.
+ *
+ * This method checks for the view permission when counting the container + * models. + *
+ * + * @param classPK the primary key of an entity the container models must be + * able to contain + * @param containerModelId the primary key of the parent container model + * @return the number of matching container models + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred */ - public int getContainerModelsCount( - long classPK, long parentContainerModelId) + public int getContainerModelsCount(long classPK, long containerModelId) throws PortalException, SystemException { return 0; @@ -119,18 +182,31 @@ public String getDeleteMessage() { } /** - * @throws PortalException - * @throws SystemException + * Returns the link to the location to which the trash entry was restored. + * + * @param portletRequest the portlet request + * @param classPK the primary key of the restored trash entry + * @return the restore link + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred */ - public String getRestoreLink(PortletRequest PortletRequest, long classPK) + public String getRestoreLink(PortletRequest portletRequest, long classPK) throws PortalException, SystemException { return StringPool.BLANK; } /** - * @throws PortalException - * @throws SystemException + * Returns the message describing the location to which the trash entry was + * restored. + * + * @param portletRequest the portlet request + * @param classPK the primary key of the restored trash entry + * @return the restore message + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred */ public String getRestoreMessage(PortletRequest portletRequest, long classPK) throws PortalException, SystemException { @@ -190,8 +266,21 @@ else if (trashActionId.equals(TrashActionKeys.RESTORE)) { } /** - * @throws PortalException - * @throws SystemException + * Returnstrue if the trash entry can be restored to its
+ * original location.
+ *
+ *
+ * This method usually returns false if the container (e.g.
+ * folder) of the trash entry is no longer available (e.g. moved to the
+ * Recycle Bin or deleted).
+ *
true if the trash entry can be restored to its
+ * original location; false otherwise
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
*/
public boolean isRestorable(long classPK)
throws PortalException, SystemException {
@@ -220,8 +309,15 @@ public void restoreTrashEntry(long classPK)
}
/**
- * @throws PortalException
- * @throws SystemException
+ * Updates the title of the trash entry with the primary key. This method is
+ * called by {@link com.liferay.portlet.trash.action.EditEntryAction} before
+ * restoring the trash entry via its restore rename action.
+ *
+ * @param classPK the primary key of the trash entry
+ * @param title the title to be assigned
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
*/
public void updateTitle(long classPK, String title)
throws PortalException, SystemException {
diff --git a/portal-service/src/com/liferay/portal/kernel/trash/TrashHandler.java b/portal-service/src/com/liferay/portal/kernel/trash/TrashHandler.java
index 0ef39709e95445..c13b28022e3759 100644
--- a/portal-service/src/com/liferay/portal/kernel/trash/TrashHandler.java
+++ b/portal-service/src/com/liferay/portal/kernel/trash/TrashHandler.java
@@ -28,80 +28,402 @@
import javax.portlet.PortletRequest;
/**
+ * The interface for managing the basic trash operations of the Recycle Bin,
+ * which include:
+ *
+ * + * These operations are supported for the following entities via their + * respective trash handlers: + *
+ * + *+ * This method is used to check for duplicates when a trash entry is being + * restored or moved out of the Recycle Bin. + *
+ * + * @param trashEntry the trash entry to check + * @param containerModelId the primary key of the destination (e.g. folder) + * @param newName the new name to be assigned to the trash entry + * (optionallynull to forego renaming the trash entry)
+ * @throws PortalException if a duplicate trash entry already existed in the
+ * destination container
+ * @throws SystemException if a system exception occurred
+ */
public void checkDuplicateTrashEntry(
TrashEntry trashEntry, long containerModelId, String newName)
throws PortalException, SystemException;
+ /**
+ * Deletes the group's attachments that were trashed before the given date.
+ *
+ * @param group ID the primary key of the group
+ * @param date the date from which attachments will be deleted
+ * @throws PortalException if any one of the attachment file paths were
+ * invalid
+ * @throws SystemException if a system exception occurred
+ */
public void deleteTrashAttachments(Group group, Date date)
throws PortalException, SystemException;
+ /**
+ * Deletes all the trash entries with the primary keys.
+ *
+ * @param classPKs the primary keys of the trash entries to delete
+ * @throws PortalException if any one of the trash entries could not be
+ * found
+ * @throws SystemException if a system exception occurred
+ */
public void deleteTrashEntries(long[] classPKs)
throws PortalException, SystemException;
+ /**
+ * Deletes all the trash entries with the primary keys, optionally checking
+ * permission before deleting each trash entry.
+ *
+ * @param classPKs the primary keys of the trash entries to delete
+ * @param checkPermission whether to check permission before deleting each
+ * trash entry
+ * @throws PortalException if any one of the trash entries could not be
+ * found
+ * @throws SystemException if a system exception occurred
+ */
public void deleteTrashEntries(long[] classPKs, boolean checkPermission)
throws PortalException, SystemException;
+ /**
+ * Deletes the trash entry with the primary key.
+ *
+ * @param classPK the primary key of the trash entry to delete
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public void deleteTrashEntry(long classPK)
throws PortalException, SystemException;
+ /**
+ * Deletes the trash entry with the primary key.
+ *
+ * @param classPK the primary key of the trash entry to delete
+ * @param checkPermission whether to check permission before deleting the
+ * trash entry
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public void deleteTrashEntry(long classPK, boolean checkPermission)
throws PortalException, SystemException;
+ /**
+ * Returns the class name handled by this trash handler.
+ *
+ * @return the class name handled by this trash handler
+ */
public String getClassName();
+ /**
+ * Returns the container model with the primary key.
+ *
+ * @param containerModelId the primary key of the container model
+ * @return the container model with the primary key
+ * @throws PortalException if a container model with the primary key could
+ * not be found
+ * @throws SystemException if a system exception occurred
+ */
public ContainerModel getContainerModel(long containerModelId)
throws PortalException, SystemException;
+ /**
+ * Returns the name of the container model (e.g. folder name).
+ *
+ * @return the name of the container model
+ */
public String getContainerModelName();
+ /**
+ * Returns a range of all the container models that are children of the
+ * parent container model identified by the container model ID. These
+ * container models must be able to contain the entity identified by the
+ * primary key.
+ *
+ * + * This method checks for the view permission when retrieving the container + * models. + *
+ * + *
+ * Useful when paginating results. Returns a maximum of end -
+ * start instances. The start and end
+ * values are not primary keys but, rather, indexes in the result set. Thus,
+ * 0 refers to the first result in the set. Setting both
+ * start and end to {@link
+ * com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS} will return the full
+ * result set.
+ *
+ * This method checks for the view permission when counting the container + * models. + *
+ * + * @param classPK the primary key of an entity the container models must be + * able to contain + * @param containerModelId the primary key of the parent container model + * @return the number of matching container models + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred + */ public int getContainerModelsCount(long classPK, long containerModelId) throws PortalException, SystemException; + /** + * Returns the message indicating that a search hit was found in a trash + * entry (e.g. in a trashed file or folder). + * + * @return the message + */ public String getDeleteMessage(); + /** + * Returns the link to the location to which the trash entry was restored. + * + * @param portletRequest the portlet request + * @param classPK the primary key of the restored trash entry + * @return the restore link + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred + */ public String getRestoreLink(PortletRequest portletRequest, long classPK) throws PortalException, SystemException; + /** + * Returns the message describing the location to which the trash entry was + * restored. + * + * @param portletRequest the portlet request + * @param classPK the primary key of the restored trash entry + * @return the restore message + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred + */ public String getRestoreMessage(PortletRequest portletRequest, long classPK) throws PortalException, SystemException; + /** + * Returns the name of the root container (e.g. "home"). + * + * @return the name of the root container + */ public String getRootContainerModelName(); + /** + * Returns the name of the sub-container model (e.g. for a folder the + * sub-container model name may be "subfolder"). + * + * @return the name of the sub-container model + */ public String getSubcontainerModelName(); + /** + * Returns the trash renderer associated to the trash entry with the primary + * key. + * + * @param classPK the primary key of the trash entry + * @return the trash renderer associated to the trash entry + * @throws PortalException if a trash entry with the primary key could not + * be found + * @throws SystemException if a system exception occurred + */ public TrashRenderer getTrashRenderer(long classPK) throws PortalException, SystemException; + /** + * Returnstrue if the user has the required permission to
+ * perform the trash action on the trash entry with the primary key.
+ *
+ * + * This method is a mapper for special Recycle Bin operations that are not + * real permissions. The implementations of this method should translate + * these virtual permissions to real permission checks. + *
+ * + * @param permissionChecker the permission checker + * @param groupId the primary key of the group + * @param classPK the primary key of the trash entry + * @param trashActionId the trash action permission to check + * @returntrue if the user has the required permission;
+ * false otherwise
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public boolean hasTrashPermission(
PermissionChecker permissionChecker, long groupId, long classPK,
String trashActionId)
throws PortalException, SystemException;
+ /**
+ * Returns true if the trash entry with the primary key is in
+ * the Recycle Bin.
+ *
+ * @param classPK the primary key of the trash entry
+ * @return true if the trash entry is in the Recycle Bin;
+ * false otherwise
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found in the portal
+ * @throws SystemException if a system exception occurred
+ */
public boolean isInTrash(long classPK)
throws PortalException, SystemException;
+ /**
+ * Returns true if the trash entry can be restored to its
+ * original location.
+ *
+ *
+ * This method usually returns false if the container (e.g.
+ * folder) of the trash entry is no longer available (e.g. moved to the
+ * Recycle Bin or deleted).
+ *
true if the trash entry can be restored to its
+ * original location; false otherwise
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public boolean isRestorable(long classPK)
throws PortalException, SystemException;
+ /**
+ * Moves the trash entry with the primary key out of the Recycle Bin to a
+ * new destination identified by the container model ID.
+ *
+ * @param classPK the primary key of the trash entry
+ * @param containerModelId the primary key of the destination container
+ * model
+ * @param serviceContext the service context
+ * @return the moved trash entry
+ * @throws PortalException if a trash entry with the primary key or the
+ * destination container model with the primary key could not be
+ * found
+ * @throws SystemException if a system exception occurred
+ */
public TrashEntry moveTrashEntry(
long classPK, long containerModelId, ServiceContext serviceContext)
throws PortalException, SystemException;
+ /**
+ * Restores all the trash entries with the primary keys.
+ *
+ * @param classPKs the primary keys of the trash entries to restore
+ * @throws PortalException if any one of the trash entries could not be
+ * found
+ * @throws SystemException if a system exception occurred
+ */
public void restoreTrashEntries(long[] classPKs)
throws PortalException, SystemException;
+ /**
+ * Restores the trash entry with the primary key.
+ *
+ * @param classPK the primary key of the trash entry to restore
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public void restoreTrashEntry(long classPK)
throws PortalException, SystemException;
+ /**
+ * Updates the title of the trash entry with the primary key. This method is
+ * called by {@link com.liferay.portlet.trash.action.EditEntryAction} before
+ * restoring the trash entry via its restore rename action.
+ *
+ * @param classPK the primary key of the trash entry
+ * @param title the title to be assigned
+ * @throws PortalException if a trash entry with the primary key could not
+ * be found
+ * @throws SystemException if a system exception occurred
+ */
public void updateTitle(long classPK, String title)
throws PortalException, SystemException;