com.endeca.infront.cartridge.model
Class NavigationAction

java.lang.Object
  extended by com.endeca.infront.cartridge.model.Action
      extended by com.endeca.infront.cartridge.model.NavigationAction
Direct Known Subclasses:
Ancestor, Refinement, SortOptionLabel, SuggestedSearch

public class NavigationAction
extends Action

An Action which represents a change to the current navigation state (e.g., selecting a refinement, performing a search, or paging through results).


Constructor Summary
NavigationAction()
          Default constructor.
NavigationAction(String navigationState)
          Constructs a NavigationAction with the give navigation state.
NavigationAction(String navigationState, String label)
          Constructs a NavigationAction with the give navigation state and label.
NavigationAction(String navigationState, String label, String siteRootPath, String contentPath)
          Constructs a navigation action with the given navigation state, label, site root path and content path.
 
Method Summary
 String getNavigationState()
           
 void setNavigationState(String navigationState)
          Sets the navigation state for this Action.
 
Methods inherited from class com.endeca.infront.cartridge.model.Action
getContentPath, getLabel, getSiteRootPath, setContentPath, setLabel, setSiteRootPath
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

NavigationAction

public NavigationAction()
Default constructor.


NavigationAction

public NavigationAction(String navigationState)
Constructs a NavigationAction with the give navigation state.

Parameters:
navigationState - the string representing the navigation state

NavigationAction

public NavigationAction(String navigationState,
                        String label)
Constructs a NavigationAction with the give navigation state and label.

Parameters:
navigationState - the string representing the navigation state
label - the label with the user-visible text

NavigationAction

public NavigationAction(String navigationState,
                        String label,
                        String siteRootPath,
                        String contentPath)
Constructs a navigation action with the given navigation state, label, site root path and content path.

Parameters:
navigationState - the string representing the navigation state
label - the label with the user-visible text
siteRootPath - the site root path
contentPath - the content path
Method Detail

getNavigationState

public String getNavigationState()
Returns:
the serialized NavigationState that corresponds to this action. A NavigationState is serialized by calling its NavigationState#toString() method.

setNavigationState

public void setNavigationState(String navigationState)
Sets the navigation state for this Action. Example: "/cameras/_/N-25y6?Ntt=camera", "N=1234", "Ntt=camera"

Parameters:
navigationState - the string representing the navigation state
See Also:
getNavigationState()


Copyright © 2012, Oracle and/or its affiliates. All rights reserved.