Home >	Contents >	Index >

Expanded TOC   |    Purpose TOC   |    Annotated TOC   |    Index

ASGetAssetList

Returns a list of flex assets that exactly match the specified criteria or the created assetset.

Syntax

ASGetAssetList(java.lang.String authusername, 
               java.lang.String authpassword, 
               com.divine.IList LIST, 
               java.lang.String MAXCOUNT, 
               java.lang.String METHOD, 
               java.lang.String ASSETTYPES, 
               com.divine.IList ASSETTYPESLIST, 
               com.divine.Searchstate SEARCHSTATE, 
               java.lang.String LOCALE, 
               com.divine.IList ASSETS) 

Parameters

authusername (required)

(String) Name of the user to log in, as registered in Content Server.

authpassword(required)

(String) Password for the associated user name.

LIST (Optional)

(IList object) Name of the list that determines how the returned assets are to be sorted. The list has three columns:

• attributetypename
• attributename - Either name of attribute, sort by, or one of the following special values: _ASSETTYPE_ (order by asset type) or _RATING_ (order by asset rating--CS-Engage only)
• direction - Can be either ascending or descending.

ASSETTYPESLIST (Optional)

(IList object) Input list containing one assettype column that includes values that restrict the count.

Specify either ASSETTYPESLIST and ASSETS or SEARCHSTATE and ASSETTYPES, but not both. If you specify ASSETTYPESLIST, ASSETS is required. If both parameters are supplied, ASSETTYPESLIST is used by default.

SEARCHSTATE (Optional)

(Searchstate object) Input parameter. Searchstate object that contains the criteria to match. The Searchstate object describes the search constraints, if any.

Specify either SEARCHSTATE and ASSETTYPES or ASSETTYPESLIST and ASSET, but not both. If both parameters are supplied, ASSETTYPESLIST and ASSETS is used by default.

ASSETTYPES (Optional)

(String) Input parameter. Name of a list of asset types to include in building the asset count. Comma separated list of flex asset types to match. If null, then all assets in the system are considered. Specify either ASSETTYPESLIST and ASSETS or SEARCHSTATE and ASSETTYPES, but not both.

METHOD (Optional)

(String) Must be either random or highest. Required only if the value of maxcount is less than the number of items described. The METHOD parameter can have one of the following values:

• random - for random weighted selection based on rating
• highest - for best selection based on rating

This parameter is meaningful only for use with the CS-Engage product.

MAXCOUNT (optional)

(int) Maximum number of rows to return in the list. A value of 0 (zero) indicates all. If the count is less than the number that otherwise is returned, then items are selected according to the specified METHOD argument.

LOCALE (Optional)

(String) Language and country specification associated with the asset. Locale ensures that information and figures on a page are presented to users according to accepted conventions in their country. A locale specification comprises two-character language and country codes separated by an underscore character and enclosed in quotes. For example, for English speakers in the United States:"en_us"

ASSETS

(IList) Name of a list of assets passed to Content Server that form the asset set. The list of assets is an IList with two columns (assetid and assettype). This operation is required if you are supplying a list of assets to build the asset set instead of a SearchState. Specify either ASSETTYPELIST and ASSETS or ASSETTYPES and SEARCHSTATE, but not both. If both parameters are supplied, ASSETS is used by default.

Description

Returns a list of flex assets that exactly match the criteria specified by either the SEARCHSTATE parameter or the AssetList. The operation only works with flex assets, which are assets supplied with the CS-Direct Advantage and CS-Engage products. The list contains two columns: assettype and assetid.

Returns

A list of assets for the created assetset.

Example

The following code demonstrates GetAssetList:

AssetsetService service = (AssetsetService)new AssetsetService_Impl();
AssetsetPortType port = service.getAssetsetPort();
                    
IList myList = port.ASGetAssetList("user_author", "demo", null, null, null, "Products", null, null, null, null);

 

		Home >	Contents >	Index >
	FatWire Web Services Reference Copyright 2005,2006,2007 by FatWire Software All rights reserved.