Home > Contents > Index >
Expanded TOC | Purpose TOC | Annotated TOC | Index
ASGetAssetCount
Returns a count of assets that exactly match the criteria specified by the
SEARCHSTATE
parameter.Syntax
ASGetAssetCount(java.lang.String authusername, java.lang.String authpassword, com.divine.IList LIST, 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) Input parameter. Name of the list that determines sort order. The list describes how the returned assets are to be sorted.
- The
IList
object 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 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. To create a SearchState, use the SearchState Objects.
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.
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
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.
Returns
Count of assets that match the critera specified by the
SEARCHSTATE
parameter.Example
The following code creates an asset types list from SearchState input.
AssetsetService service = (AssetsetService)new AssetsetService_Impl(); AssetsetPortType port = service.getAssetsetPort(); Searchstate ss = new Searchstate(); String retVal = port.ASGetAssetCount("user_author", "demo", null, "AArticles", null, ss, null, null);
Home > Contents > Index > ![]()
FatWire Web Services Reference
Copyright 2005,2006,2007 by FatWire Software
All rights reserved.