com.sapportals.portal.prt.event

Interface IPortalRequestEventData


public interface IPortalRequestEventData

The IPortalComponentEventData represents a set of multi-valued attributes that are attached to a IPortalRequestEvent.


Method Summary
 void add(String attribute, String value)
          add an attribute with value.
 String getAttribute(String name)
          Return the value of an attributes Note: If the attribute is multi-valued, any one the values can be the result of a call to this method.
 String[] getAttributeNames()
          Gets the attributes names as an array.
 Enumeration getAttributesEnumeration()
          Gets an Enumeration of attributes names.
 String[] getAttributeValues(String name)
          gets the attributes values associated to a specific name.
 Iterator getAttributeValuesIterator(String name)
          Gets an iterator on the values associated to a name.
 void remove(String attribute)
          remove an attribute with all values.
 void remove(String attribute, String value)
          remove an attribute/value combination from this event's data.
 String toFormEncodedString()
          Gets this PortalComponentEventData as a Form Encoded String.
 

Method Detail

add

void add(String attribute,
         String value)
add an attribute with value. Note: attributes can be multi-valued

Parameters:
attribute - The name of the attribute.
value - The value of the attribute to be added

remove

void remove(String attribute)
remove an attribute with all values.

Parameters:
attribute - The name of the attribute.

remove

void remove(String attribute,
            String value)
remove an attribute/value combination from this event's data.

Parameters:
attribute - The name of the attribute.
value - The value of the attribute to be removed.

getAttributesEnumeration

Enumeration getAttributesEnumeration()
Gets an Enumeration of attributes names.

Returns:
An Enumeration of attribute names.

getAttributeNames

String[] getAttributeNames()
Gets the attributes names as an array.

Returns:
An array of attribute names.

getAttributeValues

String[] getAttributeValues(String name)
gets the attributes values associated to a specific name.

Parameters:
name - The name of the queried attribute
Returns:
An array of values of an attribute.

getAttributeValuesIterator

Iterator getAttributeValuesIterator(String name)
Gets an iterator on the values associated to a name.

Parameters:
name - The name of the queried attribute
Returns:
An Iterator over the values of an attribute.

getAttribute

String getAttribute(String name)
Return the value of an attributes Note: If the attribute is multi-valued, any one the values can be the result of a call to this method.

Parameters:
name -
Returns:
A single value of an attribute.

toFormEncodedString

String toFormEncodedString()
Gets this PortalComponentEventData as a Form Encoded String. For example, if we have attributes a and b with value {"Hey You", "4"} for a and "go" for b we possibly get: "a=Hey%20You&a=4&b=go".

Returns:
This PortalComponentEventData as a Form Encoded String.
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] EP-BASIS-API [sap.com] epbc.prtapi._apideprecated default EP-PIN-PRT
[sap.com] EP-BASIS-API [sap.com] tc/epbc/prt/api api EP-PIN
[sap.com] EP-BASIS-API [sap.com] tc/epbc/prt/lib/api api EP-PIN
[sap.com] EP-RUNTIME [sap.com] tc/ep/semantics/api api EP-PIN
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM


Copyright 2015 SAP AG Complete Copyright Notice