com.sapportals.portal.prt.component

Interface IPortalComponentProfile

public interface IPortalComponentProfile

The IPortalComponentProfile represents a set of properties that are attached to a component.

The current component profile is available within the component context provided by the IPortalComponentRequest interface.

Example:
A component can get its current profile like below :
public void doContent(IPortalComponentRequest request, IPortalComponentResponse response) ...
{
IPortalComponentProfile profile = request.getComponentContext().getProfile();
...
String country = profile.getProperty("Country");
String levelString = profile.getProperty(IPortalComponentProfile.PROFILE_KEY_CACHINGLEVEL);
...
}


See Also:

IPortalComponentRequest, IPortalComponentContext

Field Summary

static String	DEFAULT_RESOURCE_BUNDLE Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_ATTRIBUTE_DESCRIPTION A description to a property is used in personalization dialogues (e.g.).
static String	PROFILE_ATTRIBUTE_FINAL Deprecated. Please use the PROFILE_ATTRIBUTE_INHERITANCE attribute instead.
static String	PROFILE_ATTRIBUTE_INHERITANCE Deprecated. Do not use
static String	PROFILE_ATTRIBUTE_INHERITANCE_FINAL Deprecated. Do not use
static String	PROFILE_ATTRIBUTE_PERSONALIZABLE Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.
static String	PROFILE_ATTRIBUTE_PERSONALIZATION This attribute specifies personalization handling of a corresponding property.
static String	PROFILE_ATTRIBUTE_PERSONALIZATION_DIALOG If the property attribute PROFILE_ATTRIBUTE_PERSONALIZATION has this value, it means that the property should appear in shared personalization dialogs.
static String	PROFILE_ATTRIBUTE_PLAINDESCRIPTION A plain description of a property is a non-translated textual description used in personalization dialogues, if no other description is available
static String	PROFILE_ATTRIBUTE_TYPE A type of an attribute can be any of the following values:
static String	PROFILE_ATTRIBUTE_USERSPECIFIC Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.
static String	PROFILE_ATTRIBUTE_VALUE The actual value of a property
static String	PROFILE_KEY_AUTHREQUIREMENT Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_CACHINGLEVEL Key for caching level.
static String	PROFILE_KEY_CLASSNAME Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_CODELINK Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_CONTENTLINK Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_CONTENTTYPE Specification of the mime type of the content provided by the Portal Component unless specified differently on IPortalComponentResponse.
static String	PROFILE_KEY_DESCRIPTION Key for the description of the component
static String	PROFILE_KEY_DETAILLINK Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_DEVICETYPE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_HEIGHT Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_HELPNAME Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_ISVISIBLE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_JSP Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_LOCALMODEALLOWED Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_MINTIMETOLIVE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_PERSONALIZATIONBEHAVIOR Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_PERSONALIZATIONCLASS Deprecated. Please use the mode delegation mechanism.
static String	PROFILE_KEY_PERSONALIZATIONLINK Contains a URL+ pointing to a page that allows to reach a specific enduser personalization dialog service.
static String	PROFILE_KEY_PORTALCOMPONENTTYPE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_PREFERREDSIZE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_REQUIREISOLATION Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_RESOURCEBUNDLENAME Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_SERVICESREF Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions. Also, it is deprecated in meaning by the Application Packaging, since version 6.
static String	PROFILE_KEY_SHARINGACCESS Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_KEY_SHARINGREF Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_KEY_SUPPORTATTRIBUTES Contains some attributes that helps to support the iView.
static String	PROFILE_KEY_SUPPORTLINK Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_SYSTEMPRIVILEGE Deprecated. Do not use.
static String	PROFILE_KEY_TITLE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_TRAYSTATE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_TRAYTYPE Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_WIDTH Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_XSL Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_KEY_XSLLINK Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static String	PROFILE_PORTALCOMPONENTTYPE_JSP Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_PORTALCOMPONENTTYPE_SERVLET Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_SHARING_SHARED Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static String	PROFILE_SHARING_SYSTEM Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Method Summary

Enumeration	getAttributeNames() Deprecated. For more consistency this method has been deprecated. The component should now use the getProperties method instead.
String	getAttributeValue(String key) Deprecated. For more consistency this method has been deprecated. The component should now use the getProperty method instead.
String	getClassName() Deprecated. The information provided by this method should be obtained from IPortalComponentConfig if needed.
String	getCodeLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getComponentName() Deprecated. Please use the corresponding method on IPortalComponentContext.
String	getContentLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getContentType() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getDescription() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getDetailLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getDeviceType() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getHelpName() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getLocalDeploymentFolder() Deprecated. Please use corresponding methods on IPortalComponentRequest or PortalRuntime.
String	getPersonalizationLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getProfileName() Deprecated. Please use getProperty(String) with the appropriate constant instead.
Enumeration	getProperties() returns an Enumeration of the properties name.
String	getProperty(String key) returns the string value corresponding to the key or null if this property is not defined..
String	getPropertyAttribute(String propertyName, String attributeName) Gets the value of an attribute.
Enumeration	getPropertyAttributes(String propertyName) Gets an enumeration of all attributes of the property
IPropertyDescriptor	getPropertyDescriptor(String propertyName) Deprecated. The component should now use the getPropertyAttribute method instead.
String	getResourceBundleName() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getSupportAttributes() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getSupportLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getTitle() Deprecated. Please use getProperty(String) with the appropriate constant instead.
Object	getValue(String name) Deprecated. Please use the corresponding method on IPortalComponentContext instead.
String	getXSL() Deprecated. Please use getProperty(String) with the appropriate constant instead.
String	getXSLLink() Deprecated. Please use getProperty(String) with the appropriate constant instead.
boolean	isPersonalizableProperty(String key) returns true if the Property can be customized by the user.
boolean	isVisible() Deprecated. Please use getProperty(String) with the appropriate constant instead.
void	putValue(String name, Object value) Deprecated. Please use the corresponding method on IPortalComponentContext instead.
void	removeValue(String name) Deprecated. Please use the corresponding method on IPortalComponentContext instead.
boolean	requireIsolation() Deprecated. Please use getProperty(String) with the appropriate constant instead.
void	resetProperty(String key) Resets the value of the property to its default value.
void	setAttributeValue(String key, String value) Deprecated. For more consistency this method has been deprecated. The component should now use the setProperty method instead.
void	setProperty(String key, String value) sets the value of the property.
void	store() Makes the PortalComponentProfile persistent

Field Detail

PROFILE_KEY_AUTHREQUIREMENT

static final String PROFILE_KEY_AUTHREQUIREMENT

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

The authorization requirement. 3 values are allowed : admin : the user needs to be logged as admin to execute the iView. user : the user needs to be logged to execute the iView. none : the user does not need to be logged to execute the iView.

See Also:

Constant Field Values

PROFILE_KEY_CACHINGLEVEL

static final String PROFILE_KEY_CACHINGLEVEL

Key for caching level.

See Also:

ICachablePortalComponent, Constant Field Values

PROFILE_KEY_CLASSNAME

static final String PROFILE_KEY_CLASSNAME

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This key defines the java class name which implements the component.

See Also:

Constant Field Values

PROFILE_KEY_CODELINK

static final String PROFILE_KEY_CODELINK

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Internal system property

See Also:

Constant Field Values

PROFILE_KEY_CONTENTLINK

static final String PROFILE_KEY_CONTENTLINK

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Link to an external content source (of type HTML or XML corresponding to selected Java class) e.g. if you want to get the content of an external HTML-Webpage into the iView, ClassName has to contain the name of the http-proxy Java class.

See Also:

Constant Field Values

PROFILE_KEY_CONTENTTYPE

static final String PROFILE_KEY_CONTENTTYPE

Specification of the mime type of the content provided by the Portal Component unless specified differently on IPortalComponentResponse.

See Also:

Constant Field Values

PROFILE_KEY_DESCRIPTION

static final String PROFILE_KEY_DESCRIPTION

Key for the description of the component

See Also:

Constant Field Values

PROFILE_KEY_HEIGHT

static final String PROFILE_KEY_HEIGHT

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Height of iView, including size unit (pixel, percentage, etc.)

See Also:

Constant Field Values

PROFILE_KEY_JSP

static final String PROFILE_KEY_JSP

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

The name of the JSP that will be compiled into a Portal Component (pagelet approach).

See Also:

Constant Field Values

PROFILE_KEY_LOCALMODEALLOWED

static final String PROFILE_KEY_LOCALMODEALLOWED

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This defines whether PRT can switch to the local mode or not when the corresponding PCD Service is not found.

See Also:

Constant Field Values

PROFILE_KEY_PERSONALIZATIONLINK

static final String PROFILE_KEY_PERSONALIZATIONLINK

Contains a URL+ pointing to a page that allows to reach a specific enduser personalization dialog service.

See Also:

Constant Field Values

PROFILE_KEY_PERSONALIZATIONBEHAVIOR

static final String PROFILE_KEY_PERSONALIZATIONBEHAVIOR

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Determines which behavior the personalization dialog will have: maximize or not. Possible values: 'maximize' , 'inplace'

See Also:

Constant Field Values

PROFILE_KEY_PERSONALIZATIONCLASS

static final String PROFILE_KEY_PERSONALIZATIONCLASS

Deprecated. Please use the mode delegation mechanism.

Contains the name of a class implementing IPortalComponent to delegate personalization dialogue handling to.

See Also:

Constant Field Values

PROFILE_KEY_PORTALCOMPONENTTYPE

static final String PROFILE_KEY_PORTALCOMPONENTTYPE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Determines the type of Portal Components. For now this can be either PROFILE_PORTALCOMPONENTTYPE_SERVLET or PROFILE_PORTALCOMPONENTTYPE_JSP or PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE

See Also:

Constant Field Values

PROFILE_KEY_PREFERREDSIZE

static final String PROFILE_KEY_PREFERREDSIZE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

The standard templates for the column layout of the workplace page imply three predefined iViews widths (Narrow, Wide, SuperWide, FullSize) that should be selected by the iViews developer to enable easy reuse of iViews in different portals.

See Also:

Constant Field Values

PROFILE_KEY_RESOURCEBUNDLENAME

static final String PROFILE_KEY_RESOURCEBUNDLENAME

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

The name of the component's resource bundle. Defaults to "localization".

See Also:

Constant Field Values

PROFILE_KEY_REQUIREISOLATION

static final String PROFILE_KEY_REQUIREISOLATION

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Indicates whether to isolate the MiniApp in an IFrame from the rest of the page.

See Also:

Constant Field Values

PROFILE_KEY_SERVICESREF

static final String PROFILE_KEY_SERVICESREF

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions. Also, it is deprecated in meaning by the Application Packaging, since version 6.

Defines references to services used by a component.

See Also:

Constant Field Values

PROFILE_KEY_SHARINGACCESS

static final String PROFILE_KEY_SHARINGACCESS

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Determines access to this package using the SharingReference property. Can be "shared" or "final" Key that can be set to PROFILE_SHARING_SHARED if the component allows others to be dependent from it.

See Also:

Constant Field Values

PROFILE_KEY_SHARINGREF

static final String PROFILE_KEY_SHARINGREF

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Declare references onto another PortalComponent packages by a comma separated list of package names. If its returned value is equal to PROFILE_SHARING_SYSTEM, then the component has access to the core libraries.

See Also:

Constant Field Values

PROFILE_KEY_TITLE

static final String PROFILE_KEY_TITLE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This key defines the title of the component

See Also:

Constant Field Values

PROFILE_KEY_HELPNAME

static final String PROFILE_KEY_HELPNAME

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Name of the help files.

See Also:

Constant Field Values

PROFILE_KEY_ISVISIBLE

static final String PROFILE_KEY_ISVISIBLE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This property decides whether the Portal Component associated with this profile should be rendered on a portal page.

See Also:

Constant Field Values

PROFILE_KEY_XSL

static final String PROFILE_KEY_XSL

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

See Also:

Constant Field Values

PROFILE_KEY_DEVICETYPE

static final String PROFILE_KEY_DEVICETYPE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

See Also:

Constant Field Values

PROFILE_KEY_DETAILLINK

static final String PROFILE_KEY_DETAILLINK

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This property provides a URL that can be used to obtain more detailed information.

See Also:

Constant Field Values

PROFILE_KEY_SUPPORTLINK

static final String PROFILE_KEY_SUPPORTLINK

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Contains an URL pointing to support page of software supplier or vendor.

See Also:

Constant Field Values

PROFILE_KEY_SUPPORTATTRIBUTES

static final String PROFILE_KEY_SUPPORTATTRIBUTES

Contains some attributes that helps to support the iView.

See Also:

Constant Field Values

PROFILE_KEY_SYSTEMPRIVILEGE

static final String PROFILE_KEY_SYSTEMPRIVILEGE

Deprecated. Do not use.

See Also:

Constant Field Values

PROFILE_KEY_TRAYSTATE

static final String PROFILE_KEY_TRAYSTATE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Indicates if the component's output is displayed "normal" or "collapsed" (only tray header visible)

See Also:

Constant Field Values

PROFILE_KEY_TRAYTYPE

static final String PROFILE_KEY_TRAYTYPE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Type of tray the component's output should be displayed in.

See Also:

Constant Field Values

PROFILE_KEY_WIDTH

static final String PROFILE_KEY_WIDTH

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Width of component's output, including size unit.

See Also:

Constant Field Values

PROFILE_KEY_XSLLINK

static final String PROFILE_KEY_XSLLINK

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Contains an XSL link if the content link points to an XML source.

See Also:

Constant Field Values

PROFILE_KEY_MINTIMETOLIVE

static final String PROFILE_KEY_MINTIMETOLIVE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

This settings specifies how long a Portal Component should not be subject to any attempt to garbage collect it. In normal operation, garbage collection of Portal Components should occur under load and little free memory only. However, specifying a number of milliseconds as the value of this property will ensure the specified life time. Setting it to a negative value will assure that the portal component will not be dropped at all. Note: A release of a Portal Component by administrative tools or a release caused by a release of some other Portal Component that the respective Portal Component depends on will not be suppressed - whatever value is given for this property.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_TYPE

static final String PROFILE_ATTRIBUTE_TYPE

A type of an attribute can be any of the following values:

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_VALUE

static final String PROFILE_ATTRIBUTE_VALUE

The actual value of a property

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_DESCRIPTION

static final String PROFILE_ATTRIBUTE_DESCRIPTION

A description to a property is used in personalization dialogues (e.g.). The value of this attribute is used as a key in associated ResourceBundles.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_PLAINDESCRIPTION

static final String PROFILE_ATTRIBUTE_PLAINDESCRIPTION

A plain description of a property is a non-translated textual description used in personalization dialogues, if no other description is available

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_PERSONALIZABLE

static final String PROFILE_ATTRIBUTE_PERSONALIZABLE

Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.

If a property is personalizable, it will appear in personalization dialogues

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_FINAL

static final String PROFILE_ATTRIBUTE_FINAL

Deprecated. Please use the PROFILE_ATTRIBUTE_INHERITANCE attribute instead.

If a property is final, it cannot be overridden.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_PERSONALIZATION

static final String PROFILE_ATTRIBUTE_PERSONALIZATION

This attribute specifies personalization handling of a corresponding property.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_USERSPECIFIC

static final String PROFILE_ATTRIBUTE_USERSPECIFIC

Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.

If a property is user-specific, it will be kept in user-dependent copies.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_PERSONALIZATION_DIALOG

static final String PROFILE_ATTRIBUTE_PERSONALIZATION_DIALOG

If the property attribute PROFILE_ATTRIBUTE_PERSONALIZATION has this value, it means that the property should appear in shared personalization dialogs.

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_INHERITANCE

static final String PROFILE_ATTRIBUTE_INHERITANCE

Deprecated. Do not use

See Also:

Constant Field Values

PROFILE_ATTRIBUTE_INHERITANCE_FINAL

static final String PROFILE_ATTRIBUTE_INHERITANCE_FINAL

Deprecated. Do not use

See Also:

Constant Field Values

PROFILE_PORTALCOMPONENTTYPE_JSP

static final String PROFILE_PORTALCOMPONENTTYPE_JSP

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

One of the possible value for the Key PROFILE_KEY_PORTALCOMPONENTTYPE Means that the component includes a java server page into its content

See Also:

Constant Field Values

PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE

static final String PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

One of the possible value for the Key PROFILE_KEY_PORTALCOMPONENTTYPE Means that the component includes in its packaging (PAR file) a java server page

See Also:

Constant Field Values

PROFILE_SHARING_SYSTEM

static final String PROFILE_SHARING_SYSTEM

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Property which gives access to the core libraries. Example:
public void doContent(IPortalComponentRequest request, IPortalComponentResponse response) ...
{
IPortalComponentProfile profile = request.getComponentContext().getProfile();
...
String parentGroup = profile.getProperty(IPortalComponentProfile.PROFILE_KEY_SHARINGREF);
if parentGroup.equals(IPortalComponentProfile.PROFILE_SHARING_SYSTEM)
{
// This component has access to the core libraries.
}
}


See Also:

Constant Field Values

PROFILE_SHARING_SHARED

static final String PROFILE_SHARING_SHARED

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Example:
public void doContent(IPortalComponentRequest request, IPortalComponentResponse response) ...
{
IPortalComponentProfile profile = request.getComponentContext().getProfile();
...
String parentGroup = profile.getProperty(IPortalComponentProfile.PROFILE_KEY_SHARINGACCESS);
if parentGroup.equals(IPortalComponentProfile.PROFILE_SHARING_SHARED)
{
// This component allows others to be dependant
}
}
Allows other component to be dependent.

See Also:

Constant Field Values

PROFILE_PORTALCOMPONENTTYPE_SERVLET

static final String PROFILE_PORTALCOMPONENTTYPE_SERVLET

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

One of the possible value for the Key PROFILE_KEY_PORTALCOMPONENTTYPE Means that the component is an implementation of the javax.servlet.Servlet interface.

See Also:

Constant Field Values

DEFAULT_RESOURCE_BUNDLE

static final String DEFAULT_RESOURCE_BUNDLE

Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

See Also:

Constant Field Values

Method Detail

getProperties

Enumeration getProperties()

returns an Enumeration of the properties name.

getProperty

String getProperty(String key)

returns the string value corresponding to the key or null if this property is not defined..

Parameters:

key - the name of the property

Returns:

the string value of the property or null

isPersonalizableProperty

boolean isPersonalizableProperty(String key)

returns true if the Property can be customized by the user.

Parameters:

key - the name of the property

Returns:

true if Personalizable property, False otherwise

setProperty

void setProperty(String key,
                 String value)

sets the value of the property.

Parameters:

key - the name of the property.

value - the value of the attribute.

resetProperty

void resetProperty(String key)

Resets the value of the property to its default value.

Parameters:

key - the name of the property.

getPropertyAttributes

Enumeration getPropertyAttributes(String propertyName)

Gets an enumeration of all attributes of the property

Parameters:

propertyName - the name of the property

getPropertyAttribute

String getPropertyAttribute(String propertyName,
                            String attributeName)

Gets the value of an attribute. Each property has a set of attributes defining the property itself. The IPortalComponentProfile provides string constants for the standard attributes

Parameters:

propertyName - the name of the property

attributeName - the name of the attribute

See Also:

PROFILE_ATTRIBUTE_TYPE, PROFILE_ATTRIBUTE_DESCRIPTION, PROFILE_ATTRIBUTE_PLAINDESCRIPTION, PROFILE_ATTRIBUTE_FINAL, PROFILE_ATTRIBUTE_PERSONALIZABLE, PROFILE_ATTRIBUTE_VALUE

store

void store()
           throws PortalRuntimeException

Makes the PortalComponentProfile persistent

Throws:

PortalRuntimeException - if the profile can not be stored.

getComponentName

String getComponentName()

Deprecated. Please use the corresponding method on IPortalComponentContext.

returns the name of the master component

getLocalDeploymentFolder

String getLocalDeploymentFolder()

Deprecated. Please use corresponding methods on IPortalComponentRequest or PortalRuntime.

gets the path of the local deployment

getAttributeNames

Enumeration getAttributeNames()

Deprecated. For more consistency this method has been deprecated. The component should now use the getProperties method instead.

returns an Enumeration of the attributes name.

getAttributeValue

String getAttributeValue(String key)

Deprecated. For more consistency this method has been deprecated. The component should now use the getProperty method instead.

returns a String value corresponding to the provided key.

Parameters:

key - the name of the attribute

Returns:

the value of the attribute of the given key

See Also:

getProperty(String)

setAttributeValue

void setAttributeValue(String key,
                       String value)

Deprecated. For more consistency this method has been deprecated. The component should now use the setProperty method instead.

sets the value of the attribute.

Parameters:

key - the name of the attribute.

value - the value of the attribute.

See Also:

setProperty(java.lang.String, java.lang.String)

getClassName

String getClassName()

Deprecated. The information provided by this method should be obtained from IPortalComponentConfig if needed.

returns the class name of the component

Returns:

the class name of the component

getPropertyDescriptor

IPropertyDescriptor getPropertyDescriptor(String propertyName)

Deprecated. The component should now use the getPropertyAttribute method instead.

gets the Descriptor of the property provided

Parameters:

propertyName -

See Also:

getPropertyAttribute(String, String)

getCodeLink

String getCodeLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the CodeLink attribute of the component

Returns:

the CodeLink attribute of the component

getResourceBundleName

String getResourceBundleName()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the name of the resource bundle to be used for this component.

Returns:

the name of this component's resource bundle.

getHelpName

String getHelpName()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the name of the help file to be used for this component.

Returns:

the name of this component's help file.

getTitle

String getTitle()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the title of the component

Returns:

the title of the component.

getDescription

String getDescription()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the description of the component

Returns:

the description of the component.

isVisible

boolean isVisible()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the isVisible attribute

getContentLink

String getContentLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the contentLink attribute

getContentType

String getContentType()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the contentType attribute

getXSL

String getXSL()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the XSL attribute

getXSLLink

String getXSLLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the XSLLink attribute

requireIsolation

boolean requireIsolation()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the requireIsolation attribute

getDeviceType

String getDeviceType()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the deviceType attribute

getPersonalizationLink

String getPersonalizationLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the personalizationLink attribute

getDetailLink

String getDetailLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the detailSupport attribute

getSupportLink

String getSupportLink()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the supportLink attribute

getSupportAttributes

String getSupportAttributes()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the supportAttributes attribute

getProfileName

String getProfileName()

Deprecated. Please use getProperty(String) with the appropriate constant instead.

gets the name of the profile. This should identify the profile uniquely

removeValue

void removeValue(String name)

Deprecated. Please use the corresponding method on IPortalComponentContext instead.

Removes the attribute with the specified name from this context.

Parameters:

name - attribute name

putValue

void putValue(String name,
              Object value)

Deprecated. Please use the corresponding method on IPortalComponentContext instead.

Associates the specified value with the specified attribute name, specified as a String.

Parameters:

name - the attribute name.

value - the attribute value.

getValue

Object getValue(String name)

Deprecated. Please use the corresponding method on IPortalComponentContext instead.

Returns the value of the specified attribute name, specified as a string, or null if the attribute was not found.

Parameters:

name - the attribute name as a string

Returns:

the value to which the attribute name is mapped in this hashtable; null if it is not mapped to any value.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[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-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT