public class

BeanInfo

extends AbstractConfigurationElement
java.lang.Object
   ↳ com.microstrategy.utils.config.AbstractConfigurationElement
     ↳ com.microstrategy.web.app.tasks.config.BeanInfo

Class Overview

THIS CLASS IS NOT SUPPORTED FOR USE IN CUSTOM APPLICATION DEVELOPMENT. THE CLASS IS SUBJECT TO CHANGE IN FUTURE RELEASES AND SOME METHODS AND PROPERTIES MAY NOT BE SUITABLE FOR CUSTOM DEVELOPMENT.

Summary

Constants
String NODE_BEAN_INFO
[Expand]
Inherited Constants
From class com.microstrategy.utils.config.AbstractConfigurationElement
Public Constructors
BeanInfo()
Constructs a BeanInfo object
Public Methods
void addActualParameterInfo(ActualParameterInfo api)
Adds an ActualParameterInfo object for this bean.
List getActualParameterInfos()
Returns a list of ActualParameterInfo objects for this bean.
String getBeanName()
Returns the name to be associated with the bean we create.
int getBeanType()
This method is deprecated. Use getBeanTypeStr
String getBeanTypeStr()
String getFactoryType()
Returns the type of factory that creates an instance of the desired bean.
int getOutputFormat()
This method is deprecated. No longer supported
StyleInfo getStyleInfo()
int getStyleSource()
Returns the "source" location of the style attribute.
String resolveStyleName(RequestKeys requestKeys)
Resolves the style name to be used with the created bean.
void setBeanName(String beanName)
Sets the name to be associated with the bean we create.
void setBeanType(int beanType)
This method is deprecated. Use setBeanTypeStr
void setBeanTypeStr(String beanTypeStr)
void setOutputFormat(int outputFormat)
This method is deprecated. No longer supported
void setStyleInfo(StyleInfo styleInfo)
This method will replace the existing styleInfo object
void setUsesWebBean(boolean b)
boolean usesWebBean()
Protected Methods
String getKeyAttribute()
This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.
[Expand]
Inherited Methods
From class com.microstrategy.utils.config.AbstractConfigurationElement
From class java.lang.Object
From interface com.microstrategy.utils.config.ConfigurationElement
From interface com.microstrategy.utils.config.ConfigurationFile

Constants

public static final String NODE_BEAN_INFO

Constant Value: "beanInfo"

Public Constructors

public BeanInfo ()

Constructs a BeanInfo object

Public Methods

public void addActualParameterInfo (ActualParameterInfo api)

Adds an ActualParameterInfo object for this bean.

Parameters
api An ActualParameterInfo object for this bean.

public List getActualParameterInfos ()

Returns a list of ActualParameterInfo objects for this bean.

Returns

public String getBeanName ()

Returns the name to be associated with the bean we create.

Returns
  • The name to be associated with the bean we create.

public int getBeanType ()

This method is deprecated.
Use getBeanTypeStr

Returns the type of the bean to create.

Returns
  • The type of the bean to create.

public String getBeanTypeStr ()

public String getFactoryType ()

Returns the type of factory that creates an instance of the desired bean.

Returns
  • The type of factory that creates an instance of the desired bean.

public int getOutputFormat ()

This method is deprecated.
No longer supported

Returns the output format to associate with the created bean.

Returns
  • The output format to associate with the created bean.

public StyleInfo getStyleInfo ()

Returns
  • the StyleInfo object registered with this bean

public int getStyleSource ()

Returns the "source" location of the style attribute.

Returns
  • The "source" location of the style attribute.

public String resolveStyleName (RequestKeys requestKeys)

Resolves the style name to be used with the created bean.

Parameters
requestKeys The set of input parameters, in the form of a RequestKeys object.
Returns
  • The style name to be used with the created bean, or null if there is no style specified.
Throws
TaskRequestMalformedException If the request does not contain enough information to resolve the style name.

public void setBeanName (String beanName)

Sets the name to be associated with the bean we create.

Parameters
beanName The name to be associated with the bean we create.

public void setBeanType (int beanType)

This method is deprecated.
Use setBeanTypeStr

Sets the type of the bean to create.

Parameters
beanType The type of the bean to create.

public void setBeanTypeStr (String beanTypeStr)

public void setOutputFormat (int outputFormat)

This method is deprecated.
No longer supported

Sets the output format to associate with the created bean.

Parameters
outputFormat The output format to associate with the created bean.

public void setStyleInfo (StyleInfo styleInfo)

This method will replace the existing styleInfo object

Parameters
styleInfo instance of StyleInfo object

public void setUsesWebBean (boolean b)

public boolean usesWebBean ()

Protected Methods

protected String getKeyAttribute ()

This method must return the attribute that uniquely identifies this element among its siblings; if no single attribute can be used, return null and override the getKey and setKey methods.