asset:children

Queries the AssetRelationTree table and builds a list of child assets for the specified parent asset.

Syntax

<asset:children 
      name="assetName" 
      [type="parent assettype"] 
      [assetid="parent assetid"] 
      list="listName" 
      [code="NameOfAssociation"] 
      [objecttype="typeOfObject"] 
      [objectid="objectID"] 
      [deptype="exact|exists|none"] 
      [order="nrank"]/>

Parameters

name (required unless type and assetid supplied)

Input. Name assigned to the parent asset whose children you want to list. This parent asset must be loaded and assigned a name before you can pass its name to this tag. (See asset:load .)

type (required if name is not used)

Input. Asset type of the parent asset whose children you want to list. Either type+assetid or name must be supplied to identify the parent asset.

assetid (required if name is not used)

Input. Asset id of the parent asset whose children you want to list. Either type+assetid or name must be supplied to identify the parent asset.

list (required)

Input. Name to assign to the list that stores the results. The columns in the list match the columns in the AssetRelationTree table, and, if you use the objecttype parameter, the asset table. If a list with this name already exists, it is replaced with this new list.

code (optional)

Input. Restricts the list to include only the child assets that have the relationship (association) specified by this parameter. You can restrict the list by named associations or by unnamed relationships. This value comes from the ncode field of the AssetRelationTree.

For example, if you include objectype="Image" and code="MainImage" for an article asset, Sites lists only the image asset that is related to that article asset by the Main Image named association. Without the code entry, Sites lists all the images associated with the article.

To list only the child assets that are associated with the parent asset by unnamed relationships, use a hyphen (-). For example: code= "-" If you do not specify objecttype or code, the list includes all children with named associations or unnamed relationships to the parent asset.

objecttype (optional)

Input. Restricts the list of children by asset type. If you supply an objecttype, the list of children is a join of the AssetRelationTree and the asset table for the type specified.

To request a specific child asset, combine this parameter with objectid. Note that if you include an objectid, objecttype is not optional.

objectid (optional)

Input. Restricts the list to include only the child asset that you specify. You must provide both an objectid and an objecttype to request a specific child.

deptype (optional)

Input. This attribute specifies whether static publishing approval dependency is exact, exists , or none.

Legal values are:

• exact(default) -- Exact specifies a version dependency. The version of the dependent asset must be equal to the version of the asset when it was approved.

• exists -- Exists specifies that any version of the asset satisfies the dependency condition.

• none -- None specifies no approval dependency on the asset.

order (optional)

Input. The 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".

Description

This tag queries the AssetRelationTree table for a list of the children of the asset that you specify, listing each child with a value for all of the fields from that table (nid, nparentid, nrank, otype, oid, and ncode). You must either load the parent asset (asset:load ) before you can invoke this tag or specify the type and assetid.

For example, you can use this tag to retrieve the assets referred to by a collection asset or the image assets associated with an article asset. You can then loop through the list, or reference the data returned in the list to display the relevant information from those assets.

You can restrict the list of children by association name (code), object type and object ID.

If you use the objecttype parameter, the resulting list of children is a join of the AssetRelationTree and the asset table for the type specified and contains data from both tables. In such a case, you do not need to use asset:load to load the child asset to get asset data from the primary asset table.

For more information about the columns of the AssetRelationTree table, see the section in the Developer's Guide entitled "Tree Tables" in Chapter 12.

Error Numbers

The possible values of errno include:

Value	Description
-111	The asset has no children.
-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.

Example

This code retrieves the query asset that has been associated with a parent asset through the LatestNews association and writes it to a list named LatestNewQuery:

<asset:children name="HomePage" list="LatestNewQuery" objectype="Query" code="LatestNews"/>

This code retrieves the query asset that has been associated with a parent asset through the LatestNews association without loading the asset:

<asset:children type="Page" assetid='<%=ics.GetVar("cid")%>' list="LatestNewQuery" objectype="Query" code="LatestNews"/>

This code retrieves a collection of articles, determines the members of the collection, and then displays the Description field of each article:

<asset:load name="NewsCollection" type="Collection" objectid='<%=ics.GetVar("id")%>'/>
<asset:get name="NewsCollection" field="name"/><br/>
<asset:children name="NewsCollection" code="-" order="nrank" objecttype="Article" list="articleList"/>
<ics:listloop listname="articleList">
        <ics:listget listname="articleList" fieldname="description"/><br/>
</ics:listloop>

See Also

asset:childtypes
asset:legalchildtypes
asset:list
asset:load