javax.portlet.annotations

Annotation Type UserAttribute

@Retention(value=RUNTIME)
 @Target(value=ANNOTATION_TYPE)
public @interface UserAttribute

This annotation is used within composite portlet configuration annotations to represent a single user attribute. It cannot be used as a stand-alone portlet annotation.

Since:

3.0

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	name The user attribute name.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
LocaleString[]	description Provides locale-specific text describing the user attribute for use by the portal application or by tools.

Element Detail

name

public abstract String name

The user attribute name.

Returns:

The public render parameter identifier

description

public abstract LocaleString[] description

Provides locale-specific text describing the user attribute for use by the portal application or by tools.

Returns:

The user attribute description

Default:

{}