com.sapportals.wcm.repository

Class TypedResourceList

java.lang.Object
  com.sapportals.wcm.repository.ResourceList
      com.sapportals.wcm.repository.TypedResourceList

All Implemented Interfaces:

IResourceList, ITypedResourceList

public class TypedResourceList
extends ResourceList
implements ITypedResourceList

Implements the ITypedResourceList interface.

Copyright (c) SAP AG 2001-2004

See Also:

ITypedResourceList

Constructor Summary

TypedResourceList(ResourceList resourceList)
Construct a new resource list containing the elements of the specified list in the same order.

TypedResourceList(String listType)
Constructs a new empty resource list with a type.

Method Summary

Map	getPropertyBag(IResource res)
String	getType() Returns the resource list's type attribute
IResource	remove(int index) Removes the resource at the specified position in this list.
boolean	remove(IResource resource) Removes the first occurence of the specified resource from the list.
void	setPropertyBag(IResource res, Map propertyBag) Set a property bag for a resource contained in the list.
void	setType(String listType) Set the type attributes

Methods inherited from class com.sapportals.wcm.repository.ResourceList

add, add, addAll, containsResource, difference, get, indexOf, intersection, lastIndexOf, listIterator, listIterator, set, size, sort, subList, toString, union

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.sapportals.wcm.repository.IResourceList

add, add, addAll, containsResource, difference, get, indexOf, intersection, lastIndexOf, listIterator, listIterator, set, size, sort, subList, union

Constructor Detail

TypedResourceList

public TypedResourceList(ResourceList resourceList)

Construct a new resource list containing the elements of the specified list in the same order.

TypedResourceList

public TypedResourceList(String listType)

Constructs a new empty resource list with a type.

Parameters:

listType - the type attribute of this list.

Method Detail

remove

public boolean remove(IResource resource)

Description copied from interface: IResourceList

Removes the first occurence of the specified resource from the list.

Specified by:

remove in interface IResourceList

Overrides:

remove in class ResourceList

Parameters:

resource - TBD: Description of the incoming method parameter

Returns:

Returns true is this list contained the specified resource.

remove

public IResource remove(int index)

Description copied from interface: IResourceList

Removes the resource at the specified position in this list. Shifts any subsequent resources to the left (subtracts one from their indices).

Specified by:

remove in interface IResourceList

Overrides:

remove in class ResourceList

Parameters:

index - the index of the resource to removed.

Returns:

the element previously at the specified position.

getType

public String getType()

Description copied from interface: ITypedResourceList

Returns the resource list's type attribute

Specified by:

getType in interface ITypedResourceList

Returns:

The resource list's type attribute. Can be null .

setType

public void setType(String listType)

Description copied from interface: ITypedResourceList

Set the type attributes

Specified by:

setType in interface ITypedResourceList

Parameters:

listType - type to be set

getPropertyBag

public Map getPropertyBag(IResource res)

Specified by:

getPropertyBag in interface ITypedResourceList

Parameters:

res - a resource contained in the list.

Returns:

Returns a property bag for a resource contained in the list. Returns null if the specified resource is not contained in the list or no property bag is associated with the resource.

setPropertyBag

public void setPropertyBag(IResource res,
                           Map propertyBag)
                    throws com.sapportals.wcm.WcmException

Description copied from interface: ITypedResourceList

Set a property bag for a resource contained in the list.

Specified by:

setPropertyBag in interface ITypedResourceList

Parameters:

res - A resource contained in the list.

propertyBag - Properties to store.

Throws:

com.sapportals.wcm.WcmException - If the specified resource is not contained in the list.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM