com.endeca.infront.cartridge.model

Class Action

java.lang.Object

com.endeca.infront.cartridge.model.Action

Direct Known Subclasses:

NavigationAction, RecordAction, UrlAction

public class Action
extends Object

An Action represents a decision that an end user might choose to make when interacting with an Assembler application.

Examples include:

• Selecting a refinement
• Removing a bread-crumb
• Viewing the next page of a results list
• Clicking on a link that has been produced by the LinkBuilder

An Action contains several pieces of information. Which of these are used to produce links is determined by the Assembler application. Depending on the context within which the Action is produced and the manner in which it will be used, any of them may be null.

• Site root path: This is the path that identifies the site associated with this Action
• Content path: This is the path that identifies the content associated with this Action within its containing site
• Label: The user-visible text for the application to use when constructing a link for this Action

Constructor Summary

Constructors

Constructor and Description
Action() Default constructor.
Action(String label) Constructs an Action with the specified label.
Action(String label, String siteRootPath, String contentPath, SiteState siteState) Constructs an Action with the specified label, site root path and content path.

Method Summary

Methods

Modifier and Type	Method and Description
String	getContentPath()
String	getLabel()
String	getSiteRootPath()
SiteState	getSiteState()
void	setContentPath(String contentPath) Sets the path that identifies the content associated with this Action within its containing site.
void	setLabel(String label) Sets the user-visible text for the application to use when constructing a link for this Action.
void	setSiteRootPath(String siteRootPath) Sets the path that identifies the site root associated with this Action.
void	setSiteState(SiteState siteState) Sets the site state of this Action

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Action

public Action()

Default constructor.

Action

public Action(String label)

Constructs an Action with the specified label.

Parameters:

label - the label

Action

public Action(String label,
      String siteRootPath,
      String contentPath,
      SiteState siteState)

Constructs an Action with the specified label, site root path and content path.

Parameters:

label - the label

siteRootPath - the site root path

contentPath - the content path

siteState - the siteState

Method Detail

getSiteState

public SiteState getSiteState()

Returns:

The site state of this Action

setSiteState

public void setSiteState(SiteState siteState)

Sets the site state of this Action

getSiteRootPath

public String getSiteRootPath()

Returns:

The site root path of this Action.

setSiteRootPath

public void setSiteRootPath(String siteRootPath)

Sets the path that identifies the site root associated with this Action.

Parameters:

siteRootPath - the site root path

getContentPath

public String getContentPath()

Returns:

The content path of this Action.

setContentPath

public void setContentPath(String contentPath)

Sets the path that identifies the content associated with this Action within its containing site.

Parameters:

contentPath - the content path

getLabel

public String getLabel()

Returns:

The label of this Action.

setLabel

public void setLabel(String label)

Sets the user-visible text for the application to use when constructing a link for this Action.

Parameters:

label - the user-visible text