com.sapportals.wcm.service.objecttypehandler

Interface IObjectTypeHandlerList

All Superinterfaces:

Cloneable

public interface IObjectTypeHandlerList
extends Cloneable

Method Summary

void	add(int index, IObjectTypeHandler resource) TODO: Description of the Method.
boolean	add(IObjectTypeHandler handler) TODO: Description of the Method.
void	add(IObjectTypeHandlerList handlerList) TODO: Description of the Method.
boolean	containsObjectTypeHandler(IObjectTypeHandler handler) TODO: Description of the Method.
IObjectTypeHandler	get(int index) TODO: Description of the Method.
int	indexOf(IObjectTypeHandler handler) TODO: Description of the Method.
int	lastIndexOf(IObjectTypeHandler handler) TODO: Description of the Method.
IObjectTypeHandlerListIterator	listIterator() TODO: Description of the Method.
IObjectTypeHandlerListIterator	listIterator(int index) TODO: Description of the Method.
IObjectTypeHandler	remove(int index) TODO: Description of the Method.
boolean	remove(IObjectTypeHandler handler) TODO: Description of the Method.
IObjectTypeHandler	set(int index, IObjectTypeHandler handler) TODO: Description of the Method.
int	size() TODO: Description of the Method.
IObjectTypeHandlerList	subList(int index1, int index2) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForAction(IActionType actionType) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForExtension(String extension) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForMimetype(String mimeType) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForMimetype(String mimeType, String targetMimeType) returns a sublist of IObjectTypeHandler that match for the given mimetype or targetmimetype.
IObjectTypeHandlerList	sublistForNoResourceTypeGiven() filters out all oths, that have a resourcetype defined.
IObjectTypeHandlerList	sublistForPath(com.sapportals.wcm.util.uri.RID path)
IObjectTypeHandlerList	sublistForPath(com.sapportals.wcm.util.uri.URI path) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForResourceTypes(Vector resourceTypes) TODO: Description of the Method.
IObjectTypeHandlerList	sublistForResourceTypes(Vector resourceTypes, Vector targetTypes) returns a sublist of IObjectTypeHandler that match for the given resourcetypes or targetresourcetypes.

Method Detail

size

int size()

TODO: Description of the Method.

Returns:

TODO: Description of the outgoing return value

containsObjectTypeHandler

boolean containsObjectTypeHandler(IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

add

void add(IObjectTypeHandlerList handlerList)

TODO: Description of the Method.

Parameters:

handlerList - TODO: Description of the incoming method parameter

add

boolean add(IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

remove

boolean remove(IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

get

IObjectTypeHandler get(int index)

TODO: Description of the Method.

Parameters:

index - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

set

IObjectTypeHandler set(int index,
                       IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

index - TODO: Description of the incoming method parameter

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

add

void add(int index,
         IObjectTypeHandler resource)

TODO: Description of the Method.

Parameters:

index - TODO: Description of the incoming method parameter

resource - TODO: Description of the incoming method parameter

remove

IObjectTypeHandler remove(int index)

TODO: Description of the Method.

Parameters:

index - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

indexOf

int indexOf(IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

lastIndexOf

int lastIndexOf(IObjectTypeHandler handler)

TODO: Description of the Method.

Parameters:

handler - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

listIterator

IObjectTypeHandlerListIterator listIterator()

TODO: Description of the Method.

Returns:

TODO: Description of the outgoing return value

listIterator

IObjectTypeHandlerListIterator listIterator(int index)

TODO: Description of the Method.

Parameters:

index - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

subList

IObjectTypeHandlerList subList(int index1,
                               int index2)

TODO: Description of the Method.

Parameters:

index1 - TODO: Description of the incoming method parameter

index2 - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForPath

IObjectTypeHandlerList sublistForPath(com.sapportals.wcm.util.uri.URI path)

TODO: Description of the Method.

Parameters:

path - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForPath

IObjectTypeHandlerList sublistForPath(com.sapportals.wcm.util.uri.RID path)

Parameters:

path -

Returns:

sublistForMimetype

IObjectTypeHandlerList sublistForMimetype(String mimeType)

TODO: Description of the Method.

Parameters:

mimeType - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForMimetype

IObjectTypeHandlerList sublistForMimetype(String mimeType,
                                          String targetMimeType)

returns a sublist of IObjectTypeHandler that match for the given mimetype or targetmimetype. This method should be used, if a list of OTHs is needed for an IResource for an internal link. Depending on the oth's attributes, an oth might also be valid for a link, if the targetmimetype supplied matches the mimetype defined for the oth. See IMimeType for details

Parameters:

mimeType - the mimetype of the internal link, might be null

targetMimeType - the mimetype of the IResource the link points at, might be null

Returns:

a new instance of the IObjectTypeHandlerList , containing a subset of the oths in this list

sublistForExtension

IObjectTypeHandlerList sublistForExtension(String extension)

TODO: Description of the Method.

Parameters:

extension - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForAction

IObjectTypeHandlerList sublistForAction(IActionType actionType)

TODO: Description of the Method.

Parameters:

actionType - TODO: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForResourceTypes

IObjectTypeHandlerList sublistForResourceTypes(Vector resourceTypes)

TODO: Description of the Method.

Parameters:

resourceTypes - TBD: Description of the incoming method parameter

Returns:

TODO: Description of the outgoing return value

sublistForResourceTypes

IObjectTypeHandlerList sublistForResourceTypes(Vector resourceTypes,
                                               Vector targetTypes)

returns a sublist of IObjectTypeHandler that match for the given resourcetypes or targetresourcetypes. This method should be used, if a list of OTHs is needed for an IResource for an internal link. Depending on the oth's attributes, an oth might also be valid for a link, if the targeresourcetypes supplied matches the resourcetypes defined for the oth. See IResourceType for details

Parameters:

resourceTypes - TBD: Description of the incoming method parameter

targetTypes - TBD: Description of the incoming method parameter

Returns:

a new instance of the IObjectTypeHandlerList , containing a subset of the oths in this list

sublistForNoResourceTypeGiven

IObjectTypeHandlerList sublistForNoResourceTypeGiven()

filters out all oths, that have a resourcetype defined. The underlying resource doesn't have a resource type defined, so oths with one or several resource types set as filter criteria cannot be applied on that resource and are therefore filtered out by this method.

Returns:

a new instance of the IObjectTypeHandlerList , containing a subset of the oths in this list

Access Rights

This class can be accessed from:

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