Uses of Class okapi.util.OkapiXMLDocument (Stellar Two Jar 2.0-SNAPSHOT API)

Packages that use OkapiXMLDocument
okapi.tools

Methods in okapi.tools with parameters of type OkapiXMLDocument
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody)` Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody); but adds option to exclude content.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent)` Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, false, timezones, firstDateWithContent, lastDateWithContent) but also adds includeCreationDate if creation date of Arc and Content should be included.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent, java.util.SortedSet allDatesWithContent)` Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, includeCreationDate, false, timezones, firstDateWithContent, lastDateWithContent) but also adds allDatesWithContent set.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, boolean includeContent, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent)` Same as addArc(xml, arc, includeContent, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody)` Adds an arc and all of its content and arc children to the xml document.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml)` Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds the body of content atoms as escaped XML even if the body is XML, to facilitate editing of the content atom body.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent)` Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
`static void`	`OkapiToolUtilities.addArc(OkapiXMLDocument xml, OkapiArc arc, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, java.util.List timezones, java.util.Date firstDateWithContent, java.util.Date lastDateWithContent)` Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.
`static void`	`OkapiToolUtilities.addBackInfo(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request)` Adds the href of the refering page, based on the backURL parameter of the referer head if the parameter is not set.
`static void`	`OkapiToolUtilities.addBasicSubjectInfo(OkapiXMLDocument xml, OkapiNexus nexus)` Adds basic subject info with no enclosing tags to the xml document, to be used when additional elements are needed so addSubjectInfo() cannot be used.
`static void`	`OkapiToolUtilities.addBasicSubjectInfo(OkapiXMLDocument xml, OkapiNexus nexus, boolean omitDescription)` Adds basic subject info with no enclosing tags to the xml document, to be used when additional elements are needed so addSubjectInfo() cannot be used.
`static void`	`OkapiToolUtilities.addBasicUserInfo(OkapiXMLDocument xml, OkapiUser user)` Adds basic user info with no enclosing tags to the xml dcoument, to be used when additional elements are needed so addUserInfo() cannot be used.
`static void`	`OkapiToolUtilities.addContent(OkapiXMLDocument xml, OkapiContent content, java.lang.String pathToParent, java.lang.String pathSegment, OkapiUser user, boolean includeBody, boolean includeBodyEscapedXml, boolean includeCreationDate)` Adds a content and its children and atoms to the xml document.
`static void`	`OkapiToolUtilities.addCrumbsAndNexusHref(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request, java.util.List nexusHistory, java.lang.String toolName)` Adds a full breadCrumbTrail element and a nexusHref element to the xml document.
`static void`	`OkapiToolUtilities.addCrumbsAndNexusHrefWithSublist(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request, java.util.List nexusHistory, java.util.List toolHistory, java.lang.String toolName)` Adds a full breadCrumbTrail element and a nexusHref element to the xml document.
`static void`	`OkapiToolUtilities.addDateTag(OkapiXMLDocument xml, java.util.Date date)` Adds a date tag to the xml document for the specified date.
`protected static void`	`OkapiShowHelpM.addHelpArcs(OkapiXMLDocument xml, OkapiNexus thisNexus, java.lang.String mode, OkapiUser user, java.util.List nexusHistory, boolean includeBodyEscapedXml)`
`protected static void`	`OkapiHwIndexM.addHomeworkCrumbs(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request, java.util.List nexusHistory, java.util.List homeworkNameHistory, java.util.List homeworkHrefHistory, java.lang.String toolName, OkapiNexus thisNexus)`
`protected static void`	`OkapiHwIndexM.addHomeworkCrumbs(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request, java.util.List nexusHistory, java.lang.String toolName, OkapiNexus thisNexus)`
`static java.lang.String`	`OkapiToolUtilities.addNexusCrumbs(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request, java.util.List nexusHistory)` Adds crumbs elements for all the nexuses in the nexusHistory with no enclosing tag, to be used when addCrumbsAndNexusHref() does not provide the necessary complete breadcrumb trail.
`static void`	`OkapiToolUtilities.addPageIntroText(OkapiXMLDocument xml, OkapiNexus thisNexus, java.lang.String pageName)` Method addPageIntroText
`static void`	`OkapiToolUtilities.addRequestParameters(OkapiXMLDocument xml, javax.servlet.http.HttpServletRequest request)` Also adds all request parameters to the XML.
`static void`	`OkapiToolUtilities.addSubjectInfo(OkapiXMLDocument xml, OkapiNexus nexus)` Adds a subject tag to the xml document containing basic subject data provided by addBasicSubjectInfo().
`static void`	`OkapiToolUtilities.addSubjectInfoAndSections(OkapiXMLDocument xml, OkapiNexus nexus)` Adds a subject tag to the xml document containing all the data from addSubjectInfo() with additional elements for the sections in this nexus and its children.
`static void`	`OkapiToolUtilities.addSubjectInfoAndSections(OkapiXMLDocument xml, OkapiNexus nexus, boolean includeDecativatedSections)` Adds a subject tag to the xml document containing all the data from addSubjectInfo() with additional elements for the sections in this nexus and its children.
`static void`	`OkapiToolUtilities.addUserEReservesAccess(OkapiXMLDocument xml, OkapiUser user, OkapiNexus thisNexus)` Add EReserves, or generally third-party, fair-use copyright material access tags.
`static void`	`OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user)` Adds a user tag to the xml document containing basic user data provided by addBasicUserInfo().
`static void`	`OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user, boolean canModify, boolean showToolset)` Same as addUserInfo(xml, user) but adds additional canModify and showToolset elements.
`static void`	`OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml, OkapiUser user, boolean canModify, boolean hasModify, boolean showToolset)` Same as addUserInfo(xml, user) but adds additional canModify, hasModify, and showToolset elements.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       boolean includeContent,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody)

Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody); but adds option to exclude content.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       boolean includeContent,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       boolean includeBodyEscapedXml,
       boolean includeCreationDate,
       java.util.List timezones,
       java.util.Date firstDateWithContent,
       java.util.Date lastDateWithContent)

Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, false, timezones, firstDateWithContent, lastDateWithContent) but also adds includeCreationDate if creation date of Arc and Content should be included.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       boolean includeContent,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       boolean includeBodyEscapedXml,
       boolean includeCreationDate,
       java.util.List timezones,
       java.util.Date firstDateWithContent,
       java.util.Date lastDateWithContent,
       java.util.SortedSet allDatesWithContent)

Same as addArc(xml, arc, true, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml, includeCreationDate, false, timezones, firstDateWithContent, lastDateWithContent) but also adds allDatesWithContent set.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       boolean includeContent,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       boolean includeBodyEscapedXml,
       java.util.List timezones,
       java.util.Date firstDateWithContent,
       java.util.Date lastDateWithContent)

Same as addArc(xml, arc, includeContent, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody)

Adds an arc and all of its content and arc children to the xml document.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       boolean includeBodyEscapedXml)

Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds the body of content atoms as escaped XML even if the body is XML, to facilitate editing of the content atom body.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       boolean includeBodyEscapedXml,
       java.util.List timezones,
       java.util.Date firstDateWithContent,
       java.util.Date lastDateWithContent)

Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody, includeBodyEscapedXml) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.

static void

OkapiToolUtilities.addArc(OkapiXMLDocument xml,
       OkapiArc arc,
       java.lang.String pathToParent,
       java.lang.String pathSegment,
       OkapiUser user,
       boolean includeBody,
       java.util.List timezones,
       java.util.Date firstDateWithContent,
       java.util.Date lastDateWithContent)

Same as addArc(xml, arc, pathToParent, pathSegment, user, includeBody) but also adds onDateZoned elements for each arc based on the list of timezones and sets firstDateWithContent and lastDateWithContent to the first and last start dates of the arc and its children, for use in calendar tools.

static void

OkapiToolUtilities.addBackInfo(OkapiXMLDocument xml,
            javax.servlet.http.HttpServletRequest request)

Adds the href of the refering page, based on the backURL parameter of the referer head if the parameter is not set.

static void

OkapiToolUtilities.addBasicSubjectInfo(OkapiXMLDocument xml,
                    OkapiNexus nexus)

Adds basic subject info with no enclosing tags to the xml document, to be used when additional elements are needed so addSubjectInfo() cannot be used.

static void

OkapiToolUtilities.addBasicSubjectInfo(OkapiXMLDocument xml,
                    OkapiNexus nexus,
                    boolean omitDescription)

Adds basic subject info with no enclosing tags to the xml document, to be used when additional elements are needed so addSubjectInfo() cannot be used.

static void

OkapiToolUtilities.addBasicUserInfo(OkapiXMLDocument xml,
                 OkapiUser user)

Adds basic user info with no enclosing tags to the xml dcoument, to be used when additional elements are needed so addUserInfo() cannot be used.

static void

OkapiToolUtilities.addContent(OkapiXMLDocument xml,
           OkapiContent content,
           java.lang.String pathToParent,
           java.lang.String pathSegment,
           OkapiUser user,
           boolean includeBody,
           boolean includeBodyEscapedXml,
           boolean includeCreationDate)

Adds a content and its children and atoms to the xml document.

static void

OkapiToolUtilities.addCrumbsAndNexusHref(OkapiXMLDocument xml,
                      javax.servlet.http.HttpServletRequest request,
                      java.util.List nexusHistory,
                      java.lang.String toolName)

Adds a full breadCrumbTrail element and a nexusHref element to the xml document.

static void

OkapiToolUtilities.addCrumbsAndNexusHrefWithSublist(OkapiXMLDocument xml,
                                 javax.servlet.http.HttpServletRequest request,
                                 java.util.List nexusHistory,
                                 java.util.List toolHistory,
                                 java.lang.String toolName)

Adds a full breadCrumbTrail element and a nexusHref element to the xml document.

static void

OkapiToolUtilities.addDateTag(OkapiXMLDocument xml,
           java.util.Date date)

Adds a date tag to the xml document for the specified date.

protected static void

OkapiShowHelpM.addHelpArcs(OkapiXMLDocument xml,
            OkapiNexus thisNexus,
            java.lang.String mode,
            OkapiUser user,
            java.util.List nexusHistory,
            boolean includeBodyEscapedXml)

protected static void

OkapiHwIndexM.addHomeworkCrumbs(OkapiXMLDocument xml,
                  javax.servlet.http.HttpServletRequest request,
                  java.util.List nexusHistory,
                  java.util.List homeworkNameHistory,
                  java.util.List homeworkHrefHistory,
                  java.lang.String toolName,
                  OkapiNexus thisNexus)

protected static void

OkapiHwIndexM.addHomeworkCrumbs(OkapiXMLDocument xml,
                  javax.servlet.http.HttpServletRequest request,
                  java.util.List nexusHistory,
                  java.lang.String toolName,
                  OkapiNexus thisNexus)

static java.lang.String

OkapiToolUtilities.addNexusCrumbs(OkapiXMLDocument xml,
               javax.servlet.http.HttpServletRequest request,
               java.util.List nexusHistory)

Adds crumbs elements for all the nexuses in the nexusHistory with no enclosing tag, to be used when addCrumbsAndNexusHref() does not provide the necessary complete breadcrumb trail.

static void

OkapiToolUtilities.addPageIntroText(OkapiXMLDocument xml,
                 OkapiNexus thisNexus,
                 java.lang.String pageName)

Method addPageIntroText

static void

OkapiToolUtilities.addRequestParameters(OkapiXMLDocument xml,
                     javax.servlet.http.HttpServletRequest request)

Also adds all request parameters to the XML.

static void

OkapiToolUtilities.addSubjectInfo(OkapiXMLDocument xml,
               OkapiNexus nexus)

Adds a subject tag to the xml document containing basic subject data provided by addBasicSubjectInfo().

static void

OkapiToolUtilities.addSubjectInfoAndSections(OkapiXMLDocument xml,
                          OkapiNexus nexus)

Adds a subject tag to the xml document containing all the data from addSubjectInfo() with additional elements for the sections in this nexus and its children.

static void

OkapiToolUtilities.addSubjectInfoAndSections(OkapiXMLDocument xml,
                          OkapiNexus nexus,
                          boolean includeDecativatedSections)

Adds a subject tag to the xml document containing all the data from addSubjectInfo() with additional elements for the sections in this nexus and its children.

static void

OkapiToolUtilities.addUserEReservesAccess(OkapiXMLDocument xml,
                       OkapiUser user,
                       OkapiNexus thisNexus)

Add EReserves, or generally third-party, fair-use copyright material access tags.

static void

OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml,
            OkapiUser user)

Adds a user tag to the xml document containing basic user data provided by addBasicUserInfo().

static void

OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml,
            OkapiUser user,
            boolean canModify,
            boolean showToolset)

Same as addUserInfo(xml, user) but adds additional canModify and showToolset elements.

static void

OkapiToolUtilities.addUserInfo(OkapiXMLDocument xml,
            OkapiUser user,
            boolean canModify,
            boolean hasModify,
            boolean showToolset)

Same as addUserInfo(xml, user) but adds additional canModify, hasModify, and showToolset elements.

Uses of Classokapi.util.OkapiXMLDocument

Uses of Class
okapi.util.OkapiXMLDocument