com.sapportals.wcm.service.xmlforms

Class ServletPostData

java.lang.Object
  com.sapportals.wcm.service.xmlforms.ServletPostData

All Implemented Interfaces:

IPostData

public class ServletPostData
extends 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(HttpServletRequest req)

Method Summary

Set	getIgnoreCheckFields() Get the properties and schema elements in this post, which are to be ignored by validation
Set	getKeys() Get the field keys in this data
Set	getMandatoryFields() Get the mandatory properties and schema elements in this post
String	getValue(String key) Get the String value for a given key
String[]	getValueArray(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(HttpServletRequest req)

Method Detail

getMandatoryFields

public Set getMandatoryFields()

Description copied from interface: IPostData

Get the mandatory properties and schema elements in this post

Specified by:

getMandatoryFields in interface 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 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

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

Returns:

getKeys

public Set getKeys()

Description copied from interface: IPostData

Get the field keys in this data

Specified by:

getKeys in interface 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 String getValue(String key)

Description copied from interface: IPostData

Get the String value for a given key

Specified by:

getValue in interface IPostData

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 String[] getValueArray(String key)

Description copied from interface: IPostData

Get the value array for a given key

Specified by:

getValueArray in interface IPostData

Returns:

an array of Strings with the values, or null, if this data does not support multi valued fields

Access Rights

This class can be accessed from:

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