Disc API

Class Events.Payloads.AbandonedPayload

public class Events.Payloads.AbandonedPayload
extends bea.wlp.disc.xie.Events.Payloads.UpdatePayload

This payload is delivered when OnAbandonUpdate events are fired.

See Also:: bea.wlp.disc.xie.Events.OnAbandonUpdate

Method Summary

public XMLHttpRequest getXhr()
Returns the underlying XHR instance associated with this XIE interaction.

Method Detail


Method Summary
`public XMLHttpRequest`	`getXhr()` Returns the underlying XHR instance associated with this XIE interaction.


Method Detail

getXhr

public XMLHttpRequest getXhr()

Returns the underlying XHR instance associated with this XIE interaction.

Returns:: XMLHttpRequest - The XHR instance used to execute this XIE interaction

Class Events.Payloads.ContentPayload

public class Events.Payloads.ContentPayload
extends bea.wlp.disc.xie.Events.Payloads.MarkupPayload

This payload is delivered when OnPrepareContent and OnInjectContent events are fired.

See Also:: bea.wlp.disc.xie.Events.OnPrepareContent; bea.wlp.disc.xie.Events.OnInjectContent

Method Summary

public HTMLElement getControlContainer()
Returns an HTMLElement containing the DOM nodes being updated.

public string toString()
Returns a string representation of this payload for debugging purposes.

Method Detail


Method Summary
`public HTMLElement`	`getControlContainer()` Returns an `HTMLElement` containing the DOM nodes being updated.
`public string`	`toString()` Returns a string representation of this payload for debugging purposes.


Method Detail

getControlContainer

public HTMLElement getControlContainer()

Returns an HTMLElement containing the DOM nodes being updated. The container itself and its parents MUST be considered opaque and MUST NOT be modified by receiving code. Children of the returned container node may be inspected and modified, but due to the nature of some XIE updates, the exact structure of those children should not be rigidly relied upon, as some such child nodes may also be considered opaque, implementation details of WLP. Generic traversal and/or structurally agnostic DOM operations such as document.getElementById, document.getElementsByTagName, and JavaScript toolkit helpers like CSS-selector-based functions are useful mechanisms for safely and reliably getting at content nodes in this structure. Other methods of inspection may not return reliable results in certain Disc execution environments, and should be used with caution, if at all. Modification of or reliance on the exact nature of the container object itself may result in undefined, unreliable behavior, with the exception of its fundamental type (HTMLElement).

See the warnings found in the documentation for the OnPrepareContent and OnInjectContent events for for more information on the potential impact that may come from modifying the contents of the container node. While useful, such modifications may also be problematic if not undertaken carefully.

Returns:: HTMLElement - An opaque container containing the DOM subtree being updated
See Also:: bea.wlp.disc.xie.Events.OnPrepareContent; bea.wlp.disc.xie.Events.OnInjectContent

toString

public string toString()

Returns a string representation of this payload for debugging purposes. The exact format of this string should not be relied upon, as it may change as XIE's payload implementations evolve.

Returns:: string - A string describing this payload instance

Class Events.Payloads.ErrorPayload

public class Events.Payloads.ErrorPayload

This payload is delivered when OnError events are fired.

See Also:: bea.wlp.disc.xie.Events.OnError

Method Summary

public string getDescription()
          Returns the description associated with the causal error, if any.

public Error getError()
          If the error condition that spawned the event with which this payload is associated was caused by a JavaScript Error, this method returns the causal error instance.

public string getMessage()
          Returns the message associated with the causal error, if any.

public string toString()
          Returns a string representation of this payload for debugging purposes.

Method Detail


Method Summary
`public string`	`getDescription()` Returns the description associated with the causal error, if any.
`public Error`	`getError()` If the error condition that spawned the event with which this payload is associated was caused by a JavaScript `Error`, this method returns the causal error instance.
`public string`	`getMessage()` Returns the message associated with the causal error, if any.
`public string`	`toString()` Returns a string representation of this payload for debugging purposes.


Method Detail

getDescription

public string getDescription()

Returns the description associated with the causal error, if any.

Returns:: string - The error description, if specified

getError

public Error getError()

If the error condition that spawned the event with which this payload is associated was caused by a JavaScript Error, this method returns the causal error instance.

Returns:: Error - The causal Error instance, if any

getMessage

public string getMessage()

Returns the message associated with the causal error, if any.

Returns:: string - The error message, if specified

toString

public string toString()

Returns a string representation of this payload for debugging purposes. The exact format of this string should not be relied upon, as it may change as XIE's payload implementations evolve.

Returns:: string - A string describing this payload instance

Class Events.Payloads.MarkupPayload

public class Events.Payloads.MarkupPayload
extends bea.wlp.disc.xie.Events.Payloads.ResponsePayload

This is the base class for all fragment-based XIE event payloads. Only subclasses of this class are delivered by XIE events.

Method Summary

public string getControlContentType()
          Returns the content-type of the markup for the control being updated in relation to the event that delivered this payload.

public string getControlLabel()
          Returns the label for the control being updated in relation to the event that delivered this payload.

public string getControlMarkup()
          Returns the response markup for the control being updated in relation to the event that delivered this payload.

public string getControlType()
          Returns the type for the control being updated in relation to the event that delivered this payload.

public string toString()
          Returns a string representation of this payload for debugging purposes.

Method Detail


Method Summary
`public string`	`getControlContentType()` Returns the content-type of the markup for the control being updated in relation to the event that delivered this payload.
`public string`	`getControlLabel()` Returns the label for the control being updated in relation to the event that delivered this payload.
`public string`	`getControlMarkup()` Returns the response markup for the control being updated in relation to the event that delivered this payload.
`public string`	`getControlType()` Returns the type for the control being updated in relation to the event that delivered this payload.
`public string`	`toString()` Returns a string representation of this payload for debugging purposes.


Method Detail

getControlContentType

public string getControlContentType()

Returns the content-type of the markup for the control being updated in relation to the event that delivered this payload.

Returns:: string - The content-type of the markup for currently updating control
See Also:: bea.wlp.disc.xie.Events.Payloads.MarkupPayload.ControlType

getControlLabel

public string getControlLabel()

Returns the label for the control being updated in relation to the event that delivered this payload.

Returns:: string - The label of the currently updating control

getControlMarkup

public string getControlMarkup()

Returns the response markup for the control being updated in relation to the event that delivered this payload.

Returns:: string - The response markup for the currently updating control

getControlType

public string getControlType()

Returns the type for the control being updated in relation to the event that delivered this payload.

Returns:: string - The type of the currently updating control
See Also:: bea.wlp.disc.xie.Events.Payloads.MarkupPayload.ControlType

toString

public string toString()

Returns a string representation of this payload for debugging purposes. The exact format of this string should not be relied upon, as it may change as XIE's payload implementations evolve.

Returns:: string - A string describing this payload instance

Object Events.Payloads.MarkupPayload.ControlType

public singleton object Events.Payloads.MarkupPayload.ControlType

A simple enumeration of the possible values that may be returned from getControlType

See Also:: bea.wlp.disc.xie.Events.Payloads.MarkupPayload.getControlType

Field Summary

public static string BOOK
            The "book" control type.

public static string PAGE
            The "page" control type.

public static string PORTLET
            The "portlet" control type.

Field Detail


Field Summary
`public static string`	`BOOK` The "book" control type.
`public static string`	`PAGE` The "page" control type.
`public static string`	`PORTLET` The "portlet" control type.


Field Detail

BOOK

public static string BOOK

The "book" control type

PAGE

public static string PAGE

The "page" control type

PORTLET

public static string PORTLET

The "portlet" control type

Class Events.Payloads.MutableMarkupPayload

public class Events.Payloads.MutableMarkupPayload
extends bea.wlp.disc.xie.Events.Payloads.MarkupPayload

This payload is delivered when OnPrepareMarkup events are fired.

See Also:: bea.wlp.disc.xie.Events.OnPrepareMarkup

Method Summary

public void setControlMarkup(markup)
Sets the markup for this control.

Method Detail


Method Summary
`public void`	`setControlMarkup(markup)` Sets the markup for this control.


Method Detail

setControlMarkup

public void setControlMarkup(markup)

Sets the markup for this control. This is typically used to modify the markup data returned by getControlMarkup. See the warnings specified in the documentation for bea.wlp.disc.xie.Events.OnPrepareMarkup relating to the capability introduced by this method.

Parameters:: string markup - The replacement for this control's existing response markup
See Also:: bea.wlp.disc.xie.Events.Payloads.MarkupPayload#getControlMarkup; bea.wlp.disc.xie.Events.OnPrepareMarkup

Class Events.Payloads.MutableUpdatePayload

public class Events.Payloads.MutableUpdatePayload
extends bea.wlp.disc.xie.Events.Payloads.UpdatePayload

This payload allows custom request headers to be set for outbound XIE requests and is delivered when OnPrepareUpdate requests are fired.

See Also:: bea.wlp.disc.xie.Events.OnPrepareUpdate

Method Summary

public void setRequestHeader(name, value)
Sets a custom request header for the outbound XIE interaction request which this payload is associated.

Method Detail


Method Summary
`public void`	`setRequestHeader(name, value)` Sets a custom request header for the outbound XIE interaction request which this payload is associated.


Method Detail

setRequestHeader

public void setRequestHeader(name, value)

Sets a custom request header for the outbound XIE interaction request which this payload is associated.

Parameters:: string name - The name of the request header; string value - The value of the request header

Class Events.Payloads.RedirectPayload

public class Events.Payloads.RedirectPayload
extends bea.wlp.disc.xie.Events.Payloads.ResponsePayload

This payload is delivered when OnRedirectUpdate events are fired.

See Also:: bea.wlp.disc.xie.Events.OnRedirectUpdate

Method Summary

public string getRedirectUri()
Returns the URI to which the server has specified the client redirect.

public string toString()
Returns a string representation of this payload for debugging purposes.

Method Detail


Method Summary
`public string`	`getRedirectUri()` Returns the URI to which the server has specified the client redirect.
`public string`	`toString()` Returns a string representation of this payload for debugging purposes.


Method Detail

getRedirectUri

public string getRedirectUri()

Returns the URI to which the server has specified the client redirect.

Returns:: string - The redirect URI

toString

public string toString()

Returns a string representation of this payload for debugging purposes. The exact format of this string should not be relied upon, as it may change as XIE's payload implementations evolve.

Returns:: string - A string describing this payload instance


Method Summary


Method Detail

Class Events.Payloads.UpdatePayload

public class Events.Payloads.UpdatePayload

This is the base class for all (non-error) payloads delivered by XIE events.

Method Summary

public string getRequestHeader(name)
          Returns a request header, by name, for the XIE interaction that spawned this event.

public string getRequestUri()
          Returns the request URI for the XIE interaction that spawned this event.

public object getUpdateAttribute(name)
          Gets a custom attribute within the scope of the current interaction (aka 'update').

public void setUpdateAttribute(name, [value])
          Sets a custom attribute within the scope of the current interaction (aka 'update').

public string toString()
          Returns a string representation of this payload for debugging purposes.

Method Detail


Method Summary
`public string`	`getRequestHeader(name)` Returns a request header, by name, for the XIE interaction that spawned this event.
`public string`	`getRequestUri()` Returns the request URI for the XIE interaction that spawned this event.
`public object`	`getUpdateAttribute(name)` Gets a custom attribute within the scope of the current interaction (aka 'update').
`public void`	`setUpdateAttribute(name, [value])` Sets a custom attribute within the scope of the current interaction (aka 'update').
`public string`	`toString()` Returns a string representation of this payload for debugging purposes.


Method Detail

getRequestHeader

public string getRequestHeader(name)

Returns a request header, by name, for the XIE interaction that spawned this event.

Parameters:: string name - The name of the request header to return
Returns:: string - The value of the named request header, if found

getRequestUri

public string getRequestUri()

Returns the request URI for the XIE interaction that spawned this event.

Returns:: string - The appropriate request URI

getUpdateAttribute

public object getUpdateAttribute(name)

Gets a custom attribute within the scope of the current interaction (aka 'update').

Parameters:: string name - The name of the attribute to return
Returns:: object - The value of the named attribute

setUpdateAttribute

public void setUpdateAttribute(name, [value])

Sets a custom attribute within the scope of the current interaction (aka 'update'). Any attributes set in this manner will be visible by all event listeners fired within the scope of the same XIE interaction, unless removed by setting a null value.

Parameters:: string name - The name of the atribute to set; object [value] - The value of the attribute to set, or null or undefined to clear an existing value

toString

public string toString()

Returns a string representation of this payload for debugging purposes. The exact format of this string should not be relied upon, as it may change as XIE's payload implementations evolve.

Returns:: string - A string describing this payload instance