com.dotmarketing.portlets.chains
Class ChainLink

java.lang.Object
  com.dotmarketing.portlets.chains.ChainLink

Direct Known Subclasses:

PrintOutAllParameters

public abstract class ChainLink
extends java.lang.Object

This is the class that every Link implementation should extend

Author:

davidtorresv

Constructor Summary

ChainLink()

Method Summary

boolean	execute(ChainControl data) This is the method invoked
ChainControl	getChainData() Returns the current chaindata during the execution of the pipe
ChainLinkCode	getCode()
abstract java.lang.String	getDescription() Returns a full description of what the link does and how behaves
abstract ChainLinkParameter[]	getParameters()
abstract java.lang.String[]	getRequiredLinks() This method will return a list of fully class qualified names of the required links that should be executed before this link
abstract java.lang.String	getTitle() Returns a short title that names the link
abstract boolean	run() This is the method that will implement the link functionality
void	setCode(ChainLinkCode code)

Methods inherited from class java.lang.Object

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

Constructor Detail

ChainLink

public ChainLink()

Method Detail

getTitle

public abstract java.lang.String getTitle()

Returns a short title that names the link

Returns:

getDescription

public abstract java.lang.String getDescription()

Returns a full description of what the link does and how behaves

Returns:

getParameters

public abstract ChainLinkParameter[] getParameters()

Returns:

getRequiredLinks

public abstract java.lang.String[] getRequiredLinks()

This method will return a list of fully class qualified names of the required links that should be executed before this link

Returns:

execute

public final boolean execute(ChainControl data)

This is the method invoked

Returns:

run

public abstract boolean run()

This is the method that will implement the link functionality

getChainData

public final ChainControl getChainData()

Returns the current chaindata during the execution of the pipe

Returns:

setCode

public void setCode(ChainLinkCode code)

getCode

public ChainLinkCode getCode()