Home > Contents > 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.FatWire.IList LIST, java.lang.String MAXCOUNT, java.lang.String METHOD, java.lang.String ASSETTYPES, com.FatWire.IList ASSETTYPESLIST, com.FatWire.Searchstate SEARCHSTATE, java.lang.String LOCALE (deprecated), com.FatWire.IList ASSETS)Parameters
authusername (required)
- (String) Name of the user to log in, as registered in Sites .
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--Sites-Engage only)direction
- Can be eitherascending
ordescending
.ASSETTYPESLIST (optional)
- (
IList
object) Input list containing oneassettype
column that includes values that restrict the count.
- Specify either
ASSETTYPESLIST
andASSETS
orSEARCHSTATE
andASSETTYPES
, but not both. If you specifyASSETTYPESLIST
,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. TheSearchstate
object describes the search constraints, if any.
- Specify either
SEARCHSTATE
andASSETTYPES
orASSETTYPESLIST
andASSET
, but not both. If both parameters are supplied,ASSETTYPESLIST
andASSETS
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
andASSETS
orSEARCHSTATE
andASSETTYPES
, 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. TheMETHOD
parameter can have one of the following values:
random
- for random weighted selection based on ratinghighest
- for best selection based on rating- This parameter is meaningful only for use with the Sites-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 (deprecated)
- (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 (optional)
- (IList) Name of a list of assets passed to Sites that form the asset set. The list of assets is an IList with two columns (
assetid
andassettype
). This operation is required if you are supplying a list of assets to build the asset set instead of a SearchState. Specify eitherASSETTYPELIST
andASSETS
orASSETTYPES
andSEARCHSTATE
, 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 Sites and Sites-Engage products. The list contains two columns:assettype
andassetid
.Returns
A list of assets for the created assetset.
Example
The following code demonstrates
GetAssetList
:AssetsetService service = new AssetsetServiceLocator(); AssetsetPortType port = service.getAssetsetPort(); IList myList = port.ASGetAssetList("user_author", "demo", null, null, null, "Products", null, null, null, null);See Also
Home > Contents > Index > ![]()
Oracle Web Services Reference
Copyright (c) 2013, 2018, Oracle and/or its affiliates. All rights reserved.