Home >	Contents >	Index >
Template Tag TOC  |   Alpha TOC  |   Tag Family TOC  |   Purpose TOC  |   Annotated TOC  |   Index

SITEPLAN.LOAD

Queries the database for the specified site plan tree node and then loads an instance of the site plan into memory as an object.

Syntax

<SITEPLAN.LOAD
      NAME="name"
      NODEID="nodeID"/>

Parameters

NAME (required)

Input. Name of top-level node of the site plan to load.

NODEID (required)

Input. Node ID of the top-level node in the site plan.

Description

This tag executes a database query to retrieve an instance of the specified site plan tree node and then saves the instance into memory (session information), assigning it the name provided by the NAME parameter. That object is then available until the session is flushed or the name is overwritten.

To determine the nodeid of the site plan tree node that you want to load, you can either use the ASSET.GETSITENODE , or SITEPLAN.LISTPAGES tags.

You must load the site plan before you can use any of the other SITEPLAN tags, except SITEPLAN.ROOT .

errno

The possible values of errno include:

Value	Description
-108	Tree selector error.
-10001	The implementing class is invalid.
-10002	There is a missing method for the implementing class.
-10003	The method could not be invoked successfully.
-10004	A required parameter is missing.
-10005	The requested object is not in the object pool (is not loaded into memory).
-10006	The object ID is not valid.
-10007	The version of the object is not valid.
-10008	The node ID of the object is not valid.
-10009	More than one object met the specified criteria.

Example

This code loads a page asset, extracts the identity of its site node, and then loads the site plan with that page asset as the top-level page:

<ASSET.LOAD NAME="BusinessNews" TYPE="Page" OBJECTID="Variables.cid"/>
<ASSET.GETSITENODE NAME="BusinessNews" OUTPUT="PageNodeId"/>
<SITEPLAN.LOAD NAME="ParentNode" NODEID="Variables.PageNodeId"/>

See Also

ASSET.LOAD

		Home >	Contents >	Index >
	FatWire XML Tag Reference Copyright 2005 by FatWire Software All rights reserved.