Home >	Contents >	Index >

Template Tags TOC   |    Alpha TOC   |    Tag Family TOC   |    Purpose TOC   |    Annotated TOC   |    Index

asset:list

Queries the database and retrieves a list of assets that meet the specified criteria. It creates a list of assets of one type.

Syntax

<asset:list 
      type="assetType" 
      list="nameOfList" 
      [order="order"]
      [pubid="siteId"]
      [excludevoided="trueOrFalse"]
      [field[n]="fieldName"]
      [value[n]="fieldValue"]>
      <asset:argument name="fieldName" value="fieldValue"/>
</asset:list>

Parameters

type (required)

Input. Asset type of the assets to list.

list (required)

Input. Name to assign to the list of assets. If a list with this name already exists, it is replaced with this new list.

asset:argument (optional)

Input. Field name/value pairs to pass to the tag to restrict the list. For example: <asset:argument name="Category" value="Sports"/>

order (optional)

Input. Fields to sort the list by and whether the sort on those fields is ascending (asc) or descending (desc). By default, the sort is ascending. If you specify more than one field, separate the field names with a comma.

For example, if you specify order="nrank", the list is sorted by rank starting at number 1. If you want the list sorted by descending rank, use
order="nrank desc".

pubid (optional)

Input. Specifies the ID of the publication to which the query is restricted. When this optional parameter is used, the query performs a database join operation against the AssetPublication table.

excludevoided (optional)

Input. Specifies whether to exclude assets whose status field='VO' from the search results. When this optional parameter is set to 'true', the query excludes voided assets. By default, the paramter is false.

field[n] (optional), where n is a number 1-9

Input. Field name to pass to the tag to restrict the list. If a field[n] is passed, a corresponding value[n] must be passed.

value[n] (optional), where n is a number 1-9

Input. Value to pass to the tag to restrict the list. Value[n] requires, a corresponding field[n] to be passed.

For example: <asset:list type="Article" list="sportsstories" field1="Category" value1="Sports"/>

Description

This tag queries the database table for assets of this type and then builds a list of assets, selecting those that meet certain criteria. The criteria you can use include asset type and field/value pairs that define assets of that type. You pass in field/value pairs with embedded asset:argument statements, or using field[n], value[n] arguments.

Use this tag to retrieve multiple assets of the same type that do not necessarily have associations or relationships with each other.

Error Numbers

The possible values of errno include:

Value	Description
-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.

Example

This code creates a list named "ArticleList" composed of all the article assets that have "BurlingtonFinancial" as a source. It displays a list of the names of those articles:

<asset:list type="Article" list="ArticleList">
<asset:argument name="source" value="BurlingtonFinancial"/>
</asset:list>
<ics:listloop listname="ArticleList">
<ics:listget listname="ArticleList" fieldname="name"/>
</ics:listloop>

This code creates a list named "articlelist" composed of all active articles in a specific site, sorted by name and then by description:

<asset:list list="articlelist" type="Article" excludevoided="true" pubid='<%=ics.GetVar("pubid")%>' order="name, description desc"/>

See Also

asset:argument
asset:search
ics:listloop
ics:listget

		Home >	Contents >	Index >
	Oracle JSP Tag Reference Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved.