Package com.microstrategy.web.app.tasks.config

Class BeanInfo

java.lang.Object

com.microstrategy.utils.config.AbstractConfigurationElement

com.microstrategy.web.app.tasks.config.BeanInfo

All Implemented Interfaces:

ConfigurationElement, ConfigurationFile, java.lang.Cloneable

public class BeanInfo
extends AbstractConfigurationElement

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.

Since:

MicroStrategy Web 9.0.0

Nested Class Summary

Nested classes/interfaces inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

AbstractConfigurationElement.FilteredList

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	NODE_BEAN_INFO

Fields inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

ATT_CONFIG_SRC, ATT_DELETED, ATT_POSITION, ATT_PROTOTYPE, ATT_USE_DEFAULT

Constructor Summary

Constructors

Constructor	Description
BeanInfo()	Constructs a BeanInfo object

Method Summary

Modifier and Type	Method	Description
void	addActualParameterInfo(ActualParameterInfo api)	Adds an ActualParameterInfo object for this bean.
java.util.List	getActualParameterInfos()	Returns a list of ActualParameterInfo objects for this bean.
java.lang.String	getBeanName()	Returns the name to be associated with the bean we create.
int	getBeanType()	Deprecated. Use getBeanTypeStr
java.lang.String	getBeanTypeStr()
java.lang.String	getFactoryType()	Returns the type of factory that creates an instance of the desired bean.
protected java.lang.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.
int	getOutputFormat()	Deprecated. No longer supported
StyleInfo	getStyleInfo()
int	getStyleSource()	Returns the "source" location of the style attribute.
java.lang.String	resolveStyleName(RequestKeys requestKeys)	Resolves the style name to be used with the created bean.
void	setBeanName(java.lang.String beanName)	Sets the name to be associated with the bean we create.
void	setBeanType(int beanType)	Deprecated. Use setBeanTypeStr
void	setBeanTypeStr(java.lang.String beanTypeStr)
void	setOutputFormat(int outputFormat)	Deprecated. No longer supported
void	setStyleInfo(StyleInfo styleInfo)	This method will replace the existing styleInfo object
void	setUsesWebBean(boolean b)
boolean	usesWebBean()

Methods inherited from class com.microstrategy.utils.config.AbstractConfigurationElement

addFileSource, applyCustomization, applyCustomizations, cleanUpDeletedElements, clone, delete, deltas, deltas, equalAtts, equalElements, equalNodeValues, equals, equalsIncludingDeletedElements, exportAttributesToXML, exportElementsToXML, exportNodeValueToXML, getAttribute, getAttributes, getBoolAttribute, getChildKey, getConfigSrc, getDTDFileName, getElement, getElement, getElements, getFileLoader, getIntAttribute, getIntAttribute, getKey, getLineNumber, getList, getNextKey, getNodeName, getNodeValue, getNodeValue, getOrCreateElement, getParent, getPosition, getPrototype, getRegisteredClass, getSelfInitPath, getSource, getStrAttribute, getUseDefault, getXMLParserParameters, getXMLSerializerParameters, hashCode, hashCodeAtts, hashCodeElements, hashCodeNodeValues, hasRegisteredClass, initAttributesFromXML, initDefaultAttributes, initElementFromXML, initElementsFromXML, initFromFile, initFromResource, initFromXML, initFromXML, initNodeValueFromXML, initPrototype, isActive, isCustomized, isDeleted, isDirty, isInSource, isKeyAttribute, load, mergeChanges, newChildInstance, newSource, original, populate, printAttributes, printElements, printNodeValue, refreshLists, registerClass, registerElement, registerElement, registerElementList, reload, reloadPrototype, removeAttribute, removeDefaults, replaceList, restore, save, save, saveChangesAs, saveConfig, saveFlatXML, saveNode, saveSource, setAttribute, setBoolAttribute, setChildOriginals, setConfigSrc, setCustomized, setElement, setFileLoader, setIntAttribute, setKey, setLineNumber, setNodeName, setNodeValue, setPosition, setPrototype, setSelfInitPath, setStrAttribute, setUseDefault, setUseValidation, throwConfigParseException, toString, toXML, toXML, toXML, toXML, useNodeValue, useValidation

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

NODE_BEAN_INFO

public static final java.lang.String NODE_BEAN_INFO

See Also:

Constant Field Values

Constructor Detail

BeanInfo

public BeanInfo()

Constructs a BeanInfo object

Method Detail

getBeanName

public java.lang.String getBeanName()

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

Returns:

The name to be associated with the bean we create.

setBeanName

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

getFactoryType

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

getBeanTypeStr

public java.lang.String getBeanTypeStr()

setBeanTypeStr

public void setBeanTypeStr(java.lang.String beanTypeStr)

getBeanType

@Deprecated
public int getBeanType()

Deprecated.

Use getBeanTypeStr

Returns the type of the bean to create.

Returns:

The type of the bean to create.

setBeanType

@Deprecated
public void setBeanType(int beanType)

Deprecated.

Use setBeanTypeStr

Sets the type of the bean to create.

Parameters:

beanType - The type of the bean to create.

getOutputFormat

@Deprecated
public int getOutputFormat()

Deprecated.

No longer supported

Returns the output format to associate with the created bean.

Returns:

The output format to associate with the created bean.

setOutputFormat

@Deprecated
public void setOutputFormat(int outputFormat)

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.

getActualParameterInfos

public java.util.List getActualParameterInfos()

Returns a list of ActualParameterInfo objects for this bean.

Returns:

A list of ActualParameterInfo objects for this bean.

addActualParameterInfo

public void addActualParameterInfo(ActualParameterInfo api)

Adds an ActualParameterInfo object for this bean.

Parameters:

api - An ActualParameterInfo object for this bean.

resolveStyleName

public java.lang.String resolveStyleName(RequestKeys requestKeys)
                                  throws TaskRequestMalformedException

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.

getStyleSource

public int getStyleSource()

Returns the "source" location of the style attribute.

Returns:

The "source" location of the style attribute.

usesWebBean

public boolean usesWebBean()

setUsesWebBean

public void setUsesWebBean(boolean b)

setStyleInfo

public void setStyleInfo(StyleInfo styleInfo)

This method will replace the existing styleInfo object

Parameters:

styleInfo - instance of StyleInfo object

getStyleInfo

public StyleInfo getStyleInfo()

Returns:

the StyleInfo object registered with this bean

getKeyAttribute

protected java.lang.String getKeyAttribute()

Description copied from class: AbstractConfigurationElement

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.

Specified by:

getKeyAttribute in class AbstractConfigurationElement