Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

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 java.lang.String DEFAULT_RESOURCE_BUNDLE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_ATTRIBUTE_DESCRIPTION
          A description to a property is used in personalization dialogues (e.g.).
static java.lang.String PROFILE_ATTRIBUTE_FINAL
          Deprecated. Please use the PROFILE_ATTRIBUTE_INHERITANCE attribute instead.
static java.lang.String PROFILE_ATTRIBUTE_INHERITANCE
          Deprecated. Do not use
static java.lang.String PROFILE_ATTRIBUTE_INHERITANCE_FINAL
          Deprecated. Do not use
static java.lang.String PROFILE_ATTRIBUTE_PERSONALIZABLE
          Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.
static java.lang.String PROFILE_ATTRIBUTE_PERSONALIZATION
          This attribute specifies personalization handling of a corresponding property.
static java.lang.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 java.lang.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 java.lang.String PROFILE_ATTRIBUTE_TYPE
          A type of an attribute can be any of the following values:
static java.lang.String PROFILE_ATTRIBUTE_USERSPECIFIC
          Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.
static java.lang.String PROFILE_ATTRIBUTE_VALUE
          The actual value of a property
static java.lang.String PROFILE_KEY_AUTHREQUIREMENT
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_CACHINGLEVEL
          Key for caching level.
static java.lang.String PROFILE_KEY_CLASSNAME
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_CODELINK
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_CONTENTLINK
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_CONTENTTYPE
          Specification of the mime type of the content provided by the Portal Component unless specified differently on IPortalComponentResponse.
static java.lang.String PROFILE_KEY_DESCRIPTION
          Key for the description of the component
static java.lang.String PROFILE_KEY_DETAILLINK
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_DEVICETYPE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_HEIGHT
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_HELPNAME
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_ISVISIBLE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_JSP
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_LOCALMODEALLOWED
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_MINTIMETOLIVE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_PERSONALIZATIONBEHAVIOR
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_PERSONALIZATIONCLASS
          Deprecated. Please use the mode delegation mechanism.
static java.lang.String PROFILE_KEY_PERSONALIZATIONLINK
          Contains a URL+ pointing to a page that allows to reach a specific enduser personalization dialog service.
static java.lang.String PROFILE_KEY_PORTALCOMPONENTTYPE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_PREFERREDSIZE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_REQUIREISOLATION
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_RESOURCEBUNDLENAME
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.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 java.lang.String PROFILE_KEY_SHARINGACCESS
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_KEY_SHARINGREF
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_KEY_SUPPORTATTRIBUTES
          Contains some attributes that helps to support the iView.
static java.lang.String PROFILE_KEY_SUPPORTLINK
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_SYSTEMPRIVILEGE
          Deprecated. Do not use.
static java.lang.String PROFILE_KEY_TITLE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_TRAYSTATE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_TRAYTYPE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_WIDTH
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_XSL
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_KEY_XSLLINK
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.
static java.lang.String PROFILE_PORTALCOMPONENTTYPE_JSP
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_PORTALCOMPONENTTYPE_SERVLET
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_SHARING_SHARED
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
static java.lang.String PROFILE_SHARING_SYSTEM
          Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.
 
Method Summary
 java.util.Enumeration getAttributeNames()
          Deprecated. For more consistency this method has been deprecated. The component should now use the getProperties method instead.
 java.lang.String getAttributeValue(java.lang.String key)
          Deprecated. For more consistency this method has been deprecated. The component should now use the getProperty method instead.
 java.lang.String getClassName()
          Deprecated. The information provided by this method should be obtained from IPortalComponentConfig if needed.
 java.lang.String getCodeLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getComponentName()
          Deprecated. Please use the corresponding method on IPortalComponentContext.
 java.lang.String getContentLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getContentType()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getDescription()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getDetailLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getDeviceType()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getHelpName()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getLocalDeploymentFolder()
          Deprecated. Please use corresponding methods on IPortalComponentRequest or PortalRuntime.
 java.lang.String getPersonalizationLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getProfileName()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.util.Enumeration getProperties()
          returns an Enumeration of the properties name.
 java.lang.String getProperty(java.lang.String key)
          returns the string value corresponding to the key or null if this property is not defined..
 java.lang.String getPropertyAttribute(java.lang.String propertyName, java.lang.String attributeName)
          Gets the value of an attribute.
 java.util.Enumeration getPropertyAttributes(java.lang.String propertyName)
          Gets an enumeration of all attributes of the property
 IPropertyDescriptor getPropertyDescriptor(java.lang.String propertyName)
          Deprecated. The component should now use the getPropertyAttribute method instead.
 java.lang.String getResourceBundleName()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getSupportAttributes()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getSupportLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getTitle()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.Object getValue(java.lang.String name)
          Deprecated. Please use the corresponding method on IPortalComponentContext instead.
 java.lang.String getXSL()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 java.lang.String getXSLLink()
          Deprecated. Please use getProperty(String) with the appropriate constant instead.
 boolean isPersonalizableProperty(java.lang.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(java.lang.String name, java.lang.Object value)
          Deprecated. Please use the corresponding method on IPortalComponentContext instead.
 void removeValue(java.lang.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(java.lang.String key)
          Resets the value of the property to its default value.
 void setAttributeValue(java.lang.String key, java.lang.String value)
          Deprecated. For more consistency this method has been deprecated. The component should now use the setProperty method instead.
 void setProperty(java.lang.String key, java.lang.String value)
          sets the value of the property.
 void store()
          Makes the PortalComponentProfile persistent
 

Field Detail

PROFILE_KEY_AUTHREQUIREMENT

public static final java.lang.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.

PROFILE_KEY_CACHINGLEVEL

public static final java.lang.String PROFILE_KEY_CACHINGLEVEL
Key for caching level.
See Also:
ICachablePortalComponent

PROFILE_KEY_CLASSNAME

public static final java.lang.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.

PROFILE_KEY_CODELINK

public static final java.lang.String PROFILE_KEY_CODELINK
Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Internal system property

PROFILE_KEY_CONTENTLINK

public static final java.lang.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.

PROFILE_KEY_CONTENTTYPE

public static final java.lang.String PROFILE_KEY_CONTENTTYPE
Specification of the mime type of the content provided by the Portal Component unless specified differently on IPortalComponentResponse.

PROFILE_KEY_DESCRIPTION

public static final java.lang.String PROFILE_KEY_DESCRIPTION
Key for the description of the component

PROFILE_KEY_HEIGHT

public static final java.lang.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.)

PROFILE_KEY_JSP

public static final java.lang.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).

PROFILE_KEY_LOCALMODEALLOWED

public static final java.lang.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.

PROFILE_KEY_PERSONALIZATIONLINK

public static final java.lang.String PROFILE_KEY_PERSONALIZATIONLINK
Contains a URL+ pointing to a page that allows to reach a specific enduser personalization dialog service.

PROFILE_KEY_PERSONALIZATIONBEHAVIOR

public static final java.lang.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'

PROFILE_KEY_PERSONALIZATIONCLASS

public static final java.lang.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.

PROFILE_KEY_PORTALCOMPONENTTYPE

public static final java.lang.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

PROFILE_KEY_PREFERREDSIZE

public static final java.lang.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.

PROFILE_KEY_RESOURCEBUNDLENAME

public static final java.lang.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".

PROFILE_KEY_REQUIREISOLATION

public static final java.lang.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.

PROFILE_KEY_SERVICESREF

public static final java.lang.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.

PROFILE_KEY_SHARINGACCESS

public static final java.lang.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.

PROFILE_KEY_SHARINGREF

public static final java.lang.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.

PROFILE_KEY_TITLE

public static final java.lang.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

PROFILE_KEY_HELPNAME

public static final java.lang.String PROFILE_KEY_HELPNAME
Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

Name of the help files.

PROFILE_KEY_ISVISIBLE

public static final java.lang.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.

PROFILE_KEY_XSL

public static final java.lang.String PROFILE_KEY_XSL
Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

PROFILE_KEY_DEVICETYPE

public static final java.lang.String PROFILE_KEY_DEVICETYPE
Deprecated. Note: This property might not be accessible via IPortalComponentProfile constant in later versions.

PROFILE_KEY_DETAILLINK

public static final java.lang.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.

PROFILE_KEY_SUPPORTLINK

public static final java.lang.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.

PROFILE_KEY_SUPPORTATTRIBUTES

public static final java.lang.String PROFILE_KEY_SUPPORTATTRIBUTES
Contains some attributes that helps to support the iView.

PROFILE_KEY_SYSTEMPRIVILEGE

public static final java.lang.String PROFILE_KEY_SYSTEMPRIVILEGE
Deprecated. Do not use.

PROFILE_KEY_TRAYSTATE

public static final java.lang.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)

PROFILE_KEY_TRAYTYPE

public static final java.lang.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.

PROFILE_KEY_WIDTH

public static final java.lang.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.

PROFILE_KEY_XSLLINK

public static final java.lang.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.

PROFILE_KEY_MINTIMETOLIVE

public static final java.lang.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.

PROFILE_ATTRIBUTE_TYPE

public static final java.lang.String PROFILE_ATTRIBUTE_TYPE
A type of an attribute can be any of the following values:

PROFILE_ATTRIBUTE_VALUE

public static final java.lang.String PROFILE_ATTRIBUTE_VALUE
The actual value of a property

PROFILE_ATTRIBUTE_DESCRIPTION

public static final java.lang.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.

PROFILE_ATTRIBUTE_PLAINDESCRIPTION

public static final java.lang.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

PROFILE_ATTRIBUTE_PERSONALIZABLE

public static final java.lang.String PROFILE_ATTRIBUTE_PERSONALIZABLE
Deprecated. Please use the PROFILE_ATTRIBUTE_PERSONALIZATION attribute instead.

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

PROFILE_ATTRIBUTE_FINAL

public static final java.lang.String PROFILE_ATTRIBUTE_FINAL
Deprecated. Please use the PROFILE_ATTRIBUTE_INHERITANCE attribute instead.

If a property is final, it cannot be overridden.

PROFILE_ATTRIBUTE_PERSONALIZATION

public static final java.lang.String PROFILE_ATTRIBUTE_PERSONALIZATION
This attribute specifies personalization handling of a corresponding property.

PROFILE_ATTRIBUTE_USERSPECIFIC

public static final java.lang.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.

PROFILE_ATTRIBUTE_PERSONALIZATION_DIALOG

public static final java.lang.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.

PROFILE_ATTRIBUTE_INHERITANCE

public static final java.lang.String PROFILE_ATTRIBUTE_INHERITANCE
Deprecated. Do not use

PROFILE_ATTRIBUTE_INHERITANCE_FINAL

public static final java.lang.String PROFILE_ATTRIBUTE_INHERITANCE_FINAL
Deprecated. Do not use

PROFILE_PORTALCOMPONENTTYPE_JSP

public static final java.lang.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

PROFILE_PORTALCOMPONENTTYPE_JSPNATIVE

public static final java.lang.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

PROFILE_SHARING_SYSTEM

public static final java.lang.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.
   }
}

PROFILE_SHARING_SHARED

public static final java.lang.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.

PROFILE_PORTALCOMPONENTTYPE_SERVLET

public static final java.lang.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.

DEFAULT_RESOURCE_BUNDLE

public static final java.lang.String DEFAULT_RESOURCE_BUNDLE
Deprecated. Note: This property might not be accessible via IPortalComponentProfile in later versions.

Method Detail

getProperties

public java.util.Enumeration getProperties()
returns an Enumeration of the properties name.

getProperty

public java.lang.String getProperty(java.lang.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

public boolean isPersonalizableProperty(java.lang.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

public void setProperty(java.lang.String key,
                        java.lang.String value)
sets the value of the property.
Parameters:
key - the name of the property.
value - the value of the attribute.

resetProperty

public void resetProperty(java.lang.String key)
Resets the value of the property to its default value.
Parameters:
key - the name of the property.

getPropertyAttributes

public java.util.Enumeration getPropertyAttributes(java.lang.String propertyName)
Gets an enumeration of all attributes of the property
Parameters:
propertyName - the name of the property

getPropertyAttribute

public java.lang.String getPropertyAttribute(java.lang.String propertyName,
                                             java.lang.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

public void store()
           throws PortalRuntimeException
Makes the PortalComponentProfile persistent
Throws:
PortalRuntimeException - if the profile can not be stored.

getComponentName

public java.lang.String getComponentName()
Deprecated. Please use the corresponding method on IPortalComponentContext.

returns the name of the master component

getLocalDeploymentFolder

public java.lang.String getLocalDeploymentFolder()
Deprecated. Please use corresponding methods on IPortalComponentRequest or PortalRuntime.

gets the path of the local deployment

getAttributeNames

public java.util.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

public java.lang.String getAttributeValue(java.lang.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

public void setAttributeValue(java.lang.String key,
                              java.lang.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

public java.lang.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

public IPropertyDescriptor getPropertyDescriptor(java.lang.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

public java.lang.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

public java.lang.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

public java.lang.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

public java.lang.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

public java.lang.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

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

returns the isVisible attribute

getContentLink

public java.lang.String getContentLink()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the contentLink attribute

getContentType

public java.lang.String getContentType()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the contentType attribute

getXSL

public java.lang.String getXSL()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the XSL attribute

getXSLLink

public java.lang.String getXSLLink()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the XSLLink attribute

requireIsolation

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

returns the requireIsolation attribute

getDeviceType

public java.lang.String getDeviceType()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the deviceType attribute

getPersonalizationLink

public java.lang.String getPersonalizationLink()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the personalizationLink attribute

getDetailLink

public java.lang.String getDetailLink()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the detailSupport attribute

getSupportLink

public java.lang.String getSupportLink()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the supportLink attribute

getSupportAttributes

public java.lang.String getSupportAttributes()
Deprecated. Please use getProperty(String) with the appropriate constant instead.

returns the supportAttributes attribute

getProfileName

public java.lang.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

public void removeValue(java.lang.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

public void putValue(java.lang.String name,
                     java.lang.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

public java.lang.Object getValue(java.lang.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.
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD