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

package/hidden/senselogic/sitevision/api/resource/TemplateUtil/index.d.ts

@@ -0,0 +1,143 @@
+import Node from "../../../../../javax/jcr/Node";
+
+/**
+ * Template utility interface that primarily handles nodes with primary node type <code>sv:template</code>.
+ *
+ * <p>
+ *    Sitevision templates comes in different flavours:
+ * </p>
+ * <ul>
+ *    <li>
+ *       A <em>page template</em> is a <code>sv:template</code> that can be used to create a page/article.
+ *    </li>
+ *    <li>
+ *       A <em>sub template</em> is a <code>sv:template</code> that can only be used to create other templates.
+ *    </li>
+ *    <li>
+ *       A <em>collaboration group template</em> is a <code>sv:collaborationGroupTemplate</code> that can be used to create collaboration groups.
+ *    </li>
+ * </ul>
+ * <p>
+ *    <em>See method documentation to see what specific flavours each method supports.
+ *    Also see {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil} when working with collaboration group templates.</em>
+ * </p>
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getTemplateUtil()}.
+ *    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_04
+ * @see senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil
+ */
+
+interface TemplateUtil {
+  /**
+   * Gets first found template with a given name.
+   *
+   * <p>
+   *    <strong>Note!</strong> This methods returns the first matching template - regardless of its <em>type/state</em>.
+   *    It might be a <em>collaboration group template</em>, it might be a <em>page template</em> that can be used to create pages/articles of
+   *    and it might be a template that is a <em>sub-template</em> (i.e. a template that only can be used by other templates).
+   * </p>
+   * <ul>
+   *    <li>
+   *       Use {@link #getPageTemplateByName(String)} to get first <em>page template</em>.
+   *    </li>
+   *    <li>
+   *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplateByName(String)}
+   *       to get first <em>collaboration group template</em>.
+   *    </li>
+   * </ul>
+   *
+   * <p>
+   *    <em>Permission note!</em> Only the templates that current user has {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ}
+   *    on will be considered.
+   * </p>
+   * @param aTemplateName the name of the template
+   * @return the template, or <code>null</code> if indeterminable (e.g. no accessible template named <code>aTemplateName</code> could be found)
+   */
+  getTemplateByName(aTemplateName: java.lang.String): Node;
+
+  /**
+   * Gets all templates.
+   *
+   * <p>
+   *    <strong>Note!</strong> This methods returns all templates - regardless of their <em>type/state</em>.
+   *    The result might contain <em>collaboration group templates</em>, it might contain <em>page templates</em> that can be used
+   *    to create pages/articles of and it might contain templates that are <em>sub-templates</em>
+   *    (i.e. templates that only can be used by other templates).
+   * </p>
+   * <ul>
+   *    <li>
+   *       Use {@link #getPageTemplates()} to get all <em>page templates</em>.
+   *    </li>
+   *    <li>
+   *       Use {@link senselogic.sitevision.api.collaboration.CollaborationGroupTemplateUtil#getCollaborationGroupTemplates()}
+   *       to get all <em>collaboration group templates</em>.
+   *    </li>
+   * </ul>
+   *
+   * <p>
+   *    <em>Permission note!</em> The list will only contain page templates that current user has
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+   * </p>
+   * @return all accessible templates, or empty list if there are no accessible page templates.
+   * @since Sitevision 4.1
+   */
+  getTemplates(): unknown[];
+
+  /**
+   * Gets first found page template with a given name.
+   *
+   * <p>
+   *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+   *    It typically contains one or more content areas.
+   * </p>
+   * <p>
+   *    <em>Permission note!</em> Only the page templates that current user has
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on will be considered.
+   * </p>
+   * @param aPageTemplateName the name of the page template
+   * @return the page template, or <code>null</code> if indeterminable (e.g. no accessible page template named <code>aPageTemplateName</code> could be found)
+   * @since Sitevision 4.1
+   */
+  getPageTemplateByName(aPageTemplateName: java.lang.String): Node;
+
+  /**
+   * Gets the page templates.
+   *
+   * <p>
+   *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+   *    It typically contains one or more content areas.
+   * </p>
+   * <p>
+   *    <em>Permission note!</em> The list will only contain page templates that current user has
+   *    {@link senselogic.sitevision.api.security.PermissionUtil.Permission#READ} on.
+   * </p>
+   * @return all accessible templates that can be used to create pages/articles, or empty list if there are no accessible page templates.
+   * @since Sitevision 4.1
+   */
+  getPageTemplates(): unknown[];
+
+  /**
+   * Whether or not a node is a page template.
+   *
+   * <p>
+   *    A <em>page template</em> is a <code>sv:template</code> that can be used to create pages/articles.
+   *    It typically contains one or more content areas.
+   * </p>
+   * @param aTemplate a template
+   * @return true if aTemplate can be used to create pages/articles, false otherwise
+   * @since Sitevision 4.1
+   */
+  isPageTemplate(aTemplate: Node): boolean;
+
+  /**
+   * Gets the names of the content areas in a template.
+   * @param aTemplate a template (sv:template or sv:collaborationGroupTemplate)
+   * @return the names of the content areas in aTemplate, or empty set
+   * @since Sitevision 4.1
+   */
+  getContentAreaNames(aTemplate: Node): Set<unknown>;
+}

package/hidden/senselogic/sitevision/api/script/InstanceTypeUtil/index.d.ts

@@ -0,0 +1,176 @@
+/**
+ * Instance type utility interface.
+ *
+ * <p>
+ *    An instance of the Sitevision class implementing this interface can be obtained via
+ *    {@link senselogic.sitevision.api.Utils#getInstanceTypeUtil()}.
+ *    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 2.6.2
+ */
+
+interface InstanceTypeUtil {
+  /**
+   * Checks if an object is a <code>String</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.String</code> or not.
+   */
+  isString(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Boolean</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Boolean</code> or not.
+   */
+  isBoolean(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is an <code>Integer</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Integer</code> or not.
+   */
+  isInteger(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Long</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Long</code> or not.
+   */
+  isLong(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Double</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Double</code> or not.
+   */
+  isDouble(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Float</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Float</code> or not.
+   */
+  isFloat(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Number</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Number</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isNumber(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Node</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Node}</code> or not.
+   * @see senselogic.sitevision.api.node.NodeTypeUtil
+   */
+  isNode(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Property</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>{@link javax.jcr.Property}</code> or not.
+   */
+  isProperty(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Date</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Date</code> or not.
+   */
+  isDate(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Calendar</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Calendar</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isCalendar(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>List</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.List</code> or not.
+   */
+  isList(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Map</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Map</code> or not.
+   */
+  isMap(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Set</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Set</code> or not.
+   */
+  isSet(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Collection</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Collection</code> or not.
+   */
+  isCollection(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is an <code>Iterator</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.util.Iterator</code> or not.
+   */
+  isIterator(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is an <code>Iterable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Iterable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isIterable(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Serializable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.io.Serializable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isSerializable(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Comparator</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Comparator</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isComparator(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Comparable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Comparable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isComparable(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is an <code>Exception</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Exception</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isException(aObject: java.lang.Object): boolean;
+
+  /**
+   * Checks if an object is a <code>Throwable</code>.
+   * @param aObject the object to be checked
+   * @return whether <code>aObject</code> is a <code>java.lang.Throwable</code> or not.
+   * @since Sitevision 4.2.3
+   */
+  isThrowable(aObject: java.lang.Object): boolean;
+}