nl.pbemengine.engine.ng.blueprint.config
Annotation Type WebResultMapping

@Retention(value=RUNTIME)
@Target(value=FIELD)
public @interface WebResultMapping

A result mapping for a WebActionMapping. Can have 3 types of results. An action returns a map of values, and

Author:

Jeroen Steenbeeke

Required Element Summary

java.lang.String

resultValue The action return value that triggers this result

Optional Element Summary

java.lang.String	directData DIRECT results only.
java.lang.String	mimeType DIRECT results only.
java.lang.String	nextAction CHAIN results only.
WebResultType	resultType The type of result this is.
java.lang.String	template TEMPLATE results only.

Element Detail

resultValue

public abstract java.lang.String resultValue

The action return value that triggers this result

Returns:

A String with a return value

resultType

public abstract WebResultType resultType

The type of result this is. The value of this property determines which of the remaining properties need to be supplied.

• CHAIN - The nextAction property must be supplied
• DIRECT - The mimeType and directData property must be supplied
• INDEX - Nothing needs to be supplied
• TEMPLATE - The mimeType and template property must be supplied

Returns:

The value that triggers this mapping

Default:

nl.pbemengine.engine.ng.blueprint.config.WebResultType.TEMPLATE

template

public abstract java.lang.String template

TEMPLATE results only. The template to send the return data of the action to for rendering

Returns:

A template name

Default:

""

mimeType

public abstract java.lang.String mimeType

DIRECT results only. The MIME type of the direct data being sent

Returns:

A MIME type

Default:

""

directData

public abstract java.lang.String directData

DIRECT results only. The key for the direct data to be sent to the browser. This data should be supplied to an action's return map, and must be an array of bytes

Returns:

The key to the direct data

Default:

""

nextAction

public abstract java.lang.String nextAction

CHAIN results only. The next action in the chain

Returns:

A string describing an action

Default:

""