fr.ifremer.isisfish.util
Interface Docable

All Known Implementing Classes:

ExportStorage, JavaSourceStorage, RuleStorage, ScriptStorage, SensitivityAnalysisStorage, SensitivityExportStorage, SimulationPlanStorage, SimulatorStorage

public interface Docable

This is the contract to be realize by any class which wanted to have a @Doc support.

Version:

$Revision: 3420 $ Last update : $Date: 2011-06-17 15:55:14 +0200 (Fri, 17 Jun 2011) $ By : $Author: chatellier $

Author:

chemit

See Also:

Doc

Method Summary

String	getDescription() Class documentation (if any).
Doc	getFieldDoc(String fieldName) Field documentation (if any).

Method Detail

getFieldDoc

Doc getFieldDoc(String fieldName)

Field documentation (if any).

Parameters:

fieldName - name of the field to use

Returns:

the @Doc of the field, or null if none

getDescription

String getDescription()

Class documentation (if any).

Returns:

the description of the class, or null if none