com.uwyn.rife.engine.annotations
Annotation Type Flowlink

@Retention(value=RUNTIME)
@Target(value={})
@Documented
public @interface Flowlink

Declares a flow link for the element.

Since:

1.5

Version:

$Revision: 3701 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

Required Element Summary

String

srcExit The name of the exit in the source element that this flow link will be connected to.

Optional Element Summary

Flowlink.Continuations	continuations Indicates whether the continuations should be preserved or cancelled when this submission is sent.
Datalink[]	datalinks This flow link's data links.
Class	destClass The Java class of the destination element for this data link.
String	destClassIdPrefix The prefix that will be added to the destClass ID.
String	destId The ID of the destination element for this flow link.
Flowlink.Embedding	embedding Indicates whether element embedded should be preserved or cancelled when this flow link is followed.
Flowlink.Inheritance	inheritance Indicates whether the behavioral inheritance (3D flow) should be preserved or cancelled when this flow link is followed.
boolean	redirect Indicates whether this flow link will redirect to a dedicated URL instead of executing the destination element directly.
boolean	snapback Indicates whether this flow link is a snapback.

Element Detail

srcExit

public abstract String srcExit

The name of the exit in the source element that this flow link will be connected to.

If no such exit exists, it will be created automatically.

Since:

1.5

destId

public abstract String destId

The ID of the destination element for this flow link.

If destClass is provided, it will override the destId value.

Since:

1.5

See Also:

destClass()

Default:

""

destClass

public abstract Class destClass

The Java class of the destination element for this data link. This class should at least have an Elem annotation.

If destClass is provided, it will override the destId value.

The ID will be evaluated locally to the current subsite. If you have to refer to an ID in another subsite, you have to use the destClassIdPrefix().

Since:

1.5

See Also:

destId(), destClassIdPrefix()

Default:

void.class

destClassIdPrefix

public abstract String destClassIdPrefix

The prefix that will be added to the destClass ID.

This makes it possible to refer to an ID in another subsite. Note that this prefix is not validated individually, it is merely added as a string to build the final ID that will be used.

Since:

1.5

See Also:

destClass()

Default:

""

snapback

public abstract boolean snapback

Indicates whether this flow link is a snapback.

Since:

1.5

Default:

false

redirect

public abstract boolean redirect

Indicates whether this flow link will redirect to a dedicated URL instead of executing the destination element directly.

Since:

1.5

Default:

false

inheritance

public abstract Flowlink.Inheritance inheritance

Indicates whether the behavioral inheritance (3D flow) should be preserved or cancelled when this flow link is followed.

Since:

1.5

Default:

com.uwyn.rife.engine.annotations.Flowlink.Inheritance.PRESERVE

embedding

public abstract Flowlink.Embedding embedding

Indicates whether element embedded should be preserved or cancelled when this flow link is followed.

Since:

1.5

Default:

com.uwyn.rife.engine.annotations.Flowlink.Embedding.PRESERVE

continuations

public abstract Flowlink.Continuations continuations

Indicates whether the continuations should be preserved or cancelled when this submission is sent.

Since:

1.6

Default:

com.uwyn.rife.engine.annotations.Flowlink.Continuations.PRESERVE

datalinks

public abstract Datalink[] datalinks

This flow link's data links.

Since:

1.5

Default:

{}