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

OBJECT.LOAD

Loads an object.

Syntax

<OBJECT.LOAD CLASSNAME="some classname"
        NAME="some object name"
        [OBJECTID="some object id"]
        [OBJECTVERSION="some object version"]
        [CHECKOUT="checkout info"]
        [NODEID="some node id"]
        [FIELD="some field"]
        [VALUE="some object value"]
        [ARG1="argument 1"]
        [ARG2="argument 2"]
        [LIST="listname"]/>

Parameters

CLASSNAME (required)

Classname of the object.

NAME (required)

Name of the object.

OBJECTID (optional)

ID of the object.

OBJECTVERSION (optional)

Version of the object.

CHECKOUT (optional)

Checkout information for the object.

NODEID (optional)

Node ID for the object.

FIELD (optional)

Specifies the name of a field argument that can be used to uniquely identify an object. When using this parameter the, value parameter should also be specified to indicate the value of the specified field.

VALUE (optional)

Specifies the value of a field for unique identification. The value parameter must be used in conjunction with the field parameter.

ARG1 (optional)

Argument 1.

ARG2 (optional)

Argument 2.

LIST (optional)

Name of existing list. This parameter allows you to load an object from an existing list rather than from the database.

Description

This tag creates a new instance of the implementing class, loads a specific object into the object instance, and saves the object instance in the object pool using the specified name. The object can be requested by referencing the following information:

• object identifier

• node object identifier

• key field and key value

The implementing class must implement a load method. The load method should have one of the following prototypes:

• public static MyClass Load(ICS ics, Long lObjectId, Integer iObjectVersion, boolean bLock)

• public static MyClass Load(ICS ics, Long lObjectId, Integer iObjectVersion, boolean bLock, String sArg1)

• public static MyClass Load(ICS ics, Long lNodeId)

• public static MyClass Load(ICS ics, Long lNodeId, String sArg1)

• public static MyClass Load(ICS ics, String sField, String sValue)

• public static MyClass Load(ICS ics, String sField, String sValue, String sArg1)

errno

The possible values of errno include:

Value	Description
-101	No rows returned.
-105	Database 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.
-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.
-10010	Invalid attribute value.
-10026	No list by specified name exists.

Example

The following example uses the optional LIST parameter.

<object.list 
	 classname="com.openmarket.framework.objects.AbstractObject" 
	 arg1="obj03" 
	 list="list1"/>
        <LOOP LIST="list1">
                <object.load 
	 	 	 classname="com.openmarket.framework.objects.AbstractObject"
	 	 	 arg1="obj03" 
	 	 	 list="list1" 
	 	 	 name="object1"/>
                <object.scatter name="object1" 
	 	 	 	 prefix="object1"/>
                id: <ics.getvar name="object1:id"/><br/>
        </LOOP>

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