com.sapportals.wcm.control.util

Class PropertyRendererUser

java.lang.Object
  com.sapportals.wcm.control.util.AbstractPropertyRenderer
      com.sapportals.wcm.control.util.PropertyRendererUser

All Implemented Interfaces:

IPropertyRenderer, IRenderMetaName, IAccessibilityRenderer, IStructuredPropertyRenderer

Deprecated. As of NetWeaver 7.1

public class PropertyRendererUser
extends AbstractPropertyRenderer

The PropertyRendererUser is used to render properties of type USER

Copyright 2004 SAP AG

Field Summary

static String	EVENT_SELECT_USER Deprecated.
static Location	log Deprecated.

Fields inherited from class com.sapportals.wcm.control.util.AbstractPropertyRenderer

CID_PROPERTY_NAME, CID_PROPERTY_ROW, CID_PROPERTY_TIME_VALUE, CID_PROPERTY_VALUE, CM_DESCRIPTION, CM_RND_EXPLORER_URL, CM_RND_EXTERNAL_LINK, CM_RND_PATH, CM_RND_TARGET_URL, CM_RND_TARGET_URL_COPY, CM_RND_WEBDAV_URL, CM_RND_WEBDAV_URL_COPY, currentMetaName, DATE_FORMAT, DEFAULT_DATE_FORMAT, DEFAULT_DATE_TIME_FORMAT, DEFAULT_TIME_FORMAT, displayMode, EVENT_ADD_NEW_VALUE, EVENT_EDIT_HTML, labeledComponent, METATAG_NO_LABEL, RENDER_HTML, RES_ADD_NEW_VALUE, RES_EDIT_HTML

Constructor Summary

PropertyRendererUser()
Deprecated. As of NetWeaver 7.1

Method Summary

static String	getDisplayName(IPrincipal principal) Deprecated. As of NetWeaver 7.1
static String	getDisplayName(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Deprecated. As of NetWeaver 7.1, replaced by getDisplayName(com.sap.security.api.IPrincipal)
IPropertyMap	getProperties(IMetaName metaName, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) Deprecated. As of NetWeaver 7.1
static String	getUserDisplayName(String userID) Deprecated. As of NetWeaver 7.1
String[]	processEvent(IMetaName metaName, com.sapportals.htmlb.event.Event event, IMetaContext rendererContext, com.sapportals.htmlb.page.DynPage dynPage) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderMetaProperty(IMetaName metaName, IMetaContext rendererContext) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderProperty(IProperty property, IResource res, int maxLength) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderUser(IPrincipal principal) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderUser(IPrincipal principal, int maxLength) Deprecated. As of NetWeaver 7.1
com.sapportals.htmlb.Component	renderUser(com.sapportals.portal.security.usermanagement.IUMPrincipal principal) Deprecated. As of NetWeaver 7.1, replaced by renderUser(com.sap.security.api.IPrincipal)
com.sapportals.htmlb.Component	renderUser(com.sapportals.portal.security.usermanagement.IUMPrincipal principal, int maxLength) Deprecated. As of NetWeaver 7.1, replaced by renderUser(com.sap.security.api.IPrincipal,int)
com.sapportals.htmlb.Component	renderUser(String userID) Deprecated. As of NetWeaver 7.1
static com.sapportals.htmlb.Component	renderUserLink(String userID) Deprecated. As of NetWeaver 7.1

Methods inherited from class com.sapportals.wcm.control.util.AbstractPropertyRenderer

getBundle, getCurrentMetaName, getLabeledComponent, getProperty, getPropertyTooltip, getPropertyType, getResourceContext, is508Required, isEditable, isEditable, renderMetaNameLabel, renderProperty, renderSpacing, set508Required, setCurrentMetaName, setDisplayMode, setResourceContext

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

EVENT_SELECT_USER

public static final String EVENT_SELECT_USER

Deprecated.

See Also:

Constant Field Values

log

public static Location log

Deprecated.

Constructor Detail

PropertyRendererUser

public PropertyRendererUser()

Deprecated. As of NetWeaver 7.1

Construct object of class PropertyRendererUser. *

Method Detail

renderUser

public com.sapportals.htmlb.Component renderUser(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)

Deprecated. As of NetWeaver 7.1, replaced by renderUser(com.sap.security.api.IPrincipal)

Renders a link to the Businesscard to the user

Parameters:

principal -

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

renderUser

public com.sapportals.htmlb.Component renderUser(IPrincipal principal)

Deprecated. As of NetWeaver 7.1

Renders a link to the Businesscard to the user

Parameters:

principal -

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

Since:

NetWeaver 7.1

renderUser

public com.sapportals.htmlb.Component renderUser(com.sapportals.portal.security.usermanagement.IUMPrincipal principal,
                                                 int maxLength)

Deprecated. As of NetWeaver 7.1, replaced by renderUser(com.sap.security.api.IPrincipal,int)

Renders a link to the Businesscard to the user

Parameters:

maxLength - max. Length of the user

principal -

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

renderUser

public com.sapportals.htmlb.Component renderUser(IPrincipal principal,
                                                 int maxLength)

Deprecated. As of NetWeaver 7.1

Renders a link to the Businesscard to the user

Parameters:

maxLength - max. Length of the user

principal -

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

Since:

NetWeaver 7.1

renderUserLink

public static com.sapportals.htmlb.Component renderUserLink(String userID)

Deprecated. As of NetWeaver 7.1

Renders a link to the Businesscard to the user

Parameters:

userID - Description of the Parameter

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

renderUser

public com.sapportals.htmlb.Component renderUser(String userID)

Deprecated. As of NetWeaver 7.1

Renders a link to the Businesscard to the user

Parameters:

userID - Description of the Parameter

Returns:

Username with Link to Businesscard if possible TODO: Description of the incoming method parameter

renderProperty

public com.sapportals.htmlb.Component renderProperty(IProperty property,
                                                     IResource res,
                                                     int maxLength)

Deprecated. As of NetWeaver 7.1

renders the link to the businesscard for a user property

Specified by:

renderProperty in interface IPropertyRenderer

Overrides:

renderProperty in class AbstractPropertyRenderer

Parameters:

property - property to render containing a userID as sting

res - a resource (not necessary here)

maxLength - max. Length for the text

Returns:

Username with Link to Businesscard if possible

getDisplayName

public static String getDisplayName(com.sapportals.portal.security.usermanagement.IUMPrincipal principal)

Deprecated. As of NetWeaver 7.1, replaced by getDisplayName(com.sap.security.api.IPrincipal)

Get the DisplayName attribute of the PropertyRendererUser object.

Parameters:

principal -

Returns:

The DisplayName value TODO: Description of the incoming method parameter TODO: Description of the incoming method parameter

getDisplayName

public static String getDisplayName(IPrincipal principal)

Deprecated. As of NetWeaver 7.1

Get the DisplayName attribute of the PropertyRendererUser object.

Parameters:

principal -

Returns:

The DisplayName value TODO: Description of the incoming method parameter TODO: Description of the incoming method parameter

Since:

NetWeaver 7.1

getUserDisplayName

public static String getUserDisplayName(String userID)

Deprecated. As of NetWeaver 7.1

renderMetaProperty

public com.sapportals.htmlb.Component renderMetaProperty(IMetaName metaName,
                                                         IMetaContext rendererContext)
                                                  throws WcmException

Deprecated. As of NetWeaver 7.1

Description copied from class: AbstractPropertyRenderer

Display only for read-only properties

Specified by:

renderMetaProperty in interface IStructuredPropertyRenderer

Overrides:

renderMetaProperty in class AbstractPropertyRenderer

Parameters:

metaName - Description of the Parameter

rendererContext - Description of the Parameter

Returns:

Description of the Return Value

Throws:

WcmException - Description of the Exception

getProperties

public IPropertyMap getProperties(IMetaName metaName,
                                  IMetaContext rendererContext,
                                  com.sapportals.htmlb.page.DynPage dynPage)
                           throws WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IStructuredPropertyRenderer

Gets the properties with their entered values after the response has been returned. The method will be call by every summit event and it should read the generated htmlb Component from the DynPage, the the input value, and validate and create a IProperty for this IMetaName. If the input value is invalid then it will created a IProperty with empty value like it follows :
Properties errorProperties = new Properties(); errorProperties.setProperty(metaName.getId(), value); currentProperty = new Property(new PropertyName(metaName.getNamespace(), metaName.getName()), "", errorProperties); This IProperty will be added into a IPropertyMap and it will be shown as invalid input. The returned IPropertyMap could have one or more IProperty according with the property renderer logic.

Specified by:

getProperties in interface IStructuredPropertyRenderer

Overrides:

getProperties in class AbstractPropertyRenderer

Parameters:

metaName - the given IMetaName for which the property will be created

rendererContext - - contains the rendering information: which IResourceContext, IResource or PropertyDisplayMode

dynPage - htmlb dynpage that contains the response document

Returns:

map of properties. null is accepted

Throws:

WcmException

processEvent

public String[] processEvent(IMetaName metaName,
                             com.sapportals.htmlb.event.Event event,
                             IMetaContext rendererContext,
                             com.sapportals.htmlb.page.DynPage dynPage)
                      throws WcmException

Deprecated. As of NetWeaver 7.1

Description copied from interface: IStructuredPropertyRenderer

The property renderer can react to events. If this is not whished then this mehode can return null. The Event should be decode using rendererContext.getRendererProxy().decodeValues(event); If the ArrayList is not empty then the first value from it is the action as String. If the action is known by the renderer then the logic should be implemented If something fails then one or more error messages should be returns as String array

Specified by:

processEvent in interface IStructuredPropertyRenderer

Overrides:

processEvent in class AbstractPropertyRenderer

Parameters:

metaName - the given IMetaName for which the renderer is called

event - the Event which has encoded the action and other value which will be process by the renderer

rendererContext - context information for the renderer

dynPage - htmlb dynpage that contains the response document

Returns:

localized error messages or null

Throws:

WcmException

Access Rights

This class can be accessed from:

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