Home >	Contents >	Index >

Expanded TOC   |    Purpose TOC   |    Annotated TOC   |    Index

AssetLoad

Queries the database for the specified asset, loads an instance of the asset into memory within the Asset object, and returns the loaded asset in an XML wrapper.

Note This operation does not load flex assets.

Syntax

assetLoad(java.lang.String authusername, 
          java.lang.String authpassword, 
          java.lang.String TYPE, 
          java.lang.String OBJECTID, 
          java.lang.String FIELD, 
          java.lang.String VALUE, 
          java.lang.String EXCLUDE, 
          java.lang.String FIELDLIST,
          java.lang.String GETCHILDREN,
          java.lang.String CODE,
          java.lang.String CHILDTYPE,
          java.lang.String CHILDID,
          java.lang.String ORDER,
          com.FatWire.LoadedAssetHolder assetLoad,
          com.FatWire.IListHolder listOUT)

Parameters

authusername (required)

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

authpassword(required)

(String) Password for the associated user name.

TYPE (required)

(String) The asset type of the asset that you want to retrieve from the database. For your web service, the value must be page.

Typically, you provide TYPE and OBJECTID. When you know that a specific field/value pair can uniquely identify the asset, you can provide TYPE and the field/value pair instead. Either the OBJECTID or the FIELD and VALUE combination, but not both, are required to load an asset.

OBJECTID (optional)

(String) The unique identifying number that references the Asset object. Not required if you use TYPE with the FIELD and VALUE paired parameters.

FIELD (optional)

(String) A field is any one of the column names for the asset. For example, standard fields for Sites assets include name, template, status, description, subtype, category, modified, headline, byline, and body. Use the field name in conjunction with the VALUE parameter as the name portion of a name/value pair. The field name and its corresponding value uniquely identifies the asset to be loaded. Note that if the field/value pair that you supply identifies more than one asset, the AssetLoad operation uses the first one that it finds.

Not required if you use TYPE with the OBJECTID parameter.

VALUE (optional)

(String) Value that corresponds to the field specified by the FIELD parameter. Paired with the field name, this parameter uniquely identifies an asset by supplying the associated value.

Not required if you use TYPE with the OBJECTID parameter.

EXCLUDE (optional)

(Boolean) Depending on whether the value of EXCLUDE is True or False, the AssetLoad operation either returns the fields specified in the FIELDLIST or returns the fields that are not contained in the list.

True indicates that all fields except the fields in the FIELDLIST are to be returned.

False indicates that only fields in FIELDLIST are to be returned. That is, it returns fields specified with the FIELDLIST parameter. The default value is False.

FIELDLIST (optional)

(String) Comma-separated list of fields that you want to include or exclude from the request for asset fields. The EXCLUDE parameter, which operates on the FIELDLIST, determines whether the fields in the list are returned or whether all fields other than those in the list are returned.

GETCHILDREN (optional)

(String) Legal values are True or False. Specifying True will also load the asset's children.

CODE (optional)

(String). 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 OBJECTTYPE="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.

Valid values are either Placed or Unplaced.

CHILDTYPE (optional)

(String) The asset type of child that you want to retrieve. The child asset type, which can be the same as the TYPE parameter, depends on the asset that you are passing. For example, common asset types include article, image, page, collection, and query. Other asset types include those flex assets for Sites and Sites-Engage assets. If no ChildTYPE parameter is passed, the GetChildren operation returns all children for the asset by default.

CHILDID (optional)

(String) The object ID of the specific child node to return. If you supply a child ID, you must also supply a child type. If no child ID is specified, the GetChildren operation returns all children for the asset.

ORDER (optional)

(String) The fields to sort the list by, and whether the sort result on those fields is ascending or descending. For example, you can specify ID, name, date, created by user, and so on. By default, the sort is ascending. If you specify more than one field, separate the field names with a comma.

assetLoad (required)

(LoadedAssetHolder) Output parameter for holding the returned loaded asset.

listOUT (required)

(IListHolder) Output parameter for holding the returned IList if any.

Description

Based on the specified parameters, AssetLoad fills an Asset object with data. It executes a database query to retrieve an instance of the specified asset and then saves the instance in memory.

Multiple parameters provide different ways to identify the asset to load. Enter the parameter or parameter combination that is the most convenient identifier for your application, and leave blank placeholders for the unused parameters. Although only the TYPE parameter is required, you must also supply at least the OBJECTID or the FIELD and VALUE paired parameters. You can identify the asset that you want to load by specifying its asset type and object ID, or by specifying its asset type combined with a field/value pair that uniquely identifies the asset.

Typically, each web service calls the AssetLoad operation to start so that subsequent code can extract and display the loaded data on pages. All input parameters are strings.

Note that the AssetLoad operation does not load information from the AssetPublication table or the AssetRelationTree table. If you need information from the AssetRelationTree table, use the AssetGetChildren operation. If you need information from other auxiliary tables, you can issue queries using the object ID of the loaded asset.

Returns

Asset object that contains the requested field values.

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.
-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.
-10009	More than one object met the specified criteria.

 

Example

This code loads a page asset, identifying it by type and object ID:

AssetsetService service = new AssetsetServiceLocator();
AssetPortType port = service.getAssetPort();
LoadedAssetHolder holder = new LoadedAssetHolder();
port.assetLoad("user_author", "demo", "Page", "968685128066", null, null, null, null,
            null, null, null, null, null, holder, new IListHolder());
LoadedAsset asset = holder.value;

See Also

AssetGetChildren

 

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