Module ch.ralscha.extdirectspring

Package ch.ralscha.extdirectspring.bean.api

Class ActionDoc

java.lang.Object

ch.ralscha.extdirectspring.bean.api.Action

ch.ralscha.extdirectspring.bean.api.ActionDoc

public class ActionDoc
extends Action

Field Summary

Fields

Modifier and Type	Field	Description
protected String	author
protected boolean	deprecated
protected String	methodComment
protected Map<String,String>	parameters	map of method parameter names and descriptions
protected Map<String,String>	returnMethod	map of method return properties names and descriptions
protected String	version

Constructor Summary

Constructors

Constructor	Description
ActionDoc(Action toCopy, String methodComment, String author, String version, boolean deprecated)
ActionDoc(String name, List<String> params)

Method Summary

Modifier and Type	Method	Description
String	getAuthor()
String	getMethodComment()
Map<String,String>	getParameters()
Map<String,String>	getReturnMethod()
String	getVersion()
boolean	isDeprecated()
void	setAuthor(String author)
void	setDeprecated(boolean deprecated)
void	setMethodComment(String methodComment)
void	setParameters(Map<String,String> parameters)
void	setReturnMethod(Map<String,String> returnMethod)
void	setVersion(String version)

Methods inherited from class ch.ralscha.extdirectspring.bean.api.Action

create, create, createFormHandler, createNamed, createTreeLoad, getBatched, getFormHandler, getLen, getMetadata, getName, getParams, getStrict

Methods inherited from class java.lang.Object

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

Field Details

methodComment

protected String methodComment

author

protected String author

version

protected String version

parameters

protected Map<String,String> parameters

map of method parameter names and descriptions

returnMethod

protected Map<String,String> returnMethod

map of method return properties names and descriptions

deprecated

protected boolean deprecated

Constructor Details

ActionDoc

public ActionDoc(String name,
 List<String> params)

ActionDoc

public ActionDoc(Action toCopy,
 String methodComment,
 String author,
 String version,
 boolean deprecated)

Method Details

getMethodComment

public String getMethodComment()

Returns:

the methodComment

setMethodComment

public void setMethodComment(String methodComment)

Parameters:

methodComment - the methodComment to set

getAuthor

public String getAuthor()

Returns:

the author

setAuthor

public void setAuthor(String author)

Parameters:

author - the author to set

getVersion

public String getVersion()

Returns:

the version

setVersion

public void setVersion(String version)

Parameters:

version - the version to set

getParameters

public Map<String,String> getParameters()

Returns:

the parameters

setParameters

public void setParameters(Map<String,String> parameters)

Parameters:

parameters - the parameters to set

getReturnMethod

public Map<String,String> getReturnMethod()

Returns:

the returnMethod

setReturnMethod

public void setReturnMethod(Map<String,String> returnMethod)

Parameters:

returnMethod - the returnMethod to set

isDeprecated

public boolean isDeprecated()

Returns:

the deprecated

setDeprecated

public void setDeprecated(boolean deprecated)

Parameters:

deprecated - the deprecated to set