@sitevision/api 1.0.19 → 1.1.0-alpha.1

package/hidden/senselogic/sitevision/api/base/Builder/index.d.ts

@@ -0,0 +1,102 @@
+/**
+ * This is the base interface for all builders in the Sitevision Utility API.
+ *
+ * <p>
+ *    A <code>Builder</code> is used to set up the state necessary to build an instance of a specific type.
+ * </p>
+ * <p>
+ *    A <code>Builder</code> has zero or more <strong>optional attributes</strong> and zero or more <strong>mandatory attributes</strong>.
+ *    The builder will typically throw an <code>IllegalStateException</code> if a <em>mandatory</em> attribute hasn't been
+ *    set when the <code>build()</code> method is invoked.
+ * </p>
+ * <p>
+ *    A <code>Builder</code> is <strong>not thread safe</strong>, but the it <strong>can be re-used</strong> by the same thread to build multiple
+ *    instances.
+ * </p>
+ * <p>
+ *    Using a <code>Builder</code> is pretty straightforward, if you remember that it is <strong>stateful</strong>. Conceptually you
+ *    would typically use it like this:
+ * </p>
+ * <ol>
+ *   <li>Get the Builder</li>
+ *   <li>Set/add all mandatory attributes</li>
+ *   <li>Potentially set/add optional attributes</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built an instance, you can re-use the builder to build more instances. Typically like:
+ * </p>
+ * <ol>
+ *   <li>(Re-)set one or more attributes</li>
+ *   <li>Do build</li>
+ * </ol>
+ *
+ * <p>
+ *    All methods (except the <code><em>build()</em></code> method) of a <code>Builder</code> will typically
+ *    <strong>return the builder itself</strong>.
+ *    This makes it easy to "chain" all method invocations, i.e. do all setup on a single line of code.
+ * </p>
+ * <h3>An example of how to work with a Builder!</h3>
+ * <p>
+ *    In <strong>Java</strong>, you would typically use the {@link senselogic.sitevision.api.mail.MailBuilder} like this:
+ * </p><pre><code>   MailBuilder mailBuilder = siteVisionUtils.getMailUtil().getMailBuilder();
+ *
+ *   <em>// Create a mail</em>
+ *   Mail mail = mailBuilder.setSubject("Hello")
+ *                          .setTextMessage("How are you Magnus?")
+ *                          .addRecipient("magnus.lovgren@sitevision.se")
+ *                          .build();</code></pre>
+ * <p>
+ *    The code would typically look similar when using server-side <strong>JavaScript</strong>:
+ * </p><pre><code>   var mailBuilder = require('MailBuilder');
+ *
+ *   <em>// Create a mail</em>
+ *   var mail = mailBuilder.setSubject('Hello')
+ *                         .setTextMessage('How are you Magnus?')
+ *                         .addRecipient('magnus.lovgren@sitevision.se')
+ *                         .build();</code></pre>
+ * <p>
+ *    To use the same multi-line approach in <strong>Velocity</strong>, you would actually have to write it like this:
+ * </p><pre><code>   #set ($mailBuilder = $sitevisionUtils.mailUtil.mailBuilder)
+ *
+ *   <em>## Create a mail</em>
+ *   #set ($mail = $mailBuilder.setSubject('Hello'
+ *                            ).setTextMessage('How are you Magnus?'
+ *                            ).addRecipient('magnus.lovgren@sitevision.se'
+ *                            ).build())</code></pre>
+ * <p>
+ *    As exemplified above, working with a builder in Velocity has some caveats since the Velocity parser doesn't allow whitespace
+ *    before the dot <em>(i.e. you must put the method closing parenthesis and the dot tight together)</em>. If you are uncomfortable handling
+ *    multi-line nested method invocations in Velocity as above, you could instead:
+ * </p>
+ * <ul>
+ *    <li>
+ *       Put all nested invocations on one line:<pre><code>
+ *       <em>## Create a mail</em>
+ *       #set ($mail = $mailBuilder.setSubject('Hello').setTextMessage('How are you Magnus?').addRecipient('magnus.lovgren@sitevision.se').build())
+ *       </code></pre>
+ *    </li>
+ *    <li>
+ *       Use the {@link senselogic.sitevision.api.script.ScriptUtil#swallow(Object)} method to prohibit unwanted output:<pre><code>
+ *       <em>## Get script util</em>
+ *       #set ($scriptUtil = $sitevisionUtils.scriptUtil)
+ *       ...
+ *       <em>## Create a mail</em>
+ *       $scriptUtil.swallow($mailBuilder.setSubject('Hello'))
+ *       $scriptUtil.swallow($mailBuilder.setTextMessage('How are you Magnus?'))
+ *       $scriptUtil.swallow($mailBuilder.addRecipient('magnus.lovgren@sitevision.se'))
+ *       #set ($mail = $mailBuilder.build())</code></pre>
+ *    </li>
+ * </ul>Creates an instance of type <em>T</em> using current state of this builder.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Builder {
+  /**
+   * Creates an instance of type <em>T</em> using current state of this builder.
+   * @return an instance of type <em>T</em>
+   */
+  build(): unknown;
+}
+
+export default Builder;

package/hidden/senselogic/sitevision/api/base/Filter/index.d.ts

@@ -0,0 +1,25 @@
+/**
+ * This is the base interface for all filters in the Sitevision Utility API.
+ *
+ * <p>
+ *    A <em>filter</em> is used to determine if an object matches a certain criteria or not.
+ *    Typically a filter is applied to a <code>Collection</code> or a <code>Iterator</code>
+ *    to extract all "relevant/matching" objects.
+ * </p>
+ * <p>
+ *    See {@link senselogic.sitevision.api.node.NodeFilterUtil} for predefined node filters (i.e. <code>Filter&lt;Node&gt;</code>).
+ * </p>Whether a given object matches the filter requirements or not.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.2
+ * @see senselogic.sitevision.api.node.NodeFilterUtil
+ */
+interface Filter {
+  /**
+   * Whether a given object matches the filter requirements or not.
+   * @param anObject the object to check
+   * @return <code>true</code> if <code>anObject</code> is accepted by this filter, <code>false</code> otherwise
+   */
+  accept(anObject: unknown): boolean;
+}
+
+export default Filter;

package/hidden/senselogic/sitevision/api/base/FilterSplit/index.d.ts

@@ -0,0 +1,50 @@
+import Filter from "../Filter";
+
+/**
+ * This is the base interface for all filter splits in the Sitevision Utility API.
+ *
+ * <p>
+ *    A <em>filter split</em> is the result of a filtering operation on a <code>Collection</code> or an <code>Iterator</code>.
+ *    When a filter is applied to a number of items, some of them will potentially be <em>accepted</em> by the filter and some
+ *    of them will be <em>rejected</em> by the filter. This interface depicts the result of such filtering operation.
+ * </p>
+ *
+ * <p>
+ *    <em>Tip!</em> When working with a <code>Filter&lt;Node&gt;</code>, you would typically use
+ *    {@link senselogic.sitevision.api.node.NodeIteratorUtil#split(javax.jcr.NodeIterator, Filter)}
+ *    to split on an iterator and
+ *    {@link senselogic.sitevision.api.node.NodeFilterUtil#split(java.util.Collection, Filter)}
+ *    to split on a collection.
+ * </p>Gets the list of items that was accepted by the filter.
+ *
+ * <p>
+ *    <em>Note! The accepted list will always be empty if the filter used for the filtering operation is null</em>
+ * </p>Gets the list of items that was rejected by the filter.Gets the filter used for the filtering operation.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6.3
+ */
+interface FilterSplit {
+  /**
+   * Gets the list of items that was accepted by the filter.
+   *
+   * <p>
+   *    <em>Note! The accepted list will always be empty if the filter used for the filtering operation is null</em>
+   * </p>
+   * @return the list of accepted items, never <code>null</code>
+   */
+  getAccepted(): unknown[];
+
+  /**
+   * Gets the list of items that was rejected by the filter.
+   * @return the list of rejected items, never <code>null</code>
+   */
+  getRejected(): unknown[];
+
+  /**
+   * Gets the filter used for the filtering operation.
+   * @return the filter used
+   */
+  getFilter(): Filter;
+}
+
+export default FilterSplit;

package/hidden/senselogic/sitevision/api/base/Loadable/index.d.ts

@@ -0,0 +1,15 @@
+/**
+ * A functional interface for loading resources.Loads a resource that is identified with a specific name.
+ * @author Magnus Lövgren
+ * @since Sitevision 4.0
+ */
+interface Loadable {
+  /**
+   * Loads a resource that is identified with a specific name.
+   * @param aName the name of the resource
+   * @return the resource, or <code>null</code> if no resource match <code>aName</code>
+   */
+  load(aName: string): unknown;
+}
+
+export default Loadable;

package/hidden/senselogic/sitevision/api/base/Resolver/index.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This is the base interface for all resolvers in the Sitevision Utility API.
+ *
+ * <p>
+ *    A <em>resolver</em> operates on an object and extracts/transforms/calculates a value of different type.
+ * </p>
+ * <p>
+ *    <em>
+ *       Note! This functional interface is conceptually equivalent (though the method names differ) with the
+ *       <code>java.util.function.Function</code> interface that was introduced in Java 8.
+ *    </em>
+ * </p>
+ * <p>
+ *    See {@link senselogic.sitevision.api.node.NodeResolverUtil} for predefined resolvers that operates on nodes
+ *    (i.e. <code>Resolver&lt;Node,?&gt;</code>).
+ * </p>Resolves a value from an object.
+ * @param <T> type of object to operate on
+ * @param <V> type of value to produce
+ * @author Magnus Lövgren
+ * @since Sitevision 4.1
+ */
+interface Resolver {
+  /**
+   * Resolves a value from an object.
+   * @param aObject the object to operate on
+   * @return the resolved value
+   */
+  resolve(aObject: unknown): unknown;
+}
+
+export default Resolver;

package/hidden/senselogic/sitevision/api/base/Wrapper/index.d.ts

@@ -0,0 +1,24 @@
+/**
+ * This is the base interface for all wrappers in the Sitevision Utility API.
+ *
+ * <p>
+ *    A <em>Wrapper</em> "wraps" and "encapsulates" the functionality of another class or interface in order to make it easier to use
+ *    and potentially provide different behaviour than the wrapped object can provide. In general a wrapper is going to expand on what
+ *    the wrapped object does.
+ * </p>
+ * <p>
+ *    All invocations for the wrapper will be delegated to the wrapped object, or executed with the wrapped object as subject/context
+ *    when performing the invocation.
+ * </p>Gets the wrapped object.
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface Wrapper {
+  /**
+   * Gets the wrapped object.
+   * @return the wrapped object, i.e. the instance that was used when this wrapper was created
+   */
+  unwrap(): unknown;
+}
+
+export default Wrapper;

package/hidden/senselogic/sitevision/api/collaboration/CollaborationGroupWrapper/index.d.ts

@@ -0,0 +1,417 @@
+import Node from "../../../../../javax/jcr/Node";
+import CollaborationGroupType from "../../../../../../server/CollaborationGroupType";
+import CollaborationGroupState from "../../../../../../server/CollaborationGroupState";
+
+/**
+ * Collaboration group administration interface.
+ *
+ * <p>
+ *    This wrapper provides methods to update an existing collaboration group. You would typically use
+ *    {@link CollaborationGroupUtil} to <em>create</em> a new collaboration group.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link CollaborationFactory#getCollaborationGroupWrapper(javax.jcr.Node)}.
+ *    See {@link CollaborationFactory} for how to obtain an instance of the <code>CollaborationFactory</code> interface.
+ * </p>Gets the admins of the wrapped collaboration group.Checks if a user identity is admin of the wrapped collaboration group.Adds a user identity as admin of the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Only non-admins will be added</em>, i.e. a user identity that already is an admin will be ignored.
+ *    Collaboration groups that are <em>inactive/unavailable</em> don't accept any new admins.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> To add an admin to the wrapped group, current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group.
+ * </p>Gets the members of the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Note!</em> Admins are also considered as members.
+ * </p>Checks if a user identity is member of the wrapped collaboration group.Adds a user identity as member of the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Only non-members will be added</em>, i.e. a user identity that already is a member will be ignored.
+ *    Collaboration groups that are <em>inactive</em> doesn't accept any new members.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> To add a member to the wrapped group, current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group -
+ *    or current user must match the given user identity (i.e. "is yourself") and have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
+ * </p>Removes a member from the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Only members can be removed</em>, i.e. a user identity that is a non-member will be ignored. Note that an <em>admin</em>
+ *    is also a <em>member</em> so removing a member might in fact also remove an <em>admin</em>, but <em>last admin</em> will never be removed.
+ *    Members can not be removed from collaboration groups that are <em>inactive</em>.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> To remove group membership for a user identity, current user
+ *    must match the user identity (i.e. "is yourself") - or have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
+ * </p>Gets the followers/eavesdroppers of the wrapped collaboration group.Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.Alters the name of the wrapped collaboration group.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group.
+ * </p>
+ *
+ * <p>
+ *    <em>Name note!</em> Each group name must be (case-insensitively) unique in a given structure (i.e. collaboration group folder).
+ *    This method will remove leading and trailing whitespace from <code>aGroupName</code> and use the remaining characters
+ *    as new name. The wrapped group will <em>not</em> be renamed if <code>aGroupName</code> is <code>null</code>, whitespace only or if
+ *    the remaining characters already exist as group name.
+ * </p>
+ *
+ * <p>
+ *    <em>Tip!</em> Use {@link CollaborationGroupFolderUtil#containsCollaborationGroup(javax.jcr.Node, String)}
+ *    to check if a named collaboration group already exists in the collaboration group folder of the group.
+ * </p>Gets the collaboration group type of the wrapped collaboration group.Changes the collaboration group type of the wrapped collaboration group.
+ *
+ * <p>
+ *    The group type can not be changed for collaboration groups that are <em>inactive</em>.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group in order to change group type. In order to change group type to
+ *    {@link CollaborationGroupType#CLOSED},
+ *    current user must also have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group.
+ * </p>Gets the collaboration group state of the wrapped collaboration group.Changes the collaboration group state of the wrapped collaboration group.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group in order to change group state.
+ * </p>Gets the group description of the wrapped collaboration group.Sets the group description of the wrapped collaboration group.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group in order to change group description.
+ * </p>Gets the profile images folder of the wrapped collaboration group.Gets the profile image of the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Note!</em> This method returns the 'raw' profile image (i.e. a Node of type <code>sv:image</code>)
+ *    that the group has uploaded. For buddy icons, see {@link senselogic.sitevision.api.render.BuddyIconRenderer}.
+ * </p>Sets the profile image of the wrapped collaboration group.
+ *
+ * <p>
+ *    This method <em>sets</em> the active profile image, i.e. determines which profile image that should be used.
+ *    To <em>create a new</em> profile image (i.e. new binary data), you would typically use
+ *    a method in {@link senselogic.sitevision.api.webresource.ImageUtil} first.
+ * </p>
+ *
+ * <p>
+ *    <strong>Model note!</strong> A profile image must be a Node of type <code>sv:image</code>
+ *    and a child of the <em>profile images folder</em> of the wrapped collaboration group.
+ *    The profile images folder is available via {@link #getProfileImagesFolder()}.
+ * </p>
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group in order to set the profile image.
+ * </p>Alters the render Locale used by the wrapped collaboration group.
+ *
+ * <p>
+ *    <strong>Permission note!</strong> Current user must have
+ *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+ *    on the wrapped collaboration group.
+ * </p>
+ *
+ * <p>
+ *    <em>
+ *       Note! This method sets the Locale on the <code>sv:collaborationGroupPage</code> where the wrapped collaboration group resides.
+ *       Mutation of Locale will fail if the collaboration group page is locked.
+ *    </em>
+ * </p>Gets the wrapped collaboration group.
+ *
+ * <p>
+ *    <em>Note! This method is equivalent with {@link #unwrap()} if this wrapper is created with a <code>sv:collaborationGroup</code> Node.</em>
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+interface CollaborationGroupWrapper {
+  /**
+   * Gets the admins of the wrapped collaboration group.
+   * @return the admins of the wrapped collaboration group. Never null.
+   */
+  getAdmins(): Set<unknown>;
+
+  /**
+   * Checks if a user identity is admin of the wrapped collaboration group.
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> is admin of the wrapped group, <code>false</code> otherwise
+   */
+  isAdmin(aUserIdentity: Node): boolean;
+
+  /**
+   * Adds a user identity as admin of the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Only non-admins will be added</em>, i.e. a user identity that already is an admin will be ignored.
+   *    Collaboration groups that are <em>inactive/unavailable</em> don't accept any new admins.
+   * </p>
+   *
+   * <p>
+   *    <strong>Permission note!</strong> To add an admin to the wrapped group, current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group.
+   * </p>
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> was added as admin of the wrapped group, <code>false</code> otherwise. <code>false</code> is always returned if <code>aUserIdentity</code> is <code>null</code> or already <em>is</em> admin of the wrapped collaboration group.
+   * @since Sitevision 4.5.4
+   */
+  addAdmin(aUserIdentity: Node): boolean;
+
+  /**
+   * Gets the members of the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Note!</em> Admins are also considered as members.
+   * </p>
+   * @return the members of the wrapped collaboration group. Never null.
+   */
+  getMembers(): Set<unknown>;
+
+  /**
+   * Checks if a user identity is member of the wrapped collaboration group.
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> is member of the wrapped group, <code>false</code> otherwise
+   */
+  isMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Adds a user identity as member of the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Only non-members will be added</em>, i.e. a user identity that already is a member will be ignored.
+   *    Collaboration groups that are <em>inactive</em> doesn't accept any new members.
+   * </p>
+   *
+   * <p>
+   *    <strong>Permission note!</strong> To add a member to the wrapped group, current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP} on the group -
+   *    or current user must match the given user identity (i.e. "is yourself") and have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
+   * </p>
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> was added as member of the wrapped group, <code>false</code> otherwise. <code>false</code> is always returned if <code>aUserIdentity</code> is <code>null</code> or already <em>are</em> a member (or admin) of the wrapped collaboration group.
+   */
+  addMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Removes a member from the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Only members can be removed</em>, i.e. a user identity that is a non-member will be ignored. Note that an <em>admin</em>
+   *    is also a <em>member</em> so removing a member might in fact also remove an <em>admin</em>, but <em>last admin</em> will never be removed.
+   *    Members can not be removed from collaboration groups that are <em>inactive</em>.
+   * </p>
+   *
+   * <p>
+   *    <strong>Permission note!</strong> To remove group membership for a user identity, current user
+   *    must match the user identity (i.e. "is yourself") - or have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    and {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on the wrapped group.
+   * </p>
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> was removed as member from the wrapped group, <code>false</code> otherwise. <code>false</code> is always returned if <code>aUserIdentity</code> is <code>null</code> or <em>not a member (or admin)</em> or <em>last admin</em> of the wrapped collaboration group.
+   */
+  removeMember(aUserIdentity: Node): boolean;
+
+  /**
+   * Gets the followers/eavesdroppers of the wrapped collaboration group.
+   * @return the followers of the wrapped collaboration group. Never null.
+   * @since Sitevision 4.1
+   */
+  getFollowers(): Set<unknown>;
+
+  /**
+   * Checks if a user identity is a follower/eavesdropper of the wrapped collaboration group.
+   * @param aUserIdentity a user identity (or user)
+   * @return <code>true</code> if <code>aUserIdentity</code> is a follower of the wrapped group, <code>false</code> otherwise
+   * @since Sitevision 4.1
+   */
+  isFollower(aUserIdentity: Node): boolean;
+
+  /**
+   * Alters the name of the wrapped collaboration group.
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group.
+   * </p>
+   *
+   * <p>
+   *    <em>Name note!</em> Each group name must be (case-insensitively) unique in a given structure (i.e. collaboration group folder).
+   *    This method will remove leading and trailing whitespace from <code>aGroupName</code> and use the remaining characters
+   *    as new name. The wrapped group will <em>not</em> be renamed if <code>aGroupName</code> is <code>null</code>, whitespace only or if
+   *    the remaining characters already exist as group name.
+   * </p>
+   *
+   * <p>
+   *    <em>Tip!</em> Use {@link CollaborationGroupFolderUtil#containsCollaborationGroup(javax.jcr.Node, String)}
+   *    to check if a named collaboration group already exists in the collaboration group folder of the group.
+   * </p>
+   * @param aGroupName the new group name
+   * @return <code>true</code> if group could be renamed to <code>aGroupName</code>, <code>false</code> otherwise.
+   * @since Sitevision 3.6.4
+   */
+  renameGroup(aGroupName: string): boolean;
+
+  /**
+   * Gets the collaboration group type of the wrapped collaboration group.
+   * @return the collaboration group type
+   * @since Sitevision 4.1
+   */
+  getGroupType(): CollaborationGroupType;
+
+  /**
+   * Changes the collaboration group type of the wrapped collaboration group.
+   *
+   * <p>
+   *    The group type can not be changed for collaboration groups that are <em>inactive</em>.
+   * </p>
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group in order to change group type. In order to change group type to
+   *    {@link CollaborationGroupType#CLOSED},
+   *    current user must also have {@link senselogic.sitevision.api.security.PermissionUtil.Permission#CREATE_CLOSED_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group.
+   * </p>
+   * @param aCollaborationGroupType the collaboration group type
+   * @since Sitevision 4.1
+   */
+  setGroupType(aCollaborationGroupType: CollaborationGroupType): void;
+
+  /**
+   * Gets the collaboration group state of the wrapped collaboration group.
+   * @return the collaboration group state
+   * @since Sitevision 4.1
+   */
+  getGroupState(): CollaborationGroupState;
+
+  /**
+   * Changes the collaboration group state of the wrapped collaboration group.
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group in order to change group state.
+   * </p>
+   * @param aCollaborationGroupState the collaboration group state
+   * @since Sitevision 4.1
+   */
+  setGroupState(aCollaborationGroupState: CollaborationGroupState): void;
+
+  /**
+   * Gets the group description of the wrapped collaboration group.
+   * @return the collaboration group description
+   * @since Sitevision 4.5.3
+   */
+  getGroupDescription(): string;
+
+  /**
+   * Sets the group description of the wrapped collaboration group.
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group in order to change group description.
+   * </p>
+   * @param aGroupDescription the collaboration group description
+   * @since Sitevision 4.5.3
+   */
+  setGroupDescription(aGroupDescription: string): void;
+
+  /**
+   * Gets the profile images folder of the wrapped collaboration group.
+   * @return the profile images folder or null
+   * @since Sitevision 4.5.3
+   */
+  getProfileImagesFolder(): Node;
+
+  /**
+   * Gets the profile image of the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Note!</em> This method returns the 'raw' profile image (i.e. a Node of type <code>sv:image</code>)
+   *    that the group has uploaded. For buddy icons, see {@link senselogic.sitevision.api.render.BuddyIconRenderer}.
+   * </p>
+   * @return the profile image or null
+   * @since Sitevision 4.5.3
+   */
+  getProfileImage(): Node;
+
+  /**
+   * Sets the profile image of the wrapped collaboration group.
+   *
+   * <p>
+   *    This method <em>sets</em> the active profile image, i.e. determines which profile image that should be used.
+   *    To <em>create a new</em> profile image (i.e. new binary data), you would typically use
+   *    a method in {@link senselogic.sitevision.api.webresource.ImageUtil} first.
+   * </p>
+   *
+   * <p>
+   *    <strong>Model note!</strong> A profile image must be a Node of type <code>sv:image</code>
+   *    and a child of the <em>profile images folder</em> of the wrapped collaboration group.
+   *    The profile images folder is available via {@link #getProfileImagesFolder()}.
+   * </p>
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group in order to set the profile image.
+   * </p>
+   * @param aProfileImage the profile image
+   * @return <code>true</code> if the set operation succeeded, <code>false</code> otherwise
+   * @since Sitevision 4.5.3
+   */
+  setProfileImage(aProfileImage: Node): boolean;
+
+  /**
+   * Alters the render Locale used by the wrapped collaboration group.
+   *
+   * <p>
+   *    <strong>Permission note!</strong> Current user must have
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#MANAGE_COLLABORATION_GROUP}
+   *    on the wrapped collaboration group.
+   * </p>
+   *
+   * <p>
+   *    <em>
+   *       Note! This method sets the Locale on the <code>sv:collaborationGroupPage</code> where the wrapped collaboration group resides.
+   *       Mutation of Locale will fail if the collaboration group page is locked.
+   *    </em>
+   * </p>
+   * @param aLocale the Locale, must be a supported/available Locale (as of {@link senselogic.sitevision.api.i18n.LocaleUtil#getAvailableLocales()})
+   * @return true if the set operation succeeded, false otherwise
+   * @since Sitevision 6.1
+   */
+  setLocale(aLocale: unknown): boolean;
+
+  /**
+   * Gets the wrapped collaboration group.
+   *
+   * <p>
+   *    <em>Note! This method is equivalent with {@link #unwrap()} if this wrapper is created with a <code>sv:collaborationGroup</code> Node.</em>
+   * </p>
+   * @return the wrapped collaboration group
+   * @since Sitevision 4.3
+   */
+  getCollaborationGroup(): Node;
+}
+
+export default CollaborationGroupWrapper;