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

OBJECT.LIST

Retrieves a list of objects.

Syntax

<OBJECT.LIST CLASSNAME="some class name"
             LIST="name of list"
             [ORDER="list of field names"]
             [ARG1="argument 1"]
             [ARG2="argument 2"]>
    <OBJECT.ARGUMENT NAME="some name" VALUE="some value"/>
</OBJECT.LIST>

Parameters

CLASSNAME (required)

Classname of the object.

LIST (required)

Specifies the name of the list in the list pool. This is the same list pool used by other Content Server tags that generate lists. If a list exists with the same name, it is replaced by the new list.

ORDER (optional)

Specifies a comma separated list of names that should be used to order the list of objects.

ARG1 (optional)

Argument 1.

ARG2 (optional)

Argument 2.

ARGUMENT (optional)

Name/value pairs to set in the object.

Description

This tag builds a list of objects that meet the specified criteria. The criteria are a list of name/value pairs, which must be present in the object. The implementing class must implement a list method. The list method should have one of the following prototypes:

• public static IList List (ICS ics, FTValList aArgument, String sOrder)

• public static IList List (ICS ics, FTValList aArgument, String sOrder, 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.
-10010	Invalid attribute value.

Example

The following example lists all objects in the sample table.

<OBJECT.LIST
        CLASSNAME="com.openmarket.framework.objects.AbstractObject"
        LIST="list1"
        ARG1="sample"/>

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