Package org.silverpeas.core.web.mvc.webcomponent.annotation

Annotation Type NavigationStep

@Inherited
@Documented
@Target(METHOD)
@Retention(RUNTIME)
public @interface NavigationStep

Annotation to specify a navigation step creation/update on a HTTP method of a WebComponentController.

When a HTTP method with this annotation is called, one of the following internal treatment is performed:

• if no navigation step is referenced by identifier(), then a navigation step is created and referenced with the specified annotation identifier
• if a navigation step with specified identifier() already exists, then the navigation step stack is reset to this

Then, in any cases, the following internal treatments are performed:

• NavigationContext.NavigationStep.withFullUri(String): the current requested path URI (with URL parameters) is set
• NavigationContextListener necessary methods are triggered

Author:

Yohann Chastagnier

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
String	identifier	The identifier of a navigation step (several controller paths can perform different treatments on same navigation step).

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	contextIdentifier	The context identifier of a navigation step (several contexts can be handled into a same navigation step).

Element Detail

identifier

String identifier

The identifier of a navigation step (several controller paths can perform different treatments on same navigation step).

Returns:

the above described identfifier.

contextIdentifier

String contextIdentifier

The context identifier of a navigation step (several contexts can be handled into a same navigation step).

Returns:

the above described identfifier.

Default:

"unknown"