WebComponentTask

The name of the formal parameter that defines the desired content type. If found, the Task infrastructure will assign the value of the Task Content Type parameter to it. This allows transforms to be written that generate Block trees and the Task caller can decide how they are rendered.

If an error occurred at initialization time, then this field contains the message.

No args constructor for a WebComponentTask.

Destroy any data structures created by the 'init' method.

Handles the initialization of the task. This involves parsing the XML file and retrieving all of the contents. This method calls registerTaskMetadata(TaskMetadata).

Returns a BeanTaskRequestContext object to use for the duration of this request.

Process the incoming request. This method proceeds through the following sequence:

1. Check for all required parameters. (calls checkForRequiredParameters(RequestKeys))
2. Prepare the RequestKeys for use. (calls prepareRequestKeys(BeanTaskRequestContext))
3. Prepare the WebBean for use. (calls prepareBean(BeanTaskRequestContext))
4. Handle the event. (calls handleEvent(BeanTaskRequestContext))
5. Collect data for the request. (calls collectData(BeanTaskRequestContext))
6. Serialize the results into the supplied TaskOutput. (calls serializeResult(BeanTaskRequestContext, TaskOutput))

Sets the Task ID.

Adds the specified Transform to the WebBean. This method is called by serializeResult(BeanTaskRequestContext, TaskOutput) and performs the following actions:

1. Retrieves the name of the style to use.
2. Adds the Transform by looking up the style.

This method calls the 'collectData' method on the WebBean instance. This method is called by processRequest(TaskRequestContext, TaskOutput).

This method creates an instance of an "untyped" Web Component. This component implements the Transformable interface and can be used with any Transform. It provides no specialized data access methods.

This method creates the WebComponent or WebBean from the specified bean type. If no type is specified, then an "untyped" WebComponent is created using the createUntypedWebComponent(BeanTaskRequestContext) method.

This method determines whether the Task is going to generate any content. Some tasks are "write only" in nature: they send data to the backend, but return nothing (other than a status).

Returns the BeanInfo object associated with this BeanTask.

This method instructs the WebBean to handle the event. It is called from processRequest(TaskRequestContext, TaskOutput).

Returns whether the BeanTask was successfully initialized or not.

Overrides any actual parameters specified in the Bean Task XML. This method is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method.

This method prepares the RequestKeys by adding the necessary "event argument" parameters. This method is called in the prepareEventRequestKeys(RequestKeys) method.

This method prepares the WebBean for execution. It is called by the processRequest(TaskRequestContext, TaskOutput) method. It performs the following actions:

1. Creates a new WebBean instance and adds it to the context. (calls createWebBean(BeanTaskRequestContext))
2. Sets any bean properties. (calls setBeanProperties(BeanTaskRequestContext))
3. Restores any bean state. (calls restoreBeanState(BeanTaskRequestContext))

The method sets the request keys necessary for multiple events. This method is called in the prepareEventRequestKeys(RequestKeys) method.

This method prepares the RequestKeys by adding the necessary keys for events. If there is only one event, then the URL_EVENT_NAME key is added. Otherwise, the prepareEventOrderRequestKeys(RequestKeys) method is called. Next, it calls the prepareArgumentRequestKeys(RequestKeys) method to add any keys defined for Event Arguments in the Bean Task XML.

This method prepares the RequestKeys by adding any default values for parameters.

Prepares the RequestKeys for handling the event. This method is called inside processRequest(TaskRequestContext, TaskOutput). This method, in turn, calls:

1. prepareParameterRequestKeys(RequestKeys)
2. prepareEventRequestKeys(RequestKeys)

Registers a specific Task parameter metadata. This method is called by registerTaskMetadata(TaskMetadata). It is helpful to override in a Task so that a specific TaskParameterMetadata may be saved for later use.

This method is used to register the task metadata. It is a method invoked by the init(ContainerServices) method. This method in turn calls registerParameterMetadata(TaskParameterMetadata) for each task parameter.

Returns whether this Task requires an Intelligence Server session.

Restores the state of a previously serialized WebBean. This method is called by prepareBean(BeanTaskRequestContext) and calls the restoreStateFromRequest(RequestKeys) method on the WebBean.

This method attempts to serialize the results to the supplied TaskOutput object. This method is called by processRequest(TaskRequestContext, TaskOutput) and in turn does the following:

1. Add the Transform. If there is no transform specified, an empty MarkupOutput is returned. (calls addTransform(BeanTaskRequestContext))
2. Override any actual parameters specified in the Bean Task XML. (calls overrideActualParameters(BeanTaskRequestContext, TransformInstance))
3. Transforms the WebBean using the Transform. (calls transformBean(BeanTaskRequestContext, TaskOutput))

Set the BeanContext associated with the Bean. This method is called by the setBeanProperties(BeanTaskRequestContext) method.

Sets the BeanInfo object associated with this BeanTask.

Sets the Bean's name. This method is called by setBeanProperties(BeanTaskRequestContext).

Set any properties on the Bean. This method is called by the prepareBean(BeanTaskRequestContext) method and performs the following actions:

1. Sets the Bean Name. (calls setBeanName(BeanTaskRequestContext))
2. Sets the Bean Session. (calls setBeanSession(BeanTaskRequestContext))
3. Sets the Bean Context. (calls setBeanContext(BeanTaskRequestContext))

Set the WebIServerSession object to use with the WebBean. This method is called by the setBeanProperties(BeanTaskRequestContext) method.

Sets whether the BeanTask was successfully initialized or not.

This method wraps a call to transform(). It is called by the serializeResult(BeanTaskRequestContext, TaskOutput) method and simply calls the 'transform' method.