|
|||||||||
| Home >> All >> com >> RuntimeCollective >> sitemap >> [ bean overview ] | PREV NEXT | ||||||||
A
- AND_STATUS - Static variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- AlwaysLive - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Is the object always live, thus ignoring GoLive and GoDead dates ?
- AppearInNavbar - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether the nodes should appear in the navbar.
- ArraySize - Static variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The default size of the TextComponent, Image, File and Link arrays
- Author_id - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The author
- addBookmark(int) - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- addBookmark(SiteLocation) - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- addChildNode(SiteNode) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Add a ChildNode to this SiteNode, at the current max position + 1
- addImage(Image) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Add an Image to this ImageCategory.
- addSorted(SiteLocation) - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- Add the given SiteLocation to the bookmarks vector, in the right location (sort by SiteLocation name).
- addSubContent(String, Content) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Add a SubContent to this CSL under a given role, at the current max position + 1
B
- Bookmarks - class com.RuntimeCollective.sitemap.bean.Bookmarks.
- A collection of bookmarked content for a SitemapUser.
- Bookmarks(User) - Constructor for class com.RuntimeCollective.sitemap.bean.Bookmarks
- Make a new Bookmarks object, containing all bookmarks for this particular user
- bookmarks - Variable in class com.RuntimeCollective.sitemap.bean.Bookmarks
C
- ChildrenNodeIds - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The ChildrenNodes
- ColourScheme - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The ColourScheme
- ContentSiteLocation - class com.RuntimeCollective.sitemap.bean.ContentSiteLocation.
- A SiteLocation, which is itself a Content, and which holds other Contents in given roles and positions.
- ContentSiteLocation() - Constructor for class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Construct a new blank ContentSiteLocation, giving it a new unique ID.
- ContentSiteLocation(int) - Constructor for class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get a current ContentSiteLocation from the RuntimeDataSource, given an id.
- CreationDate - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The creation date bean
- checkStillApproved() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- closeTag - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- com.RuntimeCollective.sitemap.bean - package com.RuntimeCollective.sitemap.bean
- The Sitemap module defines the necessary classes to set up and edit the structure of a content library.
- createOrReplaceVersion(String, String) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Create and save a new version of this object based on a existing one, and tag it with the specified tag.
- customiseDuplicate(Duplicable) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The ContentSiteLocation version of this method will duplicate all the SubContents of the original, and assign those copies (and their ExplanatoryText) to the duplicate.
D
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.ImageCategory
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in interface com.RuntimeCollective.sitemap.bean.Publishable
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The name of the database table for this bean type.
- DATABASE_TABLE - Static variable in class com.RuntimeCollective.sitemap.bean.Template
- The name of the database table for this bean type.
- DATABASE_TABLE_FLAT - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The name of the flattened database table for this bean type.
- DOTDOTDOT - Static variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Description - Variable in class com.RuntimeCollective.sitemap.bean.Template
- A text description of this template
- delete() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Delete this bean from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Delete this ImageCategory from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Delete this bean from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Delete this bean from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Delete this SiteLocationLink from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Delete this bean from the database.
- delete() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Delete this bean from the database.
- deleteContent() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Delete content data and do version update.
- deleteFlat() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Delete this bean from the database flat table.
- deleteFromFamily() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Delete this bean from its family.
- deleteLinks() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Delete the Links to this SiteLocation
E
- EMPTY_STRING - Static variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- EMPTY_STRING - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- ESC - Static variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- EditFilename - Variable in class com.RuntimeCollective.sitemap.bean.Template
- The File containing the template used to edit
- ExplanatoryTexts - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The Explanatory Texts: for each SubContent mapping, we can set a description text
G
- GoDeadDate - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- When the object goes dead
- GoLiveDate - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- When the object goes live
- getAllBookmarks() - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- An alternative name for calling "iterator"
- getAllImageCaptions() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Return all the image captions, concatenated together.
- getAllLinkText() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Return all the link text and descriptions, concatenated together.
- getAllTextComponentText() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Return all the text component text, concatenated together.
- getAlwaysLive() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object will be always live
- getAlwaysLive() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object will be always live
- getAppearInNavbar() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get whether the nodes should appear in the navbar.
- getAuthor() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the author
- getBookmarksForUser(User) - Static method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- Get a collection of bookmarks for this user
- getBreadcrumb() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the whole breadcrumb to get to this SiteLocation (in plain text) This is very basic and while be overriden by subclasses.
- getBreadcrumb() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the breadcrumb (plain text) to this SiteLocation
- getBreadcrumb() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the whole breadcrumb to get to this SiteNode (in plain text).
- getBreadcrumb(boolean, boolean, boolean, String) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the whole breadcrumb to get to this SiteNode, either as plain text or as links.
- getBreadcrumbForChild(boolean, boolean, String) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the whole breadcrumb stub up to this SiteLocation (in plain text or html links), so that it can be used by children to build their breadcrumbs.
- getChildNode(int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get one ChildNode from this SiteNode (from its Trunk version, if there is one).
- getChildNode(int, boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get one ChildNode from this SiteNode, using its Trunk version or not.
- getChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the non-archived ChildrenNodes for this SiteNode (from its Trunk version, if there is one).
- getChildrenNodes(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the ChildrenNodes for this SiteNode, with or without the archived ones (from its Trunk version, if there is one),
- getChildrenNodes(boolean, boolean, String) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the ChildrenNodes for this SiteNode, with or without the archived ones (from its Trunk version, if there is one).
- getChildrenNodesAsList() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- getChildrenNodesLength() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- getColourCode() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ColourCode
- getColourCodeOfScheme(int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ColourCode of a ColourScheme
- getColourScheme() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ColourScheme
- getCreationDate() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the creation date
- getDepthInSitemap() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the depth of this SiteNode in the Sitemap, using the Trunk version of the SiteNode.
- getDepthInSitemap(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the depth of this SiteNode in the Sitemap, using or not the trunk version.
- getDescription() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the description
- getDescription() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the description
- getDescription() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the description The description will be extracted from sub-class specific information, for example from the text of the headline.
- getDescription() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the Description
- getEditFilename() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the EditFilename
- getExplanatoryText(String, int) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the ExplanatoryText for this ContentSiteLocation for a given role and position
- getFields() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get a Collection of Strings, for every Field that can be searched for on this object.
- getFields() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get a Collection of Strings, for every Field that can be searched for on this object.
- getFirstLayerNodes() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all non-archived First Layer Nodes
- getFirstLayerNodes(boolean) - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all First Layer Nodes, with/without archived ones
- getFirstLayerNodes(boolean, boolean) - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all First Layer Nodes, with/without archived ones, optionally navbar-viewable only
- getFirstRootNode() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the first Root Node (the one with the smallest id)
- getFullLink(HttpServletRequest) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- This method replaces getLink 55 .
- getGoDeadDate() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get the date bean when the object will go dead
- getGoDeadDate() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get the date bean when the object will go dead
- getGoLiveDate() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get the date bean when the object will go live
- getGoLiveDate() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get the date bean when the object will go live
- getHiddenFromSearch() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get whether the CSL should be hidden from the Search.
- getHomePage() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Gets the home page SiteNode.
- getId() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Get the unique id of this ImageCategory.
- getId() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the unique id of this template.
- getImageSubset(int, int) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Get
numberof images, sorted by date, starting fromstartPos(inclusive). - getImages() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return all Images that belong to this ImageCategory, unsorted
- getImages(Comparator) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return all Images that belong to this ImageCategory, sorted by the given Comparator
- getImagesByDate() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return all Images that belong to this ImageCategory, sorted by last modified date (newest first)
- getImagesByPage(int) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return RESULTS_PER_PAGE number of results.
- getIndentedTitle() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the title of this site node, indented according to its depth in the site map.
- getIndexedChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the non-archived ChildrenNodes for this SiteNode (from its Trunk version, if there is one), with their positions
- getIndexedChildrenNodes(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the ChildrenNodes for this SiteNode (from its Trunk version, if there is one), with their positions, with or without the archived ones
- getIndexedChildrenNodes(boolean, boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the ChildrenNodes for this SiteNode, with their positions, with or without the archived ones, using its Trunk version or not.
- getIndexedSubContents(String) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get all the SubContents from this ContentSiteLocation for this role
- getIsNew() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object IsNew
- getIsNew() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object IsNew
- getLastModifiedDate() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the last modified date
- getLastModifierUser() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the last modifier user.
- getLastPageNumber() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return the maximum page number
- getLink() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Deprecated. This method returns an absolute URL, i.e. it does not add the web app's context. This means you have to add it yourself but it's easy to forget. Changing the behaviour of this method might break code that does manage the context (e.g. the search package).
- getLinkCloseTag() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Close the link and conditionally add the file type, if this is a link to the file type template (in this case it is called the pdf template but is used for other file types aswell) and whether or not it opens in a new window info
- getLinkOpenTag() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the opening Tag to this SiteLocation, including href and target attributes
- getLinkOpenTag() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the opening Tag to this SiteLocation, including href and target attributes
- getLinkText() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the LinkText: for a SiteLocationLink, this uses the SiteLocation's Name or SectionName.
- getLinkToNewWindow() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the LinkToNewWindow
- getLinkURL() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the LinkURL: a link to viewPage (if the link isDisplayable) or previewPage (otherwise).
- getLiveChildren() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- The simplest method to use for rendering the Node: gives a list of all live children, in their "live" versions if possible (the "trunk" version may be live).
- getLiveHierarchyIdsArray(int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get an array of the ids of the live versions of the parents of this node, from the root, down to the node itself.
- getLiveVersionChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the non-archived ChildrenNodes for this SiteNode (from its Trunk version, if there is one), returning the live version of the child nodes, if possible
- getLiveVersionSortedChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the non-archived ChildrenNodes for this SiteNode (from the live version, if possible) in ascending creation-date order.
- getLocationForContent(Content) - Static method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the location that contains a given piece of content.
- getName() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the name
- getName() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the name
- getName() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the name
- getNavbarNodes() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all non-archived First Layer Nodes that appear in the navbar
- getNeedApproval() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object will be always approved
- getNeedApproval() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object will be always approved
- getNoPagesToPublish() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the number of pages which are ready to be published under this SiteNode, (eg this node and its children, grand-children, etc) by calling the Objects.
- getNoPagesToPublishPerSection(int) - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Count, for each SiteNode of a given depth, the number of pages ready to be approved/published, ommitting the SiteNodes which don't have any.
- getNumberOfImages() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Return the number of Images belonging to this ImageCategory
- getOfInterest() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get whether this SiteLocation is of interest
- getOfInterest() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get whether this SiteLocation is of interest
- getOpenInNewWindow() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the OpenInNewWindow: redefine to take into account the template of the SiteLocation
- getParentNode() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ParentNode of this object, in its TRUNK Version if it exists.
- getParentNode(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ParentNode of this object, either this current Version, or possibly its Trunk version.
- getPositionInParent(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the position of this node within its parent.
- getRawChildrenNodeIds(boolean, boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the list of ids of the children, using this version of the SiteNode, or its trunk counterpart.
- getRawChildrenNodes(boolean, boolean, String) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Actually does the work of getting the children nodes.
- getRoles() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get all Roles for which SubContents are defined at the moment.
- getRootNodes() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all non-archived Root Nodes
- getRootNodes(boolean) - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all Root Nodes, with/without archived ones
- getSearchSummary() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get a short, one paragraph summary for this searchable object.
- getSearchText() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get all text for this object that will be searched on.
- getSearchText() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all text for this object that will be searched on.
- getSearchTitle() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get a one-line title for this searchable object.
- getSecondLayerNodes() - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all non-archived Second Layer Nodes
- getSecondLayerNodes(boolean) - Static method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all Second Layer Nodes, with/without archived ones
- getSectionName() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the SectionName
- getSectionStrapline() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the SectionStrapline
- getShowLinksToChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the ShowLinksToChildrenNodes.
- getSiteLocation() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the SiteLocation, the trunk version of it if it exists.
- getSiteLocation(String) - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the SiteLocation, possibly checking a particular version.
- getSiteLocationId() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get the SiteLocation's Id.
- getSnapshotFilename() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the SnapshotFilename
- getSortedChildrenNodes() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all the non-archived ChildrenNodes for this SiteNode (from its Trunk version, if there is one), in descending creation-date order.
- getSortedChildrenNodes(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all ChildrenNodes for this SiteNode (from its Trunk version, if there is one), in ascending creation-date order.
- getSortedChildrenNodes(boolean, boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all ChildrenNodes for this SiteNode (from its Trunk version, if there is one), in the specified creation-date order.
- getSortedChildrenNodes(boolean, Comparator) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all ChildrenNodes for this SiteNode, ordered by the given Comparator, using its Trunk version.
- getSortedChildrenNodes(boolean, Comparator, boolean, String) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get all ChildrenNodes for this SiteNode, ordered by the given Comparator, using its Trunk version or not.
- getStatus() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get the status of this Publishable
- getStatus() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get the status of this Publishable
- getStatusLastModifiedDate() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get the date of the last status modificatin of this Publishable
- getStatusLastModifiedDate() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get the date bean when the object will go live
- getSubContent(String, int) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get one SubContent from this ContentSiteLocation
- getSubContents(String) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get all the SubContents from this ContentSiteLocation for a given role, and without their positions
- getSubContents() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get all the SubContents from this ContentSiteLocation
- getSubTopParent() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the SubTop parent of this Node (ie the parent which doesn't have a grandparent), using the Trunk version of the SiteNode.
- getSubsection() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the Subsection in which this node is, that is its SubSubTop parent.
- getSubsectionId() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the SubsectionId of this node's, if any, using the separators.
- getSubsectionName() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the Name of the subsection this Node is in, or EMPTY_STRING if it's not in a subsection.
- getTemplateForName(String) - Static method in class com.RuntimeCollective.sitemap.bean.Template
- Get the Template with the smallest id whose name matches the one requested.
- getTheTemplate() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the template
- getTheTemplate() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the template
- getTitle() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the title
- getTitle() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Get the title
- getTitle() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the title
- getTitle() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the title The title will be extracted from sub-class specific information, for example from the text of the headline.
- getTitleLength() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the title length.
- getToBeApprovedPublishables() - Static method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get a list of all the publishables which are to be approved, ordered by lastModifiedDate (older first).
- getTopParent() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get the Top parent of this Node (ie the parent which doesn't have a parent), using the Trunk version of the SiteNode.
- getURL() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the whole URL to get to this SiteLocation This is very basic and while be overriden by subclasses.
- getURL() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the whole URL to get to this SiteLocation
- getUsableByAuthors() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the UsableByAuthors
- getVersion(String) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get an existing version of this object.
- getVersionList() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get a list of all versions, including the current one.
- getVersionReference() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the Reference of this Version, that is, the id of the first object in the family of versions.
- getVersionTag() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the Tag of this Version.
- getVersionTagList() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get the List.
- getViewFilename() - Method in class com.RuntimeCollective.sitemap.bean.Template
- Get the viewFilename
- getWebURLStub() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get the URL stub
- getWebURLStub() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get the URL stub
H
- HiddenFromSearch - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Whether the CSL should be hidden from the Search
- hasLiveChild() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether this node has a live Child.
I
- ID_INDEXING_END - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- Separator used when indexing ids, eg not to confuse "23" with "123".
- ID_INDEXING_START - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- Separator used when indexing ids, eg not to confuse "23" with "123".
- ID_PARAM - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- INDENT_PREFIX - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The prefix used when indenting the title of this node.
- ImageCategory - class com.RuntimeCollective.sitemap.bean.ImageCategory.
- The ImageCategory class is used to group Images, for use in an image library.
- ImageCategory() - Constructor for class com.RuntimeCollective.sitemap.bean.ImageCategory
- Construct a new blank ImageCategory, giving it a new unique ID.
- ImageCategory(int) - Constructor for class com.RuntimeCollective.sitemap.bean.ImageCategory
- Get a ImageCategory from the database, given an id.
- Images - Variable in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Internal representation of Images in this ImageCategory
- IsNew - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Is the object New ?
- id - Variable in class com.RuntimeCollective.sitemap.bean.ImageCategory
- This ImageCategory's id
- id - Variable in class com.RuntimeCollective.sitemap.bean.Template
- This template's id
- indexLiveToday() - Static method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Add all content that goes live today, to the search index.
- insertChildNode(int, SiteNode) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Insert a Child into this SiteNode.
- isAlwaysLive() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object will be always live
- isAlwaysLive() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object will be always live
- isApproved() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- isApproved() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- isArchived() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- isArchived() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- isDisplayable() - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Is this link displayable, ie is it valid (using the Live version of the SiteLocation if it exists).
- isDisplayable(boolean) - Method in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Is this link displayable, ie is it valid (using or not the Live version of the SiteLocation).
- isEdited() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Set/Check for possible statuses
- isEdited() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Set/Check for possible statuses
- isFirstLayer() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether this SiteNode is in the first layer of the sitemap.
- isHiddenFromSearch() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Get whether the CSL should be hidden from the Search.
- isLive() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The CSL version of this method checks whether there is a Live version, hence calls isLive(false).
- isLive(boolean) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Checks whether this object, or its Live version, is live.
- isLive() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Check whether the object is live right now
- isLive() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Check whether the object is live right now
- isNew() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object IsNew
- isNew() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object IsNew
- isOfInterest() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get whether this SiteLocation is of interest.
- isOfInterest() - Method in interface com.RuntimeCollective.sitemap.bean.SiteLocation
- Get whether this SiteLocation is of interest.
- isRoot() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether this SiteNode is a root.
- isSecondLayer() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether this SiteNode is in the second layer of the sitemap.
- isToBeApproved() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- isToBeApproved() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- iterator() - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- Return an iterator of all live SiteLocation bookmarks.
- iteratorIncludeDead() - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- Return an iterator of all SiteLocation bookmarks, whether they're live or dead.
L
- LastModifiedDate - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The last modified date
- LastModifierUser_id - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The last modifier user
- LinkToNewWindow - Variable in class com.RuntimeCollective.sitemap.bean.Template
- Should this Template be viewed in a new window ?
- loadChildrenNodes(String, int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Load the children nodes.
- loadContent(int) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Load Content data.
- loadFlat(int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Get a current SiteNode from the flat table.
- loadSubContents(int) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Load SubContent data, and version update
M
- makeArchived(Date, User) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Make a node archived: set its status, last modified date and user, and save it.
- makeDuplicate() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The method to call when you want to create (and save) the duplicate of an object.
- makeDuplicate(int) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The method to call when you want to create (and save) the duplicate of an object, while expliciting the id you want for the duplicate.
- makeDuplicate(int) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- The SiteNode version of this method will make a Duplicate with NO parent and NO children.
- markAsApproved() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- markAsApproved() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- markAsArchived() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- markAsArchived() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- markAsArchived() - Method in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Mark this SiteLocation as archived.
- markAsArchived() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Set whether the object has been archived.
- markAsArchivedSuperAndSave() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Call the super definition of markAsArchived, and save the node.
- markAsEdited() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- markAsEdited() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- markAsToBeApproved() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- markAsToBeApproved() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
N
- NOTHING - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Name - Variable in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- The name
- Name - Variable in class com.RuntimeCollective.sitemap.bean.Template
- The name
- NeedApproval - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Whether the object need to be approved before going live.
- needsApproval() - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Get whether the object will be always approved
- needsApproval() - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get whether the object will be always approved
O
- ORDER_BY_LAST_MOD_DATE - Static variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- OfInterest - Variable in class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Is this SiteLocation is of interest, ie should we record hits on it ?
P
- PDFDOCUMENT - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- PREVIEW_PAGE_DEFAULT - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- PREVIEW_PAGE_PARAM - Static variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- ParentNodeId - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The Parent
- Publishable - interface com.RuntimeCollective.sitemap.bean.Publishable.
- Interface to implement if you want an object to be publishable, ie sometimes live and sometimes dead.
- populateIndex() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Return a Searchable[] of all ContentSiteLocations that need to be added to the search index.
- publish(Date, Date) - Method in interface com.RuntimeCollective.sitemap.bean.Publishable
- Publish this object on (only) one SiteLocation
- publish(Date, Date) - Method in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Publish this object on (only) one Publishable
R
- RESULTS_PER_PAGE - Static variable in class com.RuntimeCollective.sitemap.bean.ImageCategory
- How many results per page to display
- readVersionsMap() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Read from the database the list of VersionTags.
- reallyAddImage(Image) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Update the internal representation of which Images are part of this category
- reallyRemoveImage(Image) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Update the internal representation of which Images are part of this category
- refreshVersionsMap(boolean) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Refresh the List of VersionTags, for this object and all its versions
- removeBookmark(SiteLocation) - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- removeBookmark(int) - Method in class com.RuntimeCollective.sitemap.bean.Bookmarks
- removeChildNode(SiteNode) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Remove a ChildNode from this SiteNode (all its positions, if more than one)
- removeFromSearchIndex() - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- Remove this sitenode, and all its versions, from the search index.
- removeFromSite(User) - Method in class com.RuntimeCollective.sitemap.bean.SiteNode
- This method completely removes a SiteNode from the Website.
- removeImage(Image) - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Remove an Image from this ImageCategory, if it's in this ImageCategory.
- removeSubContent(String, Content) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Remove a SubContent from this ContentSiteLocation under a given role, and in all its positions (if more than one)
- removeSubContent(Content) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Remove a SubContent from this ContentSiteLocation for all roles and positions possible
- removeSubContentReturnPos(String, Content) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Remove a SubContent from this ContentSiteLocation under a given role, and in all its positions (if more than one)
- removeSubcontentReturnPosRole(Content) - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Remove a SubContent from this ContentSiteLocation for all roles and positions possible.
S
- SELECT_ID_FROM - Static variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- SHOW_SUBSECTIONS_AS_HOMEPAGE_IN_BREADCRUMB_KEY - Static variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The runtime parameter for showing subsections as home pages.
- SITEMAP_CONTENT_MAP - Static variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The name of the database table containing the sitemap-content map.
- STATUS_APPROVED - Static variable in interface com.RuntimeCollective.sitemap.bean.Publishable
- STATUS_ARCHIVED - Static variable in interface com.RuntimeCollective.sitemap.bean.Publishable
- STATUS_EDITED - Static variable in interface com.RuntimeCollective.sitemap.bean.Publishable
- Possible statuses
- STATUS_TO_BE_APPROVED - Static variable in interface com.RuntimeCollective.sitemap.bean.Publishable
- SectionName - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The SectionName
- SectionStrapline - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- The SectionStrapline
- ShowLinksToChildrenNodes - Variable in class com.RuntimeCollective.sitemap.bean.SiteNode
- Whether we show links to the ChildrenNodes.
- SimplePublishable - class com.RuntimeCollective.sitemap.bean.SimplePublishable.
- A commodity class which implements all the basic functionality of Publishable, so we can spare duplicating lots of simple code.
- SimplePublishable() - Constructor for class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Construct a new blank SimplePublishable, giving it a new unique ID.
- SimplePublishable(int) - Constructor for class com.RuntimeCollective.sitemap.bean.SimplePublishable
- Get a current SimplePublishable from the RuntimeDataSource, given an id.
- SimpleSiteLocation - class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation.
- A commodity class which implements all the basic functionality of SiteLocation, so we can spare duplicating lots of simple code.
- SimpleSiteLocation() - Constructor for class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Construct a new blank SimpleSiteLocation, giving it a new unique ID.
- SimpleSiteLocation(int) - Constructor for class com.RuntimeCollective.sitemap.bean.SimpleSiteLocation
- Get a current SimpleSiteLocation from the RuntimeDataSource, given an id.
- SiteLocation - interface com.RuntimeCollective.sitemap.bean.SiteLocation.
- The interface to implement if you want an object to be a location within your site map.
- SiteLocationId - Variable in class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Does this SiteLocationLink link to a SiteLocation, and then which one ?
- SiteLocationLink - class com.RuntimeCollective.sitemap.bean.SiteLocationLink.
- The SiteLocationLink class implements the abstract Link class, by linking to a SiteLocation.
- SiteLocationLink() - Constructor for class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Construct a new blank SiteLocationLink, giving it a new unique ID.
- SiteLocationLink(int) - Constructor for class com.RuntimeCollective.sitemap.bean.SiteLocationLink
- Get a SiteLocationLink from the database, given an id.
- SiteNode - class com.RuntimeCollective.sitemap.bean.SiteNode.
- The SiteNode version of the ContentSiteLocation, which can have a parent and children SiteNodes.
- SiteNode() - Constructor for class com.RuntimeCollective.sitemap.bean.SiteNode
- Construct a new blank SiteNode, giving it a new unique ID.
- SiteNode(int) - Constructor for class com.RuntimeCollective.sitemap.bean.SiteNode
- Get a current SiteNode from the RuntimeDataSource, given an id.
- SnapshotFilename - Variable in class com.RuntimeCollective.sitemap.bean.Template
- The File containing an example snapshot of what the templates look like
- Status - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- The status of this Publishable
- StatusLastModifiedDate - Variable in class com.RuntimeCollective.sitemap.bean.SimplePublishable
- When the object goes live
- SubContentIds - Variable in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- The SubContents
- save() - Method in class com.RuntimeCollective.sitemap.bean.ContentSiteLocation
- Save this bean to the database.
- save() - Method in class com.RuntimeCollective.sitemap.bean.ImageCategory
- Save this ImageCategory to the database.
- save() - Method in class com.RuntimeCollective.sitemap.bean.