oracle.dss.addins.runtime.beanRef
Interface BeanRef

All Superinterfaces:

Persistable, StringXMLizable

All Known Implementing Classes:

GraphRef, CrosstabRef, TableRef

public interface BeanRef

extends Persistable

This interface defines a Reference Bean. A reference bean is a derived from regular presentation beans such as oracle.dss.graph.Graph>/code> or oracle.dss.crosstab.Crosstab. Once a DefinitionInfo is set on a reference bean, the reference bean can load(save) itself from(to) BICatalog.

Method Summary

DefinitionInfo	getDefinition() Retrieves the DefinitionInfo object from this reference bean
BISession	getSession() retrieves the BISession object associated this reference bean
boolean	isBackgroundLoad() retrieves a boolean value which indicates if the presentation is loaded using another thread
boolean	isLoaded() Return true if the view has finished loading
void	load() Load the presentation from the BI Catalog, if the presentation contains a live query, the query will be executed as well.
void	save() Save the changes to the presentation to the BI Catalog.
void	saveAs(java.lang.String location) Save the the presentaion to the BI Catalog using a different name
void	setBackgroundLoad(boolean doBackGroundLoad) Specifies if the presentation should be loaded using another thread
void	setDefinition(DefinitionInfo definition) specifies the DefinitionInfo of this reference bean
void	setSession(BISession biSession) specifies the BISession Object associated with this refrence bean

Methods inherited from interface oracle.dss.util.persistence.Persistable

getPersistableAttributes, getPersistableComponents, initialize, setPersistableAttributes, setPersistableComponents

Methods inherited from interface oracle.dss.util.persistence.StringXMLizable

getXMLAsString, setXMLAsString

Method Detail

setSession

public void setSession(BISession biSession)

specifies the BISession Object associated with this refrence bean

Parameters:

The - BISession that is associatedwi the this reference bean

getSession

public BISession getSession()

retrieves the BISession object associated this reference bean

Returns:

The BISession that is associated with this reference bean

setDefinition

public void setDefinition(DefinitionInfo definition)

specifies the DefinitionInfo of this reference bean

Parameters:

defintion - the DefinitionInfo object for this reference bean

getDefinition

public DefinitionInfo getDefinition()

Retrieves the DefinitionInfo object from this reference bean

Returns:

The DefinitionInfo that specifies the configuration file and the full path of this reference bean

load

public void load()

Load the presentation from the BI Catalog, if the presentation contains a live query, the query will be executed as well.

save

public void save()

Save the changes to the presentation to the BI Catalog.

saveAs

public void saveAs(java.lang.String location)

Save the the presentaion to the BI Catalog using a different name

Parameters:

location - the object Path, such as "folder/object1"

setBackgroundLoad

public void setBackgroundLoad(boolean doBackGroundLoad)

Specifies if the presentation should be loaded using another thread

Parameters:

doBackGroundLoad - true: Presentation is loaded using another thread false: Presentation is loaded in the calling thread

isBackgroundLoad

public boolean isBackgroundLoad()

retrieves a boolean value which indicates if the presentation is loaded using another thread

Returns:

true: presentaiton is loaded using another thread false: presentaion is loaded using the main thead

isLoaded

public boolean isLoaded()

Return true if the view has finished loading