org.systinet.wasp.dd
Interface Documentation

public interface Documentation

This interface represents the documentation contained in a deployment descriptor's part.

Since:

4.0

Component:

Core

Method Summary

java.lang.String	getDescription() Returns the description of the dd part.
java.lang.String	getDisplayName() Returns the display name, used in tools.
java.lang.String	getLargeIcon() Returns the large icon, used in tools.
java.lang.String	getSmallIcon() Returns the small icon, used in tools.
Endpoint	getURL() Returns the URL containing additional documentation.
void	setDescription(java.lang.String description) Sets the description of the dd part.
void	setDisplayName(java.lang.String displayName) Sets the display name, used in tools.
void	setLargeIcon(java.lang.String icon) Sets the large icon, used in tools.
void	setSmallIcon(java.lang.String icon) Sets the small icon, used in tools.
void	setURL(Endpoint endpoint) Sets the URL containing additional documentation.

Method Detail

getDisplayName

public java.lang.String getDisplayName()

Returns the display name, used in tools.

Returns:

the display name

setDisplayName

public void setDisplayName(java.lang.String displayName)

Sets the display name, used in tools.

Parameters:

displayName - the display name

getSmallIcon

public java.lang.String getSmallIcon()

Returns the small icon, used in tools.

Returns:

the small icon

setSmallIcon

public void setSmallIcon(java.lang.String icon)

Sets the small icon, used in tools.

Parameters:

icon - the small icon

getLargeIcon

public java.lang.String getLargeIcon()

Returns the large icon, used in tools.

Returns:

the large icon

setLargeIcon

public void setLargeIcon(java.lang.String icon)

Sets the large icon, used in tools.

Parameters:

icon - the large icon

getDescription

public java.lang.String getDescription()

Returns the description of the dd part.

Returns:

the description of the dd part

setDescription

public void setDescription(java.lang.String description)

Sets the description of the dd part.

Parameters:

description - the description of the dd part

getURL

public Endpoint getURL()

Returns the URL containing additional documentation.

Returns:

the URL containing additional documentation

setURL

public void setURL(Endpoint endpoint)

Sets the URL containing additional documentation.

Parameters:

endpoint - URL containing additional documentation