@sitevision/api 2.0.0-alpha.0 → 2.0.0-alpha.1

package/hidden/senselogic/sitevision/api/webresource/PageUtil/index.d.ts

@@ -1,216 +0,0 @@
-import Node from "../../../../../javax/jcr/Node";
-
-/**
- * Page utility interface that handles nodes with primary node type <code>sv:page</code>.
- *
- * <p>
- *    <em>Note!</em> This interface is used to <em>create</em> and <em>update</em> pages. You would typically use
- *    {@link senselogic.sitevision.api.webresource.structure.StructureUtil} to <em>move</em> a page
- *    and {@link senselogic.sitevision.api.webresource.structure.TrashcanUtil} to <em>delete</em> a page.
- *    {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil} can be used to update the <em>content</em>
- *    of a page.
- * </p>
- *
- * <p>
- *    <strong>Important note!</strong> Methods in this interface operates in the
- *    {@link senselogic.sitevision.api.versioning.VersionUtil#OFFLINE_VERSION}.
- *    Hence, if you create a page, updates the name of a page or such, the page 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>
- *    An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getPageUtil()}.
- *    See {@link senselogic.sitevision.api.Utils} for how to obtain an instance of the <code>Utils</code> interface.
- * </p>Name of the property specifying if a page is visible in menus. It corresponds to the sv:page property <code>visibleInMenus</code>.
- * <p>The property value must be of type <code>Boolean</code>.</p>Name of the property specifying the title of a page. It corresponds to the sv:page property <code>title</code>.
- * <p>The property value must be of type <code>String</code>.</p>Name of the property specifying the short id for a page. It corresponds to the sv:page property <code>shortId</code>.
- * <p>The property value must be of type <code>String</code>.</p>Name of the property specifying locale used by the page. It corresponds to the sv:page property <code>locale</code>.
- * <p>
- *    The property value must be of type <code>Locale</code> or a <code>String</code> that can be resolved to a non-null Locale
- *    via {@link senselogic.sitevision.api.i18n.LocaleUtil#getLocaleByString(String)}.
- * </p>Name of the property specifying if the page is indexable. It corresponds to the sv:page property <code>robotsIndex</code>.
- * <p>The property value must be of type <code>Boolean</code>.</p>Name of the property specifying the creation date of the page. It corresponds to the sv:page property <code>creationDate</code>.
- * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss where
- * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the creator of the page. It corresponds to the sv:page property <code>createdBy</code>.
- * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>Name of the property specifying the last modified date of the page. It corresponds to the sv:page property <code>lastModifiedDate</code>.
- * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss where
- * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the last modifier of the page. It corresponds to the sv:page property <code>lastModifiedBy</code>.
- * <p>The property value must be of type {@link javax.jcr.Node} of type sv:user or sv:systemUser.</p>Name of the property specifying the last published date of a page. It corresponds to the sv:page property <code>lastPublishDate</code>.
- * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss, where
- * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the last publisher of a page. It corresponds to the sv:page property <code>lastPublishedBy</code>.
- * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>Name of the property specifying the published date of a page. It corresponds to the sv:page property <code>publishDate</code>.
- * <p>The property value must be of type <code>Date</code> or a <code>String</code> on format yyyy-MM-dd HH:mm:ss, where
- * HH:mm:ss is optional (defaults to 00:00:00).</p>Name of the property specifying the publisher of a page. It corresponds to the sv:page property <code>publishedBy</code>.
- * <p>The property value must be a {@link javax.jcr.Node} with primary node type sv:user or sv:systemUser.</p>
- * @author Mikael Wikblom
- * @since Sitevision 2.6.2
- * @since Sitevision 3.5.3
- * @since Sitevision 3.5.3
- * @since Sitevision 3.5.3
- * @since Sitevision 3.5.3
- */
-
-interface PageUtil {
-  /**
-   * <p>
-   *    Creates a page as sub node to the specified parent.
-   * </p>
-   * <p>
-   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article} or a
-   *    {@code sv:collaborationGroupPage}.
-   *    If other parent is specified a <code>ConstraintViolationException</code> is thrown.
-   * </p>
-   *
-   * <p>Any name can be given a page, it should however not contain the character '/'.</p>
-   *
-   * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
-   *
-   * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
-   *
-   * <p>Note that a new page inherits metadata and permissions from its parent.</p>
-   *
-   * <p>Use {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil#updateContent(javax.jcr.Node, java.util.Map)}
-   * to add content to the new page.</p>
-   * @param aParent the parent node of the page. May not be <code>null</code>
-   * @param aTemplate the template used for the page. May not be <code>null</code>
-   * @param aName the name of the sv:page. May not be <code>null</code>
-   * @return a sv:page node corresponding to the newly created page. Will never return <code>null</code>
-   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create a page
-   * @throws RepositoryException if something else goes wrong
-   * @see #createPage(javax.jcr.Node, javax.jcr.Node, String, java.util.Map, java.util.Map)
-   */
-  createPage(aParent: Node, aTemplate: Node, aName: java.lang.String): Node;
-
-  /**
-   * <p>
-   *    Creates a page with properties and web content.
-   * </p>
-   * <p>
-   *    The parent may be either a {@code sv:sitePage}, {@code sv:page}, {@code sv:folder}, {@code sv:article}
-   *    or a {@code sv:collaborationGroupPage}.
-   *    If other parent is specified a <code>ConstraintViolationException</code> is thrown.
-   *    It is possible to provide the web content for the page as well as page properties.
-   * </p>
-   * <p>Properties:</p>
-   * <ul>
-   *    <li>{@link #PROPERTY_VISIBLE_IN_MENUS}</li>
-   *    <li>{@link #PROPERTY_TITLE}</li>
-   *    <li>
-   *       {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
-   *    </li>
-   *    <li>{@link #PROPERTY_LOCALE}</li>
-   *    <li>{@link #PROPERTY_ROBOTS_INDEX}</li>
-   *    <li>{@link #PROPERTY_CREATION_DATE}</li>
-   *    <li>{@link #PROPERTY_CREATED_BY}</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_DATE}</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_BY}</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISH_DATE}</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISHED_BY}</li>
-   *    <li>{@link #PROPERTY_PUBLISH_DATE}</li>
-   *    <li>{@link #PROPERTY_PUBLISHED_BY}</li>
-   * </ul>
-   * <p>If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown</p>
-   *
-   * <p>Default values:</p>
-   * <ul>
-   *    <li>{@link #PROPERTY_VISIBLE_IN_MENUS} - true</li>
-   *    <li>{@link #PROPERTY_TITLE} - ""</li>
-   *    <li>{@link #PROPERTY_SHORTID} - "" (a short id will be generated by Sitevision)</li>
-   *    <li>{@link #PROPERTY_LOCALE} - parent locale</li>
-   *    <li>{@link #PROPERTY_ROBOTS_INDEX} - true</li>
-   *    <li>{@link #PROPERTY_CREATION_DATE} - current time stamp</li>
-   *    <li>{@link #PROPERTY_CREATED_BY} - current user</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_DATE} - current time stamp</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_BY} - current user</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISH_DATE} - null (will not have a value)</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISHED_BY} - null (will not have a value)</li>
-   *    <li>{@link #PROPERTY_PUBLISH_DATE} - null (will not have a value)</li>
-   *    <li>{@link #PROPERTY_PUBLISHED_BY} - null (will not have a value)</li>
-   * </ul>
-   *
-   * <p>The page content is specified using the
-   * content map containing keys corresponding to layout names (e.g. "mittenspalt") on the page and values containing the
-   * HTML used to generate a portlet structure in the layout. The provided content is converted to
-   * Sitevision text, table and image modules. It is also possible to specify that a horizontal or a vertical
-   * layout should be created. For more information about the HTML to portlet mapping can be found in the
-   * {@link senselogic.sitevision.api.webresource.webcontent.WebContentUtil} javadoc.
-   *
-   * <p>Any name can be given a page, it should however not contain the character '/'.</p>
-   *
-   * <p>If no parent, no template or no name is specified a <code>NullPointerException</code> is thrown.</p>
-   *
-   * <p>The current user must be authorized to create pages, layouts and to do write operations on the parent node or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
-   *
-   * <p>Note that a new page inherits metadata and permissions from its parent.</p>
-   * @param aParent the parent node of the page. May not be <code>null</code>
-   * @param aTemplate the sv:template node to be used for the page. May not be <code>null</code>
-   * @param aName the name of the sv:page. May not be <code>null</code>
-   * @param properties the page properties. May be <code>null</code>
-   * @param content a map containing the HTML content. The keys must correspond to layout names on the node. May be <code>null</code>
-   * @return a sv:page node corresponding to the newly created page. Will never return <code>null</code>
-   * @throws ConstraintViolationException if an invalid parent is specified or if the current user is not authorized to create the page
-   * @throws RepositoryException if something else goes wrong
-   * @see #createPage(javax.jcr.Node, javax.jcr.Node, String)
-   */
-  createPage(
-    aParent: Node,
-    aTemplate: Node,
-    aName: java.lang.String,
-    properties: java.util.Map,
-    content: java.util.Map
-  ): Node;
-
-  /**
-   * <p>Updates the properties of a page. If no page is specified a <code>NullPointerException</code>
-   * is thrown. If the node is not a sv:page an <code>IllegalArgumentException</code> is thrown.</p>
-   *
-   * <p>Properties:</p>
-   * <ul>
-   *    <li>{@link #PROPERTY_VISIBLE_IN_MENUS}</li>
-   *    <li>{@link #PROPERTY_TITLE}</li>
-   *    <li>
-   *       {@link #PROPERTY_SHORTID} - If the short id is already used by an other Sitevision node an <code>IllegalArgumentException</code> is thrown
-   *    </li>
-   *    <li>{@link #PROPERTY_LOCALE}</li>
-   *    <li>{@link #PROPERTY_ROBOTS_INDEX}</li>
-   *    <li>{@link #PROPERTY_CREATION_DATE}</li>
-   *    <li>{@link #PROPERTY_CREATED_BY}</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_DATE}</li>
-   *    <li>{@link #PROPERTY_LAST_MODIFIED_BY}</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISH_DATE}</li>
-   *    <li>{@link #PROPERTY_LAST_PUBLISHED_BY}</li>
-   *    <li>{@link #PROPERTY_PUBLISH_DATE}</li>
-   *    <li>{@link #PROPERTY_PUBLISHED_BY}</li>
-   * </ul>
-   * <p>If an invalid value is provided for a property, an <code>IllegalArgumentException</code> is thrown.</p>
-   *
-   * <p>The current user must be authorized to do write operations on the page or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
-   *
-   * <p>If no properties map is specified a <code>NullPointerException</code> is thrown.</p>
-   * @param aPage the sv:page that will be altered. May not be <code>null</code>
-   * @param properties the page properties. May not be <code>null</code>
-   * @throws ConstraintViolationException if the current user is not authorized to alter the page
-   * @throws RepositoryException if something else goes wrong
-   */
-  updatePage(aPage: Node, properties: java.util.Map): void;
-
-  /**
-   * <p>Alters the name of a page. If no page is specified a <code>NullPointerException</code>
-   * is thrown. If the node is not a sv:page an <code>IllegalArgumentException</code> is thrown.</p>
-   *
-   * <p>Any name can be given a page, it should however not contain the character '/'. If <code>null</code> is
-   * provided a <code>NullPointerException</code> is thrown.</p>
-   *
-   * <p>The current user must be authorized to do write operations on the page or
-   * a <code>ConstraintViolationException</code> will be thrown.</p>
-   * @param aPage the page that should be renamed. May not be <code>null</code>
-   * @param aName the new name of the page. May not be <code>null</code>
-   * @throws ConstraintViolationException if the current user is not authorized to alter the name of the page
-   * @throws RepositoryException if something else goes wrong
-   */
-  renamePage(aPage: Node, aName: java.lang.String): void;
-}

package/hidden/senselogic/sitevision/api/webresource/WebResourceFactory/index.d.ts

@@ -1,56 +0,0 @@
-import ArticleUtil from "../ArticleUtil";
-import FileUtil from "../FileUtil";
-import ImageUtil from "../ImageUtil";
-import LinkPageUtil from "../LinkPageUtil";
-import LinkTargetBuilder from "../builder/LinkTargetBuilder";
-import PageUtil from "../PageUtil";
-
-/**
- * Factory for creating instances of web resource utilities.
- *
- * <p>
- *    An instance of the Sitevision class implementing this interface can be obtained via
- *    {@link senselogic.sitevision.api.Utils#getWebResourceFactory()}.
- *    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
- */
-
-interface WebResourceFactory {
-  /**
-   * Gets an instance of an article utility class
-   * @return an article utility class
-   */
-  getArticleUtil(): ArticleUtil;
-
-  /**
-   * Gets an instance of a file utility class
-   * @return a file utility class
-   */
-  getFileUtil(): FileUtil;
-
-  /**
-   * Gets an instance of an image utility class
-   * @return an image utility class
-   */
-  getImageUtil(): ImageUtil;
-
-  /**
-   * Gets an instance of a link page utility class.
-   * @return an instance of a link page utility class
-   */
-  getLinkPageUtil(): LinkPageUtil;
-
-  /**
-   * Gets an instance of a link target builder class.
-   * @return an instance of a link target builder class
-   */
-  getLinkTargetBuilder(): LinkTargetBuilder;
-
-  /**
-   * Gets an instance of a page utility class
-   * @return a page utility class
-   */
-  getPageUtil(): PageUtil;
-}

package/hidden/senselogic/sitevision/api/webresource/builder/LinkTargetBuilder/index.d.ts

@@ -1,128 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-
-import LinkTarget from "../../LinkTarget";
-import Builder from "../../../base/Builder";
-
-/**
- * Builder to create link target instances that can be used to create and update a Link page
- * via {@link senselogic.sitevision.api.webresource.LinkPageUtil}.
- *
- * <p>
- *    LinkTargetBuilder has one <strong>mandatory attribute</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>target</em> - The target. Must be non-null.
- *    </li>
- * </ul>
- * <p>
- *    LinkTargetBuilder also has some <strong>optional attributes</strong>:
- * </p>
- * <ul>
- *    <li>
- *       <em>description</em> - The description. Default is <code>null</code>.
- *    </li>
- *    <li>
- *       <em>open in new window</em> - Whether or not the target should be opened in new window. Default is <code>false</code>.
- *    </li>
- * </ul>
- *
- * <p>
- *    Using the LinkTargetBuilder 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 LinkTargetBuilder</li>
- *   <li>Set the target</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>LinkTarget</code> instance, you can re-use the LinkTargetBuilder to build more instances. Something like:
- * </p>
- * <ol>
- *   <li>Set a new target</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.webresource.WebResourceFactory#getLinkTargetBuilder()}.
- *    See {@link senselogic.sitevision.api.webresource.WebResourceFactory} for how to obtain an instance of the
- *    <code>WebResourceFactory</code> interface.
- * </p>
- * @author Magnus Lövgren
- * @since Sitevision 4.2
- * @see senselogic.sitevision.api.webresource.LinkPageUtil
- */
-
-interface LinkTargetBuilder {
-  /**
-   * 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): LinkTargetBuilder;
-
-  /**
-   * Sets the target.
-   * @param aURL the link target URL
-   * @return this builder
-   * @throws IllegalArgumentException if <code>aURL</code> is <code>null</code> or whitespace only
-   */
-  setExternalTarget(aURL: java.lang.String): LinkTargetBuilder;
-
-  /**
-   * 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): LinkTargetBuilder;
-
-  /**
-   * 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.
-   */
-  setPhoneTarget(aPhoneNumber: java.lang.String): LinkTargetBuilder;
-
-  /**
-   * Sets the description.
-   * @param aDescription the description
-   * @return this builder
-   */
-  setDescription(aDescription: java.lang.String): LinkTargetBuilder;
-
-  /**
-   * Sets open in new window.
-   * @param aOpenInNewWindow whether or not the target should be opened in new window
-   * @return this builder
-   */
-  setOpenInNewWindow(aOpenInNewWindow: boolean): LinkTargetBuilder;
-
-  /**
-   * Creates a LinkTarget instance using current state of this builder.
-   *
-   * <p>
-   *    <em>
-   *       Note! The 'open in new window' state is ignored when creating a LinkTarget with
-   *       a mail or telephone target (these target types can never be opened in a new window).
-   *    </em>
-   * </p>
-   * @return a link target
-   * @throws IllegalStateException if there are no link target.
-   */
-  build(): LinkTarget;
-}

package/hidden/senselogic/sitevision/api/webresource/doctype/DocTypeUtil/index.d.ts

@@ -1,141 +0,0 @@
-import Node from "../../../../../../javax/jcr/Node";
-
-/**
- * A utility interface for checking what DOCTYPE a page uses.
- *
- * <p>
- * An instance of the Sitevision class implementing this interface can be obtained via {@link senselogic.sitevision.api.Utils#getDocTypeUtil()}.
- * 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 3.0
- */
-
-interface DocTypeUtil {
-  /**
-   * Checks if the doctype for current page is HTML 4.01 Transitional or HTML5.
-   * @return <code>true</code> if current page is HTML 4.01 Transitional or HTML5, <code>false</code> otherwise
-   * @see DocType#HTML4_TRANSITIONAL
-   * @see DocType#HTML5
-   */
-  isHtml(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is HTML 4.01 Transitional or HTML5.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is HTML 4.01 Transitional or HTML5, <code>false</code> otherwise
-   * @see DocType#HTML4_TRANSITIONAL
-   * @see DocType#HTML5
-   */
-  isHtml(aPageNode: Node): boolean;
-
-  /**
-   * Checks if the doctype for current page is HTML 4.01 Transitional.
-   * @return <code>true</code> if current page is HTML 4.01 Transitional, <code>false</code> otherwise
-   * @see DocType#HTML4_TRANSITIONAL
-   */
-  isHtml4(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is HTML 4.01 Transitional.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is HTML 4.01 Transitional, <code>false</code> otherwise
-   * @see DocType#HTML4_TRANSITIONAL
-   */
-  isHtml4(aPageNode: Node): boolean;
-
-  /**
-   * Checks if the doctype for current page is HTML5.
-   * @return <code>true</code> if current page is HTML5, <code>false</code> otherwise
-   * @see DocType#HTML5
-   */
-  isHtml5(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is HTML5.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is HTML5, <code>false</code> otherwise
-   * @see DocType#HTML5
-   */
-  isHtml5(aPageNode: Node): boolean;
-
-  /**
-   * Checks if the doctype for current page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
-   * @return <code>true</code> if current page is XHTML 1.0 Transitional or XHTML 1.0 Strict, <code>false</code> otherwise
-   * @see DocType#XHTML1_TRANSITIONAL
-   * @see DocType#XHTML1_STRICT
-   */
-  isXhtml(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is XHTML 1.0 Transitional or XHTML 1.0 Strict.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Transitional or XHTML 1.0 Strict, <code>false</code> otherwise
-   * @see DocType#XHTML1_TRANSITIONAL
-   * @see DocType#XHTML1_STRICT
-   */
-  isXhtml(aPageNode: Node): boolean;
-
-  /**
-   * Checks if the doctype for current page is XHTML 1.0 Transitional.
-   * @return <code>true</code> if current page is XHTML 1.0 Transitional, <code>false</code> otherwise
-   * @see DocType#XHTML1_TRANSITIONAL
-   */
-  isXhtmlTransitional(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is XHTML 1.0 Transitional.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Transitional, <code>false</code> otherwise
-   * @see DocType#XHTML1_TRANSITIONAL
-   */
-  isXhtmlTransitional(aPageNode: Node): boolean;
-
-  /**
-   * Checks if the doctype for current page is XHTML 1.0 Strict.
-   * @return <code>true</code> if current page is XHTML 1.0 Strict, <code>false</code> otherwise
-   * @see DocType#XHTML1_STRICT
-   */
-  isXhtmlStrict(): boolean;
-
-  /**
-   * Checks if the doctype for a certain page is XHTML 1.0 Strict.
-   * @param aPageNode the page tree node to check
-   * @return <code>true</code> if <code>aPageNode</code> is XHTML 1.0 Strict, <code>false</code> otherwise
-   * @see DocType#XHTML1_STRICT
-   */
-  isXhtmlStrict(aPageNode: Node): boolean;
-
-  /**
-   * Gets the doctype for current page.
-   * @return the doctype for current page
-   */
-  getDocType(): DocType;
-
-  /**
-   * Gets the doctype for a certain page.
-   * @param aPageNode the page tree node to get doctype for
-   * @return the doctype for <code>aPageNode</code>
-   */
-  getDocType(aPageNode: Node): DocType;
-
-  /**
-   * Checks if the doctype for current page matches a certain DocType.
-   * @param aDocType the doctype to check against
-   * @return <code>true</code> if the doctype for current page matches <code>aDocType</code>, <code>false</code> otherwise
-   */
-  isDocType(
-    aDocType: senselogic.sitevision.api.webresource.doctype.DocType
-  ): boolean;
-
-  /**
-   * Checks if the doctype for a certain page matches a certain DocType.
-   * @param aPageNode the page tree node to check
-   * @param aDocType the doctype to check against
-   * @return <code>true</code> if the doctype for <code>aPageNode</code> matches <code>aDocType</code>, <code>false</code> otherwise
-   */
-  isDocType(
-    aPageNode: Node,
-    aDocType: senselogic.sitevision.api.webresource.doctype.DocType
-  ): boolean;
-}