com.sapportals.wcm.service.objecttypehandler

Interface IObjectTypeHandlerService

All Superinterfaces:

IService

public interface IObjectTypeHandlerService
extends IService

Field Summary

static String

OBJECTTYPEHANDLER_SERVICE

Method Summary

IObjectTypeHandlerList	getEmptyObjectTypeHandlerList()
IObjectTypeHandlerList	getObjectTypeHandler() Get the ObjectTypeHandler attribute of the IObjectTypeHandlerService object.
IObjectTypeHandlerList	getObjectTypeHandler(IResource resource) Get the ObjectTypeHandlerList that matches for this resource.
IObjectTypeHandlerList	getObjectTypeHandler(IResource resource, IActionType actionType) Gets the List of ObjectTypeHandlers which are valid for the given resource and which implement the wanted IActionType There are several internal filters realized a) resourceType b) mimeType (not for ICollection objects) c) extension (not for ICollection objects) d) actiontype In a first step, all ObjectTypeHandler for the RID of the resource are returned.
IObjectTypeHandlerList	getObjectTypeHandlerList(Vector resourceTypes)
void	reload() Reloads all oth definitions.

Methods inherited from interface com.sapportals.wcm.service.IService

getDescription, getDescription, getID

Field Detail

OBJECTTYPEHANDLER_SERVICE

static final String OBJECTTYPEHANDLER_SERVICE

See Also:

Constant Field Values

Method Detail

getEmptyObjectTypeHandlerList

IObjectTypeHandlerList getEmptyObjectTypeHandlerList()
                                                     throws com.sapportals.wcm.WcmException

Returns:

an empty instance of the IObjectTypeHandlerList

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getObjectTypeHandler

IObjectTypeHandlerList getObjectTypeHandler()
                                            throws com.sapportals.wcm.WcmException

Get the ObjectTypeHandler attribute of the IObjectTypeHandlerService object.

Returns:

The ObjectTypeHandler value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getObjectTypeHandler

IObjectTypeHandlerList getObjectTypeHandler(IResource resource)
                                            throws com.sapportals.wcm.WcmException

Get the ObjectTypeHandlerList that matches for this resource. If in the Handler resourcetype, mimetype or extension are defined and the given IResource does not provide values for these attributes this handler will not be included in the list. The path-validation is done the following way: A path specified in the oth ending wihtout a "*" means, only exact matches are used -> this handler will only be valid for one resource A path specified in the oth ending with a "/" followed by one "*" means, that all direct children of this resource will match A path specified in the oth ending with a "/" followed by two "*" means, that all children and childrens children of this resource will match

   resource is "/example/level_1/myresource.gif"

 OTH_A specifies the path "/example/level_1"
 OTH_A is not valid for the resource, because its URI does not match the given path

 OTH_B specifies the path "/example/level_1/*" -> matches!

 OTH_C specifies the path "/example/*"
 OTH_C is not valid for the resource, because only children of "/example" would match

 OTH_D specifies the path "/example/**" -> matches!

 

Parameters:

resource - TODO: Description of the incoming method parameter

Returns:

The ObjectTypeHandler value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getObjectTypeHandler

IObjectTypeHandlerList getObjectTypeHandler(IResource resource,
                                            IActionType actionType)
                                            throws com.sapportals.wcm.WcmException

Gets the List of ObjectTypeHandlers which are valid for the given resource and which implement the wanted IActionType There are several internal filters realized a) resourceType b) mimeType (not for ICollection objects) c) extension (not for ICollection objects) d) actiontype In a first step, all ObjectTypeHandler for the RID of the resource are returned. Then the filters are applied in order a), b), c). If a resource doesn't have a resourcetype set, only oths that don't have a resource type specified are returned. If a resource has one or several resource types defined, the oths that have none or one matching resource tpye are valid. Other ones are filtered out. If the oths does not specify the IActionType requested, it will be filtered out The returned list of oths is not sorted.

Parameters:

resource - the resource that the action is needed for

actionType - the action requested

Returns:

The ObjectTypeHandler value

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

reload

void reload()
            throws com.sapportals.wcm.WcmException

Reloads all oth definitions.

Throws:

com.sapportals.wcm.WcmException - Exception raised in failure situation

getObjectTypeHandlerList

IObjectTypeHandlerList getObjectTypeHandlerList(Vector resourceTypes)
                                                throws com.sapportals.wcm.WcmException

Throws:

com.sapportals.wcm.WcmException

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