com.acsinet_solutions.cetia4.controller.nav
Interface NavigationStage

All Known Subinterfaces:
NavigationStageGroup
All Known Implementing Classes:
NavigationStageGroupImpl, NavigationStageImpl

public interface NavigationStage

This interface defines a navigation stage, that is a single page visited by a user in a request/response state model.

NavigationStage is also the superinterface of NavigationStageGroup, that groups a flow of individual stages, interacting with this superinterface in a composite pattern design.

Author:
Santiago Arriaga - santiago.arriaga@acsinet-solutions.com
See Also:
NavigationStageGroup

Method Summary
 AttributeInfo getAttributeInfo()
          Get the metadata description for the form attribute on the current stage.
 NavigationStage getCurrentStage()
          Get a shared stage instance that can be modified externally.
 Link getLink()
          Get a reference to the current stage link.
 java.lang.String getName()
          Returns the name of the current entry; this should be unique for each navigation stage type.
 boolean performMatch(NavigationStage other)
          Check whether the current entry corresponds to another.
 

Method Detail

getName

java.lang.String getName()
Returns the name of the current entry; this should be unique for each navigation stage type.


performMatch

boolean performMatch(NavigationStage other)
Check whether the current entry corresponds to another. This is used in navigation flows to find NavigationStages that correspond with each others.


getCurrentStage

NavigationStage getCurrentStage()
Get a shared stage instance that can be modified externally.


getLink

Link getLink()
Get a reference to the current stage link. This is a copy of the internal unmodifiable link.


getAttributeInfo

AttributeInfo getAttributeInfo()
Get the metadata description for the form attribute on the current stage. This metadata indicates the attribute maintenance information that the flow will use when unloading stages.

Returns:
a maybe null FormAttribute instance.