SAP NetWeaver '04

com.sapportals.wcm.service.xmlforms
Class ServletPostData

[contained in: com.sap.km.cm.service.base.par - km.shared.service.xmlforms_api.jar]
java.lang.Object
  |
  +--com.sapportals.wcm.service.xmlforms.ServletPostData
All Implemented Interfaces:
IPostData

public class ServletPostData
extends java.lang.Object
implements IPostData

Implementation of IPostData for a http servlet request. The mandatory fields are supposed to be listed in the request parameter mandatoryFields as a semicolon separated list. All servlet parameters are used as key value pairs. The class is public for compatibility reasons and should not be used from outside of the XML Forms framework. Copyright 2004 SAP AG


Constructor Summary
ServletPostData(javax.servlet.http.HttpServletRequest req)
           
 
Method Summary
 java.util.Set getIgnoreCheckFields()
          Get the properties and schema elements in this post, which are to be ignored by validation
 java.util.Set getKeys()
          Get the field keys in this data
 java.util.Set getMandatoryFields()
          Get the mandatory properties and schema elements in this post
 java.lang.String getValue(java.lang.String key)
          Get the String value for a given key
 java.lang.String[] getValueArray(java.lang.String key)
          Get the value array for a given key
 boolean supportsMultiValued()
          Check if this data support multi valued fields.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServletPostData

public ServletPostData(javax.servlet.http.HttpServletRequest req)
Method Detail

getMandatoryFields

public java.util.Set getMandatoryFields()
Description copied from interface: IPostData
Get the mandatory properties and schema elements in this post
Specified by:
getMandatoryFields in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Returns:
a Set containing all mandatory properties and schema elements. Properties start with a prefix wcmprop., then namespace alias and property name, e.g. wcmprop.default:displayname. Schema element paths start one level below schema root. Returning null means the same as returning an empty set.

getIgnoreCheckFields

public java.util.Set getIgnoreCheckFields()
Description copied from interface: IPostData
Get the properties and schema elements in this post, which are to be ignored by validation
Specified by:
getIgnoreCheckFields in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Returns:
a Set containing all properties and schema elements, which do not need to be validated. Properties start with a prefix wcmprop., then namespace alias and property name, e.g. wcmprop.default:displayname. Schema element paths start one level below schema root. Returning null means the same as returning an empty set.

supportsMultiValued

public boolean supportsMultiValued()
Description copied from interface: IPostData
Check if this data support multi valued fields. If it returns false, getValueArray must always return null.
Specified by:
supportsMultiValued in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Returns:
 

getKeys

public java.util.Set getKeys()
Description copied from interface: IPostData
Get the field keys in this data
Specified by:
getKeys in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Returns:
a Set containing all field keys. Properties start with a prefix wcmprop., then namespace alias and property name, e.g. wcmprop.default:displayname. Schema element paths start one level below schema root.

getValue

public java.lang.String getValue(java.lang.String key)
Description copied from interface: IPostData
Get the String value for a given key
Specified by:
getValue in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Parameters:
key -  
Returns:
if the data does not support multi valued fields, it returns the value String. If the data supports multi valued fields, it returns the first value in the value array, or null, if the value array is null or empty.

getValueArray

public java.lang.String[] getValueArray(java.lang.String key)
Description copied from interface: IPostData
Get the value array for a given key
Specified by:
getValueArray in interface IPostData
Following copied from interface: com.sapportals.wcm.service.xmlforms.IPostData
Parameters:
key -  
Returns:
an array of Strings with the values, or null, if this data does not support multi valued fields

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.