SAP NetWeaver '04

com.sapportals.wcm.service.objecttypehandler
Interface IObjectTypeHandler

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.oth_api.jar]
All Known Implementing Classes:
GenericObjectTypeHandler

public interface IObjectTypeHandler

TODO: Description of the interface.


Method Summary
 IActionList getActionList()
          Get the ActionList attribute of the IObjectTypeHandler object.
 java.lang.String[] getExtensions()
          Get the Extensions attribute of the IObjectTypeHandler object.
 java.util.Vector getMimeTypes()
          Get the MimeTypes attribute of the IObjectTypeHandler object.
 java.lang.String getName()
          Get the Name attribute of the IObjectTypeHandler object.
 java.lang.String[] getPaths()
          Get the Paths attribute of the IObjectTypeHandler object.
 java.lang.Integer getPathsHashCode()
          Returns identical values for identical paths arrays.
 java.util.Properties getProperties()
          Get the Properties attribute of the IObjectTypeHandler object.
 java.util.Vector getResourceTypes()
          Get the ResourceTypes attribute of the IObjectTypeHandler object.
 java.util.Vector getSourceResourceTypes()
          Get the resource types exclusively for a source.
 java.util.Vector getTargetResourceTypes()
          Get the resource types exclusively for a target.
 URL getURL(IResource resource, IActionType actionType)
          Get the URL attribute of the IObjectTypeHandler object.
 URL getURL(IResource resource, IActionType actionType, java.util.Properties props)
          Get the URL attribute of the IObjectTypeHandler object.
 void initialize(java.lang.String name, java.util.Vector extensions, java.util.Vector mimeTypes, java.util.Vector paths, IActionList actionList, java.util.Vector resourceTypes, java.util.Properties props)
          TODO: Description of the Method.
 boolean matches(java.lang.String needle)
          Checks if the input string matches the paths of the object.
 boolean matchesResourceType(java.lang.String testResourceType, java.lang.String othResourceType)
          Checks if testResourceType<\code> matches the othResourceType <\code>.
 

Method Detail

initialize

public void initialize(java.lang.String name,
                       java.util.Vector extensions,
                       java.util.Vector mimeTypes,
                       java.util.Vector paths,
                       IActionList actionList,
                       java.util.Vector resourceTypes,
                       java.util.Properties props)
                throws WcmException
TODO: Description of the Method.
Parameters:
name - TODO: Description of the incoming method parameter
extensions - TODO: Description of the incoming method parameter
mimeTypes - TODO: Description of the incoming method parameter
paths - TODO: Description of the incoming method parameter
actionList - TODO: Description of the incoming method parameter
props - TODO: Description of the incoming method parameter
resourceTypes - TBD: Description of the incoming method parameter
Throws:
WcmException - Exception raised in failure situation

getName

public java.lang.String getName()
                         throws WcmException
Get the Name attribute of the IObjectTypeHandler object.
Returns:
The Name value
Throws:
WcmException - Exception raised in failure situation

getURL

public URL getURL(IResource resource,
                  IActionType actionType)
           throws WcmException
Get the URL attribute of the IObjectTypeHandler object.
Parameters:
resource - TODO: Description of the incoming method parameter
actionType - TODO: Description of the incoming method parameter
Returns:
The URL value
Throws:
WcmException - Exception raised in failure situation

getURL

public URL getURL(IResource resource,
                  IActionType actionType,
                  java.util.Properties props)
           throws WcmException
Get the URL attribute of the IObjectTypeHandler object.
Parameters:
resource - TODO: Description of the incoming method parameter
actionType - TODO: Description of the incoming method parameter
props - TODO: Description of the incoming method parameter
Returns:
The URL value
Throws:
WcmException - Exception raised in failure situation

getActionList

public IActionList getActionList()
Get the ActionList attribute of the IObjectTypeHandler object.
Returns:
The ActionList value

getExtensions

public java.lang.String[] getExtensions()
Get the Extensions attribute of the IObjectTypeHandler object.
Returns:
The Extensions value

getMimeTypes

public java.util.Vector getMimeTypes()
Get the MimeTypes attribute of the IObjectTypeHandler object. The return vector holds instances of IMimeType
Returns:
The MimeTypes value, must not return null

getPaths

public java.lang.String[] getPaths()
Get the Paths attribute of the IObjectTypeHandler object.
Returns:
The Paths value

matches

public boolean matches(java.lang.String needle)
Checks if the input string matches the paths of the object.
Parameters:
needle - The input string.
Returns:
 

matchesResourceType

public boolean matchesResourceType(java.lang.String testResourceType,
                                   java.lang.String othResourceType)
Checks if testResourceType<\code> matches the othResourceType <\code>. Therefore othResourceType<\code> has to be one of the resource types of the object type handler.
Parameters:
testResourceType - resource type to be tested.
othResourceType - resource type against which to check.
Returns:
 

getPathsHashCode

public java.lang.Integer getPathsHashCode()
Returns identical values for identical paths arrays.
Returns:
 

getProperties

public java.util.Properties getProperties()
Get the Properties attribute of the IObjectTypeHandler object.
Returns:
The Properties value

getResourceTypes

public java.util.Vector getResourceTypes()
Get the ResourceTypes attribute of the IObjectTypeHandler object. The return vector holds instances of IResourceType
Returns:
The ResourceTypes value, must not return null

getSourceResourceTypes

public java.util.Vector getSourceResourceTypes()
Get the resource types exclusively for a source. The return vector holds instances of IResourceType
Returns:
The ResourceTypes value, must not return null

getTargetResourceTypes

public java.util.Vector getTargetResourceTypes()
Get the resource types exclusively for a target. The return vector holds instances of IResourceType
Returns:
The ResourceTypes value, must not return null

SAP NetWeaver '04

Copyright © 2004 by SAP AG. All Rights Reserved.
SAP, R/3, mySAP, mySAP.com, xApps, xApp, SAP NetWeaver, and other SAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and in several other countries all over the world. All other product and service names mentioned are the trademarks of their respective companies. Data contained in this document serves informational purposes only. National product specifications may vary.

These materials are subject to change without notice. These materials are provided by SAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not be liable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the express warranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty.