@sitevision/api 2023.2.1 → 2023.2.2-beta.2

package/server/TimestampUtil/index.d.ts

@@ -1,10 +1,17 @@
+import type { String } from "../../types/java/lang/String";
+import type { Locale } from "../../types/java/util/Locale";
+import type { Date } from "../../types/java/util/Date";
+import type { Calendar } from "../../types/java/util/Calendar";
+import type { Instant } from "../../types/java/time/Instant";
+import type { LocalDateTime } from "../../types/java/time/LocalDateTime";
+
 /**
  * Timestamp utility interface.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTimestampUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTimestampUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Jimmy Roselin
  * @since Sitevision 4.5.4.1
  */
@@ -18,34 +25,38 @@ export interface TimestampUtil {
   /**
    * Formats current timestamp.
    * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @return a formatted String representing current timestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aFormatPattern is not valid current timestamp is returned as String.
+   * @return a formatted String representing current timestamp using Locale according to&#xA; {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used.&#xA; If aFormatPattern is not valid current timestamp is returned as String.
    */
-  formatCurrent(aFormatPattern: string): string;
+  formatCurrent(aFormatPattern: String | string): string;
 
   /**
    * Formats current timestamp using a specified Locale.
    * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
+   * @param aLocale a locale. If aLocale is null the current locale (as of&#xA; {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved&#xA; Locale.ENGLISH will be used.
    * @return a formatted String representing current timestamp. If aFormatPattern is not valid current timestamp is returned as String.
    */
-  formatCurrent(aFormatPattern: string, aLocale: unknown): string;
+  formatCurrent(aFormatPattern: String | string, aLocale: Locale): string;
 
   /**
    * Formats a given timestamp.
    * @param aTimestamp a timestamp.
    * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @return a formatted String representing aTimestamp using Locale according to {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
+   * @return a formatted String representing aTimestamp using Locale according to&#xA; {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}. If aLocale can not be resolved Locale.ENGLISH is used.&#xA; If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
    */
-  format(aTimestamp: number, aFormatPattern: string): string;
+  format(aTimestamp: number, aFormatPattern: String | string): string;
 
   /**
    * Formats a given timestamp using a specified Locale.
    * @param aTimestamp a timestamp.
    * @param aFormatPattern a date to string pattern according to SimpleDateFormat.
-   * @param aLocale a locale. If aLocale is null the current locale (as of {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved Locale.ENGLISH will be used.
-   * @return a formatted String representing the aTimestamp. If aTimestamp is negative or aFormatPattern is not valid the given timestamp is returned as String.
+   * @param aLocale a locale. If aLocale is null the current locale (as of&#xA; {@link senselogic.sitevision.api.context.PortletContextUtil#getCurrentLocale()}) will be used. If aLocale can not be resolved&#xA; Locale.ENGLISH will be used.
+   * @return a formatted String representing the aTimestamp. If aTimestamp is negative or aFormatPattern is not valid the given timestamp&#xA; is returned as String.
    */
-  format(aTimestamp: number, aFormatPattern: string, aLocale: unknown): string;
+  format(
+    aTimestamp: number,
+    aFormatPattern: String | string,
+    aLocale: Locale
+  ): string;
 
   /**
    * Converts a timestamp to a Date.
@@ -53,7 +64,7 @@ export interface TimestampUtil {
    * @return the Date representing aTimestamp, or null if aTimestamp is negative.
    * @since Sitevision 4.5.5
    */
-  toDate(aTimestamp: number): unknown;
+  toDate(aTimestamp: number): Date;
 
   /**
    * Converts a Date to a timestamp.
@@ -61,7 +72,7 @@ export interface TimestampUtil {
    * @return the timestamp representing aDate, or -1 if aDate is null.
    * @since Sitevision 4.5.5
    */
-  fromDate(aDate: unknown): number;
+  fromDate(aDate: Date): number;
 
   /**
    * Converts a timestamp to a Calendar.
@@ -69,7 +80,7 @@ export interface TimestampUtil {
    * @return the Calendar representing aTimestamp, or null if aTimestamp is negative.
    * @since Sitevision 4.5.5
    */
-  toCalendar(aTimestamp: number): unknown;
+  toCalendar(aTimestamp: number): Calendar;
 
   /**
    * Converts a Calendar to a timestamp.
@@ -77,7 +88,7 @@ export interface TimestampUtil {
    * @return the timestamp representing aCalendar, or -1 if aCalendar is null.
    * @since Sitevision 4.5.5
    */
-  fromCalendar(aCalendar: unknown): number;
+  fromCalendar(aCalendar: Calendar): number;
 
   /**
    * Converts a timestamp to a Instant.
@@ -85,7 +96,7 @@ export interface TimestampUtil {
    * @return the Instant representing aTimestamp, or null if aTimestamp is negative.
    * @since Sitevision 4.5.5
    */
-  toInstant(aTimestamp: number): unknown;
+  toInstant(aTimestamp: number): Instant;
 
   /**
    * Converts a Instant to a timestamp.
@@ -93,7 +104,7 @@ export interface TimestampUtil {
    * @return aInstant timestamp representing aInstant, or -1 if aInstant is null.
    * @since Sitevision 4.5.5
    */
-  fromInstant(aInstant: unknown): number;
+  fromInstant(aInstant: Instant): number;
 
   /**
    * Converts a timestamp to a LocalDateTime (using the system default ZoneId).
@@ -101,7 +112,7 @@ export interface TimestampUtil {
    * @return the LocalDateTime representing aTimestamp, or null if aTimestamp is negative.
    * @since Sitevision 4.5.5
    */
-  toLocalDateTime(aTimestamp: number): unknown;
+  toLocalDateTime(aTimestamp: number): LocalDateTime;
 
   /**
    * Converts a LocalDateTime to a timestamp (using the system default ZoneId).
@@ -109,7 +120,7 @@ export interface TimestampUtil {
    * @return aInstant timestamp representing aLocalDateTime, or -1 if aLocalDateTime is null.
    * @since Sitevision 4.5.5
    */
-  fromLocalDateTime(aLocalDateTime: unknown): number;
+  fromLocalDateTime(aLocalDateTime: LocalDateTime): number;
 }
 
 declare namespace TimestampUtil {}

package/server/TranslationUtil/index.d.ts

@@ -1,13 +1,16 @@
+import type { List } from "../../types/java/util/List";
 import type { Node } from "../../types/javax/jcr/Node";
 
+import type { Map } from "../../types/java/util/Map";
+
 /**
  * Translation utility interface.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getTranslationUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via
+ *     {@link senselogic.sitevision.api.Utils#getTranslationUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Magnus Lövgren
  * @since Sitevision 4.2.1
  */
@@ -15,72 +18,72 @@ export interface TranslationUtil {
   /**
    * Gets a list of all Locales that are set up for translations on the current site.
    *
-   * <p>
-   *    <em>Note! The returned List is immutable/unmodifiable,
-   *    i.e. you must create a copy if you want to modify it (e.g. sort).</em>
-   * </p>
+   *  <p>
+   *     <em>Note! The returned List is immutable/unmodifiable,
+   *     i.e. you must create a copy if you want to modify it (e.g. sort).</em>
+   *  </p>
    * @return a list of all Locales that are set up for translations on the current site
    */
-  getSiteTranslationLocales(): unknown;
+  getSiteTranslationLocales(): List;
 
   /**
    * Gets the translation mappings for a given page node.
    *
-   * <p>
-   *    Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
-   * </p>
-   * <p>
-   *    <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
-   * </p>
-   * <ul>
-   *    <li>
-   *       The entry <em>key</em> (i.e. the Locale) will never be null.
-   *    </li>
-   *    <li>
-   *       The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
-   *       {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
-   *    </li>
-   * </ul>
+   *  <p>
+   *     Each entry in the returned map depicts a <em>"translation"</em>, i.e. a localized version of the given <code>aPageNode</code>.
+   *  </p>
+   *  <p>
+   *     <strong>Important note! The returned map is never null, but entry <em>values</em> in the map might be!</strong>
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        The entry <em>key</em> (i.e. the Locale) will never be null.
+   *     </li>
+   *     <li>
+   *        The entry <em>value</em> (i.e. the Node) will be null if current user doesn't have
+   *        {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the node.
+   *     </li>
+   *  </ul>
    *
-   * <p>
-   *    <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
-   *    {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
-   *       Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
-   * </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
-   *        translationUtil = require('TranslationUtil'),
-   *        nodeFilterUtil = require('NodeFilterUtil'),
-   *        translationMappings,
-   *        skipNullValuesFilter,
-   *        filteredTranslationMappings;
+   *  <p>
+   *     <em>Tip!</em> If you are only interested in non-null Nodes/values in the returned map, you can use
+   *     {@link senselogic.sitevision.api.node.NodeFilterUtil} to filter them out!<br>
+   *        Below is a conceptual example of how it could be done in server-side JavaScript (e.g. WebApp, RESTApp, Script module).
+   *  </p><pre><code>    var thePotentiallyTranslatedPageNode = ...,
+   *         translationUtil = require('TranslationUtil'),
+   *         nodeFilterUtil = require('NodeFilterUtil'),
+   *         translationMappings,
+   *         skipNullValuesFilter,
+   *         filteredTranslationMappings;
    *
-   *    translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
+   *     translationMappings = translationUtil.getTranslations(thePotentiallyTranslatedPageNode, false);
    *
-   *    skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
-   *    filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
+   *     skipNullValuesFilter = nodeFilterUtil.getNonNullFilter();
+   *     filteredTranslationMappings = nodeFilterUtil.getFilteredValueMap(translationMappings, skipNullValuesFilter);</code></pre>
    *
-   * <p>
-   *    Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
-   *    depends on the <code>aIncludePageNode</code> value:
-   * </p>
-   * <ul>
-   *    <li>
-   *       If it is <code>false</code>, an empty map will be returned.
-   *    </li>
-   *    <li>
-   *       If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
-   *    </li>
-   * </ul>
+   *  <p>
+   *     Please note that determining the "<em>is this page node translated at all?</em>" state from the returned result
+   *     depends on the <code>aIncludePageNode</code> value:
+   *  </p>
+   *  <ul>
+   *     <li>
+   *        If it is <code>false</code>, an empty map will be returned.
+   *     </li>
+   *     <li>
+   *        If it is <code>true</code>, a map with one entry <em>(i.e. the <code>aPageNode</code> itself)</em> will be returned.
+   *     </li>
+   *  </ul>
    * @param aPageNode a page node that can be translated
    * @param aIncludePageNode whether or not to include aPageNode in the result
    * @return a Map of translation mappings
    * @since Sitevision 4.3.1
    */
-  getTranslations(aPageNode: Node, aIncludePageNode: boolean): unknown;
+  getTranslations(aPageNode: Node, aIncludePageNode: boolean): Map;
 
   /**
    * Gets the page node a given node is potentially translated from (the translation source).
    * @param aPageNode the page node that is translated
-   * @return the page node aPageNode was translated from, or null if the page node isn't translated from another page or if current user doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the from node.
+   * @return the page node aPageNode was translated from, or null if the page node isn't translated from another page or if current user&#xA; doesn't have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} permissions on the from node.
    * @since Sitevision 4.3.1
    */
   getTranslatedFrom(aPageNode: Node): Node;
@@ -88,15 +91,15 @@ export interface TranslationUtil {
   /**
    * Sets the translated from node to the page node provided as translation node.
    *
-   * <p>
-   *    <strong>Permission note!</strong> Current user must match have
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
-   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
-   *    on @aTranslationPageNode.
-   * </p>
-   * @param aOriginalPageNode the original page node to be configured as translated from on aTranslationPageNode. It will be configured as original in aTranslationPageNode as well if aOriginalPageNode doesn't have any original configured.
+   *  <p>
+   *     <strong>Permission note!</strong> Current user must match have
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_TRANSLATIONS} and
+   *     {@link senselogic.sitevision.api.security.PermissionUtil.Permission#WRITE}
+   *     on @aTranslationPageNode.
+   *  </p>
+   * @param aOriginalPageNode the original page node to be configured as translated from on aTranslationPageNode. It will be configured as&#xA; original in aTranslationPageNode as well if aOriginalPageNode doesn't have any original configured.
    * @param aTranslationPageNode the translation page node to be configured as translation of aOriginalPageNode
-   * @return true if aTranslationPageNode could be configured as translation of aOriginalPageNode, false otherwise.
+   * @return true if aTranslationPageNode could be configured as translation of aOriginalPageNode,&#xA; false otherwise.
    * @since Sitevision 4.3.2
    */
   setTranslatedFrom(

package/server/TrashcanUtil/index.d.ts

@@ -3,10 +3,10 @@ import type { Node } from "../../types/javax/jcr/Node";
 /**
  * Trashcan utility interface for delete and restore of nodes.
  *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTrashcanUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>
+ *  <p>
+ *     An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTrashcanUtil()}.
+ *     See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ *  </p>
  * @author Mikael Wikblom
  * @see senselogic.sitevision.api.resource.ResourceLocatorUtil#getTrashcan()
  * @since Sitevision 2.6.2
@@ -14,41 +14,42 @@ import type { Node } from "../../types/javax/jcr/Node";
 export interface TrashcanUtil {
   /**
    * <p>
-   *    Puts a node in the site trashcan.
-   * </p>
-   * <p>
-   *    A node that has been deleted (i.e. put in the site trashcan) can later be restored using the method
-   *    {@link #restoreNode(javax.jcr.Node)} or be permanently removed with the method
-   *    {@link #deleteNodeFromTrashcan(javax.jcr.Node)}.
-   * </p>
-   * <p>
-   *    Valid node types are:
-   * </p>
-   * <ul>
-   *    <li><code>sv:archive</code></li>
-   *    <li><code>sv:article</code></li>
-   *    <li><code>sv:file</code></li>
-   *    <li><code>sv:folder</code></li>
-   *    <li><code>sv:image</code></li>
-   *    <li><code>sv:link</code></li>
-   *    <li><code>sv:page</code></li>
-   *    <li><code>sv:template</code></li>
-   * </ul>
-   * <p>
-   *    If any other node is specified a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *     Puts a node in the site trashcan.
+   *  </p>
+   *  <p>
+   *     A node that has been deleted (i.e. put in the site trashcan) can later be restored using the method
+   *     {@link #restoreNode(javax.jcr.Node)} or be permanently removed with the method
+   *     {@link #deleteNodeFromTrashcan(javax.jcr.Node)}.
+   *  </p>
+   *  <p>
+   *     Valid node types are:
+   *  </p>
+   *  <ul>
+   *     <li><code>sv:archive</code></li>
+   *     <li><code>sv:article</code></li>
+   *     <li><code>sv:collaborationGroupPage</code> <em>(since Sitevision 2023.02.1)</em></li>
+   *     <li><code>sv:file</code></li>
+   *     <li><code>sv:folder</code></li>
+   *     <li><code>sv:image</code></li>
+   *     <li><code>sv:link</code></li>
+   *     <li><code>sv:page</code></li>
+   *     <li><code>sv:template</code></li>
+   *  </ul>
+   *  <p>
+   *     If any other node is specified a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    The current user must be authorized to delete objects, to alter the node and its current parent or
-   *    a <code>ConstraintViolationException</code> is thrown
-   *    (see {@link senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)}).
-   * </p>
+   *  <p>
+   *     The current user must be authorized to delete objects, to alter the node and its current parent or
+   *     a <code>ConstraintViolationException</code> is thrown
+   *     (see {@link senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)}).
+   *  </p>
    *
-   * <p>
-   *    If no node is specified a <code>NullPointerException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
    * @param aNode the node that will be moved to the site trashcan. May not be <code>null</code>
-   * @throws ConstraintViolationException if an invalid node is specified or if the current user is not authorized to perform the delete operation
+   * @throws ConstraintViolationException if an invalid node is specified or if the current user is not&#xA; authorized to perform the delete operation
    * @throws RepositoryException if something else goes wrong
    * @see senselogic.sitevision.api.security.PermissionUtil#hasEffectiveDeletePermission(Node, Node)
    */
@@ -56,46 +57,46 @@ export interface TrashcanUtil {
 
   /**
    * <p>
-   *    Restores a node from the site trashcan.
-   * </p>
-   * <p>
-   *    If the node is not in the site trashcan or if an invalid node type is specified
-   *    (i.e. a node that never could be in the site trashcan like the sv:site node)
-   *    a <code>IllegalArgumentException</code> is thrown.
-   * </p>
+   *     Restores a node from the site trashcan.
+   *  </p>
+   *  <p>
+   *     If the node is not in the site trashcan or if an invalid node type is specified
+   *     (i.e. a node that never could be in the site trashcan like the sv:site node)
+   *     a <code>IllegalArgumentException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    The current user must be authorized to alter the node and the parent node after the
-   *    restore operation or a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *  <p>
+   *     The current user must be authorized to alter the node and the parent node after the
+   *     restore operation or a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    If no node is specified a <code>NullPointerException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
    * @param aNode the node that should be restored. This node must be located in the site trashcan. May not be null
-   * @throws ConstraintViolationException is thrown if the current user is not authorized to perform the restore operation
+   * @throws ConstraintViolationException is thrown if the current user is not authorized to perform the&#xA; restore operation
    * @throws RepositoryException is thrown if something else goes wrong
    */
   restoreNode(aNode: Node): void;
 
   /**
    * <p>
-   *    Deletes a node from the site trashcan.
-   * </p>
-   * <p>
-   *    If the node is not in the site trashcan or if an invalid node type is specified
-   *    (i.e. a node that never could be in the site trashcan like the sv:site node)
-   *    a <code>IllegalArgumentException</code> is thrown.
-   * </p>
+   *     Deletes a node from the site trashcan.
+   *  </p>
+   *  <p>
+   *     If the node is not in the site trashcan or if an invalid node type is specified
+   *     (i.e. a node that never could be in the site trashcan like the sv:site node)
+   *     a <code>IllegalArgumentException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    The current user must be authorized to delete objects or a <code>ConstraintViolationException</code> is thrown.
-   * </p>
+   *  <p>
+   *     The current user must be authorized to delete objects or a <code>ConstraintViolationException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    If no node is specified a <code>NullPointerException</code> is thrown.
-   * </p>
-   * @param aNode the node that should be removed from the site trashcan. This node must be located in the site trashcan. May not be <code>null</code>
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
+   * @param aNode the node that should be removed from the site trashcan. This node must be located in the site trashcan.&#xA; May not be <code>null</code>
    * @throws ConstraintViolationException if the current user is not authorized to perform the delete operation
    * @throws RepositoryException if something else goes wrong
    */
@@ -103,18 +104,18 @@ export interface TrashcanUtil {
 
   /**
    * <p>
-   *    Checks if a node is in the site trashcan
-   * </p>
+   *     Checks if a node is in the site trashcan
+   *  </p>
    *
-   * <p>
-   *    If no node is specified a <code>NullPointerException</code> is thrown.
-   * </p>
+   *  <p>
+   *     If no node is specified a <code>NullPointerException</code> is thrown.
+   *  </p>
    *
-   * <p>
-   *    Note that some nodes can't be put in the trashcan (e.g. sv:user, sv:color, sv:portlet, sv:layout etc).
-   *    For such nodes <code>false</code> will be returned.
-   * </p>
-   * @param aNode the node to be checked if it is located in the site trashcan. May not be <code>null</code>
+   *  <p>
+   *     Note that some nodes can't be put in the trashcan (e.g. sv:user, sv:color, sv:portlet, sv:layout etc).
+   *     For such nodes <code>false</code> will be returned.
+   *  </p>
+   * @param aNode the node to be checked if it is located in the site trashcan.&#xA; May not be <code>null</code>
    * @return <code>true</code> if the <code>Node</code> is in site trashcan, <code>false</code> otherwise
    * @since Sitevision 6.2
    */