@sitevision/api 1.1.0-alpha.2 → 2.0.0-alpha.0

package/hidden/senselogic/sitevision/api/metadata/MetadataUtil/index.d.ts

@@ -0,0 +1,356 @@
+import Node from "../../../../../javax/jcr/Node";
+import Property from "../../../../../javax/jcr/Property";
+
+import LinkValueBuilder from "../builder/LinkValueBuilder";
+import RelatedValueBuilder from "../builder/RelatedValueBuilder";
+
+/**
+ * <p>
+ *    Utility used to handle metadata. Due to the nature of the Sitevision metadata it is not suited to alter the values using JCR
+ *    (i.e. due to inheritance). This utility adds the functionality needed to access and alter metadata.
+ * </p>
+ *
+ * <p>
+ *    Note that any metadata value is available as property on a JCR-node.
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getMetadataUtil()}.
+ *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
+ * </p>
+ * @author Mikael Wikblom
+ * @since Sitevision 2.6.1
+ */
+
+interface MetadataUtil {
+  /**
+   * <p>
+   *    Set a new value to a metadata <code>Property</code> on a <code>Node</code>. The node must
+   *    be of such a type where it is possible to define a metadata value (e.g. page, article, template, file, image)
+   *    or an <code>IllegalArgumentException</code> will be thrown.
+   * </p>
+   * <p>
+   *    <strong>For comprehensive information about supported metadata</strong> see alternate method
+   *    {@link #setMetadataPropertyValue(javax.jcr.Node, String, Object)}.
+   * </p>
+   *
+   * <p>
+   *    <strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+   *    Hence, if you set a metadata value, <code>aNode</code> must be published (see {@link senselogic.sitevision.api.versioning.PublishingUtil})
+   *    to have any effect in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * </p>
+   * @param aNode the <code>Node</code> where the metadata value should be altered. May not be <code>null</code>
+   * @param aProperty the <code>Property</code> that should be altered. May not be <code>null</code>
+   * @param aValue the new value. May not be <code>null</code>
+   * @throws LockException is thrown if the specified is locked for editing (i.e. someone else is currently editing the same node)
+   * @throws RepositoryException if anything goes wrong
+   * @see #setMetadataPropertyValue(javax.jcr.Node, String, Object)
+   */
+  setMetadataPropertyValue(
+    aNode: Node,
+    aProperty: Property,
+    aValue: java.lang.Object
+  ): void;
+
+  /**
+   * <p>
+   *    Set a new value to a metadata <code>Property</code> on a <code>Node</code>. The node must
+   *    be of such a type where it is possible to define a metadata value (e.g. page, article, template, file, image)
+   *    or an <code>IllegalArgumentException</code> will be thrown.
+   * </p>
+   *
+   * <p>This method currently supports alternation of the following metadata types:</p>
+   * <ul>
+   *  <li>
+   *     <strong>text</strong><br>
+   *     The value will be handled as string (i.e. toString).
+   *  </li>
+   *  <li>
+   *     <strong>single alternative</strong><br>
+   *     The value must be a valid alternative, or the metadata definition
+   *     must support 'other' values. If not, an <code>UnsupportedOperationException</code> is
+   *     thrown. The value is handled as a string (i.e. toString).
+   *  </li>
+   *  <li>
+   *     <strong>multiple alternative</strong><br>
+   *     The value must be a valid alternative, or the metadata definition
+   *     must support 'other' values. Any invalid value will be ignored. If no valid alternatives
+   *     are provided an <code>UnsupportedOperationException</code> is thrown. The value is
+   *     a comma separated string of the alternatives. It is also possible to provide a collection
+   *     or an array of strings corresponding to the alternatives.
+   *  </li>
+   *  <li>
+   *     <strong>date</strong><br>
+   *     The value must be a <code>Date</code>, <code>Calendar</code>, <code>Long</code>,
+   *     <code>Integer</code> or <code>Double</code>. If no valid value is provided an
+   *     <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>user</strong><br>
+   *     The value must be a <code>Node</code> (of type sv:user or sv:simpleUser) or an id <code>String</code> to a JCR-node
+   *     corresponding to the designated user. If no valid value is provided an
+   *     <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>directory object</strong><br>
+   *     The value must be a <code>Node</code> (of type sv:user, sv:userGroup or sv:userContainer) or an id <code>String</code> to a JCR-node
+   *     corresponding to the designated directory object. It is also possible to provide a collection, an
+   *     array of such objects or a comma separated list of ids. If no valid value is provided an
+   *     <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>link</strong><br>
+   *     The value must be a {@link senselogic.sitevision.api.metadata.value.LinkValue} <em>(since Sitevision 3.6)</em>,
+   *     a <code>Node</code> or an id <code>String</code> to a JCR-node that can be used as link (e.g. page, article, image, file).
+   *     If no valid value is provided an <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>link to portlet</strong> <em>(since Sitevision 2.6.2)</em><br>
+   *     The value will be handled as string (i.e. toString).
+   *  </li>
+   *  <li>
+   *     <strong>number</strong> <em>(since Sitevision 2.6.2)</em><br>
+   *     The value must be a <code>Number</code> (e.g. <code>Integer</code>, <code>Long</code>, <code>Double</code> etc.)
+   *     or the toString() method of the value must be parseable as an int <em>(i.e. Integer.parseInt(aValue.toString())
+   *     must not throw a NumberFormatException)</em>.
+   *     If no valid value is provided an <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>related</strong> <em>(since Sitevision 3.6)</em><br>
+   *     The value must be a {@link senselogic.sitevision.api.metadata.value.RelatedValue}.
+   *     If no valid value is provided an <code>UnsupportedOperationException</code> is thrown.
+   *  </li>
+   *  <li>
+   *     <strong>single tag</strong> <em>(since Sitevision 7.2)</em><br>
+   *     The value must be a valid tag, or the metadata definition
+   *     must allow custom tags. If not, an <code>UnsupportedOperationException</code> is
+   *     thrown. The value must be of type <code>sv:tag</code> or a tag name as a <code>String</code>.
+   *  </li>
+   *  <li>
+   *     <strong>multiple tags</strong> <em>(since Sitevision 7.2)</em><br>
+   *     The value must be a valid tag, or the metadata definition
+   *     must allow custom tags. Any invalid tags will be ignored. If no valid tags
+   *     are provided an <code>UnsupportedOperationException</code> is thrown. The value is
+   *     a comma separated string of the tag names. Note that tag names provided as a comma separated string must be prefixed with #.
+   *     It is also possible to provide a collection or an array of <code>sv:tag</code> or strings of tag names.
+   *  </li>
+   * </ul>
+   *
+   * <p>
+   *    <strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+   *    Hence, if you set a metadata value, <code>aNode</code> must be published (see {@link senselogic.sitevision.api.versioning.PublishingUtil})
+   *    to have any effect in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * </p>
+   *
+   * <p>
+   *    Throws <code>NullPointerException</code> or <code>IllegalArgumentException</code> if an illegal argument is provided.
+   *    Throws <code>UnsupportedOperationException</code> if an invalid value or metadata property type is specified.
+   *    Throws <code>ConstraintViolationException</code> <em>(i.e. a <code>RepositoryException</code>)</em> if current user
+   *    doesn't have permission to write metadata on the node.
+   * </p>
+   * @param aNode the <code>Node</code> where the metadata value should be altered. May not be <code>null</code>
+   * @param aPropertyName the name of the metadata property that should be altered. May not be <code>null</code>
+   * @param aValue the new value. May not be <code>null</code>
+   * @throws LockException is thrown if the specified node is locked for editing (i.e. someone else is currently editing the same node)
+   * @throws RepositoryException if anything goes wrong
+   * @see #setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)
+   */
+  setMetadataPropertyValue(
+    aNode: Node,
+    aPropertyName: java.lang.String,
+    aValue: java.lang.Object
+  ): void;
+
+  /**
+   * <p>Removes a metadata <code>Property</code> value on a <code>Node</code>. The node must
+   * be of such a type where it is possible to define a metadata value (e.g. page, article, template,
+   * file, image) or an <code>IllegalArgumentException</code> will be thrown.</p>
+   *
+   * <p>
+   *    For comprehensive information, see alternate method
+   *    {@link #removeMetadataPropertyValue(javax.jcr.Node, String) removeMetadataPropertyValue(Node, String)}
+   * </p>.
+   *
+   * <p><strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+   * Hence, if you remove a metadata value, <code>aNode</code> must be published (see {@link senselogic.sitevision.api.versioning.PublishingUtil})
+   * to have any effect in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}</p>
+   * @param aNode the <code>Node</code> where the metadata value should be removed. May not be <code>null</code>
+   * @param aProperty the <code>Property</code> that should be removed. May not be <code>null</code>
+   * @throws RepositoryException if anything goes wrong
+   * @see #removeMetadataPropertyValue(javax.jcr.Node, String)
+   */
+  removeMetadataPropertyValue(aNode: Node, aProperty: Property): void;
+
+  /**
+   * <p>Removes a metadata <code>Property</code> value on a <code>Node</code>. The node must
+   * be of such a type where it is possible to define a metadata value (e.g. page, article, template,
+   * file, image) or an <code>IllegalArgumentException</code> will be thrown.</p>
+   *
+   * <p>Due to the hierarchical nature of the metadata and the inheritance mechanism, a removal of a value
+   * does not necessarily mean that the value is removed (it may then be inherited from a parent node)</p>
+   *
+   * <p>Note that the result of removal of a text metadata on the node where the metadata definition is defined
+   * is not the <code>null</code> value but an empty <code>String</code>. This means that the JCR property will be available after
+   * the removal and contain "" as value.</p>
+   *
+   * <p><strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
+   * Hence, if you remove a metadata value, <code>aNode</code> must be published (see {@link senselogic.sitevision.api.versioning.PublishingUtil})
+   * to have any effect in the {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}</p>
+   *
+   * <p>Throws <code>NullPointerException</code> or <code>IllegalArgumentException</code> if illegal arguments
+   * are used. Throws <code>ConstraintViolationException</code> <em>(i.e. a <code>RepositoryException</code>)</em>
+   * if current user doesn't have permission to write metadata on the node.</p>
+   * @param aNode the <code>Node</code> where the metadata value should be removed. May not be <code>null</code>
+   * @param aPropertyName the name of the metadata property that should be removed. May not be <code>null</code>
+   * @throws RepositoryException if anything goes wrong
+   * @see #removeMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property)
+   */
+  removeMetadataPropertyValue(
+    aNode: Node,
+    aPropertyName: java.lang.String
+  ): void;
+
+  /**
+   * <p>Returns a <code>boolean</code> indicating that the metadata value on the <code>Node</code> is
+   * inherited from a parent node.</p>
+   *
+   * <p>Note that this method returns <code>true</code> when the metadata definition is defined on the
+   * <code>Node</code> and the value is <code>null</code></p>
+   *
+   * <p><strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}</p>
+   * @param aNode the <code>Node</code> that contains the metadata value. May not be <code>null</code>
+   * @param aProperty the metadata <code>Property</code> that should be queried. May not be <code>null</code>
+   * @return a <code>boolean</code> indicating the inheritance
+   * @throws RepositoryException if anything goes wrong
+   * @see #isMetadataValueInherited(javax.jcr.Node, javax.jcr.Property, int)
+   */
+  isMetadataValueInherited(aNode: Node, aProperty: Property): boolean;
+
+  /**
+   * <p>Returns a <code>boolean</code> indicating that the metadata value in a specified version on the <code>Node</code> is
+   * inherited from a parent node.</p>
+   *
+   * <p>Note that this method returns <code>true</code> when the metadata definition is defined on the
+   * <code>Node</code> and the value is <code>null</code></p>
+   * @param aNode the <code>Node</code> that contains the metadata value. May not be <code>null</code>
+   * @param aProperty the metadata <code>Property</code> that should be queried. May not be <code>null</code>
+   * @param aVersion {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION} or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * @return a <code>boolean</code> indicating the inheritance
+   * @throws RepositoryException if anything goes wrong
+   * @since Sitevision 2.6.1_04
+   */
+  isMetadataValueInherited(
+    aNode: Node,
+    aProperty: Property,
+    aVersion: int
+  ): boolean;
+
+  /**
+   * <p>Returns a <code>boolean</code> indicating that the metadata value on the <code>Node</code> is
+   * inherited from a parent node.</p>
+   *
+   * <p>Note that this method returns <code>true</code> when the metadata definition is defined on the
+   * <code>Node</code> and the value is <code>null</code></p>
+   *
+   * <p><strong>Important note!</strong> This method operates in the {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}</p>
+   * @param aNode the <code>Node</code> that contains the metadata value. May not be <code>null</code>
+   * @param aPropertyName the name of the metadata property that should be queried. May not be <code>null</code>
+   * @return a <code>boolean</code> indicating the inheritance
+   * @throws RepositoryException if anything goes wrong
+   * @see #isMetadataValueInherited(javax.jcr.Node, String, int)
+   */
+  isMetadataValueInherited(
+    aNode: Node,
+    aPropertyName: java.lang.String
+  ): boolean;
+
+  /**
+   * <p>Returns a <code>boolean</code> indicating that the metadata value in a specified version on the <code>Node</code> is
+   * inherited from a parent node.</p>
+   *
+   * <p>Note that this method returns <code>true</code> when the metadata definition is defined on the
+   * <code>Node</code> and the value is <code>null</code></p>
+   * @param aNode the <code>Node</code> that contains the metadata value. May not be <code>null</code>
+   * @param aPropertyName the name of the metadata property that should be queried. May not be <code>null</code>
+   * @param aVersion {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION} or {@link senselogic.sitevision.api.versioning.VersionUtil#ONLINE_VERSION}
+   * @return a <code>boolean</code> indicating the inheritance
+   * @throws RepositoryException if anything goes wrong
+   * @since Sitevision 2.6.1_04
+   */
+  isMetadataValueInherited(
+    aNode: Node,
+    aPropertyName: java.lang.String,
+    aVersion: int
+  ): boolean;
+
+  /**
+   * <p>
+   *    Returns a <code>List</code> containing all related metadata values for a specified <code>Node</code>.
+   * </p>
+   *
+   * <p>
+   *    <strong>Important note!</strong> The returned List is not type safe and my contain either a <code>Node</code>
+   *    and/or a <code>String</code> depending on its findings.
+   * </p>
+   * @param aNode the <code>Node</code> that contains the metadata value. May not be <code>null</code>
+   * @param aPropertyName the name of the metadata property that should be queried. May not be <code>null</code>
+   * @return a <code>List</code> containing all related metadata values, or an <code>empty List</code> if no could be found.
+   * @throws NullPointerException if <code>aNode</code> or <code>aPropertyName</code> is <code>null</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is of wrong type (a node that doesn't have metadata).
+   * @throws RepositoryException if anything goes wrong while accessing <code>aNode</code> or extracting the result
+   * @since Sitevision 2.6.2_03
+   */
+  getRelatedMetadataPropertyValues(
+    aNode: Node,
+    aPropertyName: java.lang.String
+  ): unknown[];
+
+  /**
+   * <p>Returns a <code>Node</code> for a link metadata on a specified <code>Node</code>.</p>
+   *
+   * <p><strong>Important note!</strong> The nodes returned by this method are temporary objects and are not part of the
+   * Sitevision model. This means that methods like {@link javax.jcr.Node#getPath()}, {@link javax.jcr.Node#getParent()} and
+   * {@link javax.jcr.Node#getName()} etc. will not return any information.</p>
+   * @param aNode the <code>Node</code> that contains the link metadata value. May not be <code>null</code>
+   * @param aPropertyName the name of the link metadata property that should be queried. May not be <code>null</code>
+   * @return a temporary <code>Node</code> representing the link metadata value, or <code>null</code> if no link could be found.
+   * @throws NullPointerException if <code>aNode</code> or <code>aPropertyName</code> is <code>null</code>.
+   * @throws IllegalArgumentException if <code>aNode</code> is of wrong type (a node that doesn't have metadata).
+   * @throws RepositoryException if anything goes wrong while accessing <code>aNode</code> or extracting the result
+   * @since Sitevision 3.1
+   */
+  getLinkMetadataPropertyValue(
+    aNode: Node,
+    aPropertyName: java.lang.String
+  ): Node;
+
+  /**
+   * <p>
+   *    Returns a link value builder that can be used to build <code>LinkValue</code> instances.
+   * </p>
+   *
+   * <p>
+   *    <strong>Tip!</strong> A <code>LinkValue</code> can be used to set a <em>link metadata</em>
+   *    via {@link #setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+   *    or {@link #setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}.
+   * </p>
+   * @return a link value builder.
+   * @since Sitevision 3.6
+   */
+  getLinkValueBuilder(): LinkValueBuilder;
+
+  /**
+   * <p>
+   *    Returns a related value builder that can be used to build <code>RelatedValue</code> instances.
+   * </p>
+   *
+   * <p>
+   *    <strong>Tip!</strong> A <code>RelatedValue</code> can be used to set a <em>related metadata</em>
+   *    via {@link #setMetadataPropertyValue(javax.jcr.Node, String, Object)}
+   *    or {@link #setMetadataPropertyValue(javax.jcr.Node, javax.jcr.Property, Object)}.
+   * </p>
+   * @return a related value builder.
+   * @since Sitevision 3.6
+   */
+  getRelatedValueBuilder(): RelatedValueBuilder;
+}

package/hidden/senselogic/sitevision/api/metadata/builder/LinkValueBuilder/index.d.ts

@@ -0,0 +1,131 @@
+import Node from "../../../../../../javax/jcr/Node";
+
+import LinkValue from "../../value/LinkValue";
+import Builder from "../../../base/Builder";
+
+/**
+ * Builder to create LinkValue instances that can be used to set link metadata.
+ *
+ * <p>
+ *    LinkValueBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>target</em> - The link target. Must be non-null.
+ *    </li>
+ * </ul>
+ * <p>
+ *    LinkValueBuilder also has some <strong>optional attributes</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>name</em> - The link name. Default is <code>null</code>.
+ *    </li>
+ *    <li>
+ *       <em>description</em> - The Link description. Default is <code>null</code>.
+ *    </li>
+ *    <li>
+ *       <em>open in new window</em> - Whether or not the link should be opened in new window. Default is <code>false</code>.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the LinkValueBuilder 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 LinkValueBuilder</li>
+ *   <li>Set the target</li>
+ *   <li>Possibly set a name</li>
+ *   <li>Possibly set a description</li>
+ *   <li>Possibly set open in new window</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>LinkValue</code> instance, you can re-use the LinkValueBuilder to build more instances. Something like:
+ * </p>
+ * <ol>
+ *   <li>Set a new target</li>
+ *   <li>Possibly set a name</li>
+ *   <li>Possibly set a description</li>
+ *   <li>Possibly set open in new window</li>
+ *   <li>Do build</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *    more information about Builders and how to work with them!
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#getLinkValueBuilder()}.
+ *    See {@link senselogic.sitevision.api.metadata.MetadataUtil} for how to obtain an instance of the <code>MetadataUtil</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+
+interface LinkValueBuilder {
+  /**
+   * Sets the target.
+   * @param anURL the link target URL
+   * @return this builder
+   * @throws IllegalArgumentException if <code>anURL</code> is <code>null</code> or whitespace only
+   */
+  setExternalTarget(anURL: java.lang.String): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aMailAddress a mail address
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aMailAddress</code> is <code>null</code>, whitespace only or an invalid mail address.
+   * @see senselogic.sitevision.api.mail.MailUtil#isValidAddress(String)
+   */
+  setMailTarget(aMailAddress: java.lang.String): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aPhoneNumber a phone number
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aPhoneNumber</code> is <code>null</code>, whitespace only or an invalid phone number.
+   * @since Sitevision 4.2.1
+   */
+  setPhoneTarget(aPhoneNumber: java.lang.String): LinkValueBuilder;
+
+  /**
+   * Sets the target.
+   * @param aNode the target, must be a linkable resource (i.e. a page/article/image/file or such) that isn't trashed.
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aNode</code> is <code>null</code> or not a linkable resource.
+   */
+  setInternalTarget(aNode: Node): LinkValueBuilder;
+
+  /**
+   * Sets the link name.
+   * @param aName the link name
+   * @return this builder
+   */
+  setName(aName: java.lang.String): LinkValueBuilder;
+
+  /**
+   * Sets the link description.
+   * @param aDescription the link description
+   * @return this builder
+   */
+  setDescription(aDescription: java.lang.String): LinkValueBuilder;
+
+  /**
+   * Sets open in new window.
+   * @param aOpenInNewWindow whether or not the link should be opened in new window
+   * @return this builder
+   */
+  setOpenInNewWindow(aOpenInNewWindow: boolean): LinkValueBuilder;
+
+  /**
+   * Creates a LinkValue instance using current state of this builder.
+   * @return a link value
+   * @throws IllegalStateException if there are no link target.
+   */
+  build(): LinkValue;
+}

package/hidden/senselogic/sitevision/api/metadata/builder/RelatedValueBuilder/index.d.ts

@@ -0,0 +1,89 @@
+import LinkValue from "../../value/LinkValue";
+import Node from "../../../../../../javax/jcr/Node";
+
+import RelatedValue from "../../value/RelatedValue";
+import Builder from "../../../base/Builder";
+
+/**
+ * Builder to create RelatedValue instances that can be used to set related metadata.
+ *
+ * <p>
+ *    RelatedValueBuilder has one <strong>mandatory attribute</strong>:
+ * </p>
+ * <ul>
+ *    <li>
+ *       <em>values</em> - The related values. Must be non-empty.
+ *    </li>
+ * </ul>
+ *
+ * <p>
+ *    Using the RelatedValueBuilder 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 RelatedValueBuilder</li>
+ *   <li>Add a value</li>
+ *   <li>Possibly add more values</li>
+ *   <li>Do build</li>
+ * </ol>
+ * <p>
+ *    When you have built a <code>RelatedValue</code> instance, you can re-use the RelatedValueBuilder to build more instances. Something like:
+ * </p>
+ * <ol>
+ *   <li>Clear values</li>
+ *   <li>Add a value</li>
+ *   <li>Possibly add more values</li>
+ *   <li>Do build</li>
+ * </ol>
+ *
+ * <p>
+ *    <strong>Tip!</strong> The {@link senselogic.sitevision.api.base.Builder Builder interface documentation} contains
+ *    more information about Builders and how to work with them!
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.metadata.MetadataUtil#getRelatedValueBuilder()}.
+ *    See {@link senselogic.sitevision.api.metadata.MetadataUtil} for how to obtain an instance of the <code>MetadataUtil</code> interface.
+ * </p>
+ * @author Magnus Lövgren
+ * @since Sitevision 3.6
+ */
+
+interface RelatedValueBuilder {
+  /**
+   * Adds a link value.
+   * @param aLinkValue the link value to add
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aLinkValue</code> is <code>null</code> or not an instance created via {@link senselogic.sitevision.api.metadata.builder.LinkValueBuilder}
+   */
+  addLinkValue(aLinkValue: LinkValue): RelatedValueBuilder;
+
+  /**
+   * Adds a user value.
+   * @param aUserNode the user node to add (a node with primary node type <em>sv:user</em> or <em>sv:simpleUser</em>)
+   * @return this builder
+   * @throws IllegalArgumentException if <code>aUserNode</code> is <code>null</code> or an invalid user node (e.g. sv:systemUser - <em>Anonymous</em>, <em>System</em>, <em>Indexer</em>, <em>Validator</em> or <em>Extractor</em>)
+   */
+  addUser(aUserNode: Node): RelatedValueBuilder;
+
+  /**
+   * Adds a text value.
+   * @param aText the text to add. A <code>null</code> or whitespace-only value will be completely ignored.
+   * @return this builder
+   */
+  addText(aText: java.lang.String): RelatedValueBuilder;
+
+  /**
+   * Removes all currently added values.
+   * @return this builder
+   */
+  clearValues(): RelatedValueBuilder;
+
+  /**
+   * Creates a RelatedValue instance using current state of this builder.
+   * @return a related value
+   * @throws IllegalStateException if the builder contains no values.
+   */
+  build(): RelatedValue;
+}

package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.d.ts

@@ -18,6 +18,8 @@
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.metadata.builder.LinkValueBuilder
  */
-interface LinkValue {}
+interface LinkValue {
+  undefined;
+}
 
 export default LinkValue;

package/hidden/senselogic/sitevision/api/metadata/value/LinkValue/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;

package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.d.ts

@@ -18,6 +18,8 @@
  * @since Sitevision 3.6
  * @see senselogic.sitevision.api.metadata.builder.RelatedValueBuilder
  */
-interface RelatedValue {}
+interface RelatedValue {
+  undefined;
+}
 
 export default RelatedValue;

package/hidden/senselogic/sitevision/api/metadata/value/RelatedValue/index.js

@@ -0,0 +1,8 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports["default"] = void 0;
+var _default = {};
+exports["default"] = _default;