com.ibm.portal.resourceaggregator.combiner
Interface ResourceList


public interface ResourceList

A ResourceList object represents a list of resource variations.
The resource aggregation framework will combine all resource variations into one url so that all resources are retrieved with just one http request instead of many individual ones.

This object will be used for cache purposes on the server side. This allows to avoid a recalculation of the url with every request. It is recommended to cache this in an instance variable or similar means.

Since:
8.5.0.3

Method Summary
 ResourceList add(ResourceURIVariations... resourceVariations)
          Adds ResourceURIVariations objects to the resource list
 ResourceList add(ResourceURIVariations resourceVariation)
          Adds a ResourceURIVariations object to the resource list
 ResourceCombinerService.ResourceType getType()
          Returns the resource type
 

Method Detail

getType

ResourceCombinerService.ResourceType getType()
Returns the resource type

Returns:
Returns the resource type of the list

add

ResourceList add(ResourceURIVariations resourceVariation)
Adds a ResourceURIVariations object to the resource list

Parameters:
resourceVariation - the resource selection. Must not be null.
Returns:
returns this object again in order to support chaining calls such as .add().add()

add

ResourceList add(ResourceURIVariations... resourceVariations)
Adds ResourceURIVariations objects to the resource list

Parameters:
resourceVariations - the resource selections. Must not be null.
Returns:
returns this object again in order to support chaining calls such as .add().add()