SAP NetWeaver '04

com.sapportals.wcm.service.objecttypehandler
Class GenericObjectTypeHandler

[contained in: com.sap.netweaver.bc.rf.service.par - bc.rf.global.service.oth_api.jar]
java.lang.Object
  |
  +--com.sapportals.wcm.WcmObject
        |
        +--com.sapportals.wcm.service.objecttypehandler.GenericObjectTypeHandler
All Implemented Interfaces:
IObjectTypeHandler

public class GenericObjectTypeHandler
extends WcmObject
implements IObjectTypeHandler


Field Summary
protected  IActionList actionList
           
protected  java.lang.String[] extensionArray
           
protected  java.util.Vector extensions
           
protected  java.util.Vector mimeTypes
           
protected  java.lang.String name
           
protected  java.lang.String[] pathArray
           
protected  java.util.Vector paths
           
protected  java.util.Properties properties
           
protected  java.util.Vector resourceTypes
           
 
Fields inherited from class com.sapportals.wcm.WcmObject
ORDER_TYPE_MANUAL, ORDER_TYPE_NONE
 
Constructor Summary
GenericObjectTypeHandler()
          Construct object of class GenericObjectTypeHandler.
 
Method Summary
 IActionList getActionList()
          Get the ActionList attribute of the GenericObjectTypeHandler object.
 java.lang.String[] getExtensions()
          Get the Extensions attribute of the GenericObjectTypeHandler object.
 java.util.Vector getMimeTypes()
          Get the MimeTypes attribute of the GenericObjectTypeHandler object.
 java.lang.String getName()
          Get the Name attribute of the GenericObjectTypeHandler object.
 java.lang.String[] getPaths()
          Get the Paths attribute of the GenericObjectTypeHandler object.
 java.lang.Integer getPathsHashCode()
          Returns identical values for identical paths arrays.
 java.util.Properties getProperties()
          Get the Properties attribute of the GenericObjectTypeHandler object.
 java.util.Vector getResourceTypes()
          Get the Properties attribute of the GenericObjectTypeHandler 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 GenericObjectTypeHandler object.
 URL getURL(IResource resource, IActionType actionType, java.util.Properties props)
          Get the URL attribute of the GenericObjectTypeHandler 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)
          TBD: 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>.
 void setActionList(IActionList actionList)
          Set the ActionList attribute of the GenericObjectTypeHandler object.
 void setExtensions(java.util.Vector extensions)
          Set the Extensions attribute of the GenericObjectTypeHandler object.
 void setMimeTypes(java.util.Vector mimeTypes)
          Set the MimeTypes attribute of the GenericObjectTypeHandler object.
 void setName(java.lang.String name)
          Set the Name attribute of the GenericObjectTypeHandler object.
 void setPaths(java.util.Vector paths)
          Set the Paths attribute of the GenericObjectTypeHandler object.
 void setProperties(java.util.Properties props)
          Set the Properties attribute of the GenericObjectTypeHandler object.
 void setResourceTypes(java.util.Vector resourceTypes)
          Set the Properties attribute of the GenericObjectTypeHandler object.
 void startUpOTH()
          Must be called in startUp() method of an OTH service.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected java.lang.String name

resourceTypes

protected java.util.Vector resourceTypes

extensions

protected java.util.Vector extensions

mimeTypes

protected java.util.Vector mimeTypes

paths

protected java.util.Vector paths

properties

protected java.util.Properties properties

extensionArray

protected java.lang.String[] extensionArray

pathArray

protected java.lang.String[] pathArray

actionList

protected IActionList actionList
Constructor Detail

GenericObjectTypeHandler

public GenericObjectTypeHandler()
                         throws WcmException
Construct object of class GenericObjectTypeHandler.
Throws:
WcmException - Exception raised in failure situation
Method Detail

setName

public void setName(java.lang.String name)
Set the Name attribute of the GenericObjectTypeHandler object.
Parameters:
name - The new Name value

setActionList

public void setActionList(IActionList actionList)
Set the ActionList attribute of the GenericObjectTypeHandler object.
Parameters:
actionList - The new ActionList value

setResourceTypes

public void setResourceTypes(java.util.Vector resourceTypes)
Set the Properties attribute of the GenericObjectTypeHandler object.
Parameters:
resourceTypes - resourceTypes to be set

setProperties

public void setProperties(java.util.Properties props)
Set the Properties attribute of the GenericObjectTypeHandler object.
Parameters:
props - properties to be set

setExtensions

public void setExtensions(java.util.Vector extensions)
Set the Extensions attribute of the GenericObjectTypeHandler object.
Parameters:
extensions - The new Extensions value

setMimeTypes

public void setMimeTypes(java.util.Vector mimeTypes)
Set the MimeTypes attribute of the GenericObjectTypeHandler object.
Parameters:
mimeTypes - The new MimeTypes value

setPaths

public void setPaths(java.util.Vector paths)
Set the Paths attribute of the GenericObjectTypeHandler object.
Parameters:
paths - The new Paths value

matches

public boolean matches(java.lang.String needle)
Description copied from interface: IObjectTypeHandler
Checks if the input string matches the paths of the object.
Specified by:
matches in interface IObjectTypeHandler
Following copied from interface: com.sapportals.wcm.service.objecttypehandler.IObjectTypeHandler
Parameters:
needle - The input string.
Returns:
 

matchesResourceType

public boolean matchesResourceType(java.lang.String testResourceType,
                                   java.lang.String othResourceType)
Description copied from interface: IObjectTypeHandler
Checks if testResourceType<\code> matches the othResourceType <\code>. Therefore othResourceType<\code> has to be one of the resource types of the object type handler.
Specified by:
matchesResourceType in interface IObjectTypeHandler
Following copied from interface: com.sapportals.wcm.service.objecttypehandler.IObjectTypeHandler
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.
Specified by:
getPathsHashCode in interface IObjectTypeHandler
Returns:
 

getName

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

getActionList

public IActionList getActionList()
Get the ActionList attribute of the GenericObjectTypeHandler object.
Specified by:
getActionList in interface IObjectTypeHandler
Returns:
The ActionList value

getURL

public URL getURL(IResource resource,
                  IActionType actionType)
           throws WcmException
Get the URL attribute of the GenericObjectTypeHandler object.
Specified by:
getURL in interface IObjectTypeHandler
Parameters:
resource - TBD: Description of the incoming method parameter
actionType - TBD: 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 GenericObjectTypeHandler object.
Specified by:
getURL in interface IObjectTypeHandler
Parameters:
resource - TBD: Description of the incoming method parameter
actionType - TBD: Description of the incoming method parameter
props - TBD: Description of the incoming method parameter
Returns:
The URL value
Throws:
WcmException - Exception raised in failure situation

getResourceTypes

public java.util.Vector getResourceTypes()
Get the Properties attribute of the GenericObjectTypeHandler object.
Specified by:
getResourceTypes in interface IObjectTypeHandler
Returns:
The Properties value

getSourceResourceTypes

public java.util.Vector getSourceResourceTypes()
Description copied from interface: IObjectTypeHandler
Get the resource types exclusively for a source. The return vector holds instances of IResourceType
Specified by:
getSourceResourceTypes in interface IObjectTypeHandler
Following copied from interface: com.sapportals.wcm.service.objecttypehandler.IObjectTypeHandler
Returns:
The ResourceTypes value, must not return null

getTargetResourceTypes

public java.util.Vector getTargetResourceTypes()
Description copied from interface: IObjectTypeHandler
Get the resource types exclusively for a target. The return vector holds instances of IResourceType
Specified by:
getTargetResourceTypes in interface IObjectTypeHandler
Following copied from interface: com.sapportals.wcm.service.objecttypehandler.IObjectTypeHandler
Returns:
The ResourceTypes value, must not return null

getProperties

public java.util.Properties getProperties()
Get the Properties attribute of the GenericObjectTypeHandler object.
Specified by:
getProperties in interface IObjectTypeHandler
Returns:
The Properties value

getExtensions

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

getMimeTypes

public java.util.Vector getMimeTypes()
Get the MimeTypes attribute of the GenericObjectTypeHandler object.
Specified by:
getMimeTypes in interface IObjectTypeHandler
Returns:
The MimeTypes value

getPaths

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

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
TBD: Description of the Method.
Specified by:
initialize in interface IObjectTypeHandler
Parameters:
name - TBD: Description of the incoming method parameter
extensions - TBD: Description of the incoming method parameter
mimeTypes - TBD: Description of the incoming method parameter
paths - TBD: Description of the incoming method parameter
actionList - TBD: Description of the incoming method parameter
props - TBD: Description of the incoming method parameter
resourceTypes - TBD: Description of the incoming method parameter
Throws:
WcmException - Exception raised in failure situation

startUpOTH

public void startUpOTH()
                throws WcmException
Must be called in startUp() method of an OTH service. Gets a reference to the URLGenerator Service.
Throws:
WcmException - Exception raised in failure situation

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.