com.businessobjects.dsws.reportengine
Interface EmbeddedCallbackOption

All Superinterfaces:

CallbackOption

public interface EmbeddedCallbackOption
extends CallbackOption

A EmbeddedCallbackOption sets a script that is to be called each time EmbeddedAction is retrieved with a document view.

See Also:

CallbackOption, DrillOption, ImageManagement, RetrieveView, RetrieveData, ReportEngine, DocumentInformation

Nested Class Summary

static class

EmbeddedCallbackOption.Factory A class with methods for creating instances of the EmbeddedCallbackOption type.

Field Summary

static org.apache.xmlbeans.SchemaType

type Internal Use Only.

Method Summary

java.lang.String	getActionHolder() Returns the name of the parameter in the URL which contains the Action to be passed to the EmbeddedAction.
java.lang.String	getNameHolder() Returns the name of the parameter in the URL which contains the name of the Action to be passed to the EmbeddedAction.
boolean	isSetActionHolder() Checks if the ActionHolder attribute is set.
boolean	isSetNameHolder() Checks if the NameHolder attribute is set.
void	setActionHolder(java.lang.String actionHolder) Sets the name of the parameter in the URL which contains the Action to be passed to the EmbeddedAction.
void	setNameHolder(java.lang.String nameHolder) Sets the name of the parameter in the URL which contains the name of the Action to be passed to the EmbeddedAction.
void	unsetActionHolder() Unsets the ActionHolder attribute.
void	unsetNameHolder() Unsets the NameHolder attribute.
org.apache.xmlbeans.XmlString	xgetActionHolder() Internal Use Only.
org.apache.xmlbeans.XmlString	xgetNameHolder() Internal Use Only.
void	xsetActionHolder(org.apache.xmlbeans.XmlString actionHolder) Internal Use Only.
void	xsetNameHolder(org.apache.xmlbeans.XmlString nameHolder) Internal Use Only.

Methods inherited from interface com.businessobjects.dsws.reportengine.CallbackOption

getCallbackFrame, getCallbackScript, getDocumentReferenceHolder, isSetCallbackFrame, isSetCallbackScript, isSetDocumentReferenceHolder, setCallbackFrame, setCallbackScript, setDocumentReferenceHolder, unsetCallbackFrame, unsetCallbackScript, unsetDocumentReferenceHolder, xgetCallbackFrame, xgetCallbackScript, xgetDocumentReferenceHolder, xsetCallbackFrame, xsetCallbackScript, xsetDocumentReferenceHolder

Field Detail

type

static final org.apache.xmlbeans.SchemaType type

Internal Use Only.

Method Detail

getActionHolder

java.lang.String getActionHolder()

Returns the name of the parameter in the URL which contains the Action to be passed to the EmbeddedAction.

Returns:

The Action to be passed to the EmbeddedAction.

xgetActionHolder

org.apache.xmlbeans.XmlString xgetActionHolder()

Internal Use Only.

isSetActionHolder

boolean isSetActionHolder()

Checks if the ActionHolder attribute is set.

Returns:

true if the ActionHolder attribute is set, otherwise false

setActionHolder

void setActionHolder(java.lang.String actionHolder)

Sets the name of the parameter in the URL which contains the Action to be passed to the EmbeddedAction.

Parameters:

actionHolder - The Action to be passed to the EmbeddedAction.

xsetActionHolder

void xsetActionHolder(org.apache.xmlbeans.XmlString actionHolder)

Internal Use Only.

unsetActionHolder

void unsetActionHolder()

Unsets the ActionHolder attribute.

getNameHolder

java.lang.String getNameHolder()

Returns the name of the parameter in the URL which contains the name of the Action to be passed to the EmbeddedAction.

Returns:

The name of the Action to be passed to the EmbeddedAction.

xgetNameHolder

org.apache.xmlbeans.XmlString xgetNameHolder()

Internal Use Only.

isSetNameHolder

boolean isSetNameHolder()

Checks if the NameHolder attribute is set.

Returns:

true if the NameHolder attribute is set, otherwise false

setNameHolder

void setNameHolder(java.lang.String nameHolder)

Sets the name of the parameter in the URL which contains the name of the Action to be passed to the EmbeddedAction.

Parameters:

nameHolder - The name of the Action to be passed to the EmbeddedAction.

xsetNameHolder

void xsetNameHolder(org.apache.xmlbeans.XmlString nameHolder)

Internal Use Only.

unsetNameHolder

void unsetNameHolder()

Unsets the NameHolder attribute.