fuego.papi
Interface MDObject

All Known Subinterfaces:

Process, Task

All Known Implementing Classes:

Activity

public interface MDObject

Contains the methods that must be implemented by any metadata object.

Method Summary

boolean	containsDocumentation(Locale locale) Returns true if the documentation for the given locale was already loaded
String	getDescription(Locale locale) Returns the description for this object
String	getDocumentation(Locale locale) Returns the path of the localized documentation HTML.
String	getFolderName() Returns the name of the folder to hold all this object documentation The name has to be an UNIQUE identificator of this object, ans must be an acceptable filesystem folder name (you can specify subfolders using the character '/')
String	getId() Returns the deployment Id (LogicalId) of this object
String	getLabel(Locale locale) Return the label that identify this object for a final user.
String	getName() Returns this object name
boolean	hasLocalDocumentation() Returns true if the object has local documentation
void	setDocumentation(Locale locale, String fileName)

Method Detail

getDescription

public String getDescription(Locale locale)

Returns the description for this object

Parameters:

locale -

Returns:

String with a brief descriptin of this object

getDocumentation

public String getDocumentation(Locale locale)

Returns the path of the localized documentation HTML.
If the localized documentation is not available, null must be returned.

Parameters:

locale - the desired locale

Returns:

this object's localized documentation path

getFolderName

public String getFolderName()

Returns the name of the folder to hold all this object documentation The name has to be an UNIQUE identificator of this object, ans must be an acceptable filesystem folder name (you can specify subfolders using the character '/')

Returns:

The name of the folder to hold all this object documentation

getId

public String getId()

Returns the deployment Id (LogicalId) of this object

Returns:

String with the deployment Id for this object

getLabel

public String getLabel(Locale locale)

Return the label that identify this object for a final user.

Parameters:

locale -

Returns:

localized string value

getName

public String getName()

Returns this object name

Returns:

String with the name of this object

containsDocumentation

public boolean containsDocumentation(Locale locale)

Returns true if the documentation for the given locale was already loaded

Parameters:

locale - The locale for the documentation

Returns:

boolean true if the documentation was already loaded

hasLocalDocumentation

public boolean hasLocalDocumentation()

Returns true if the object has local documentation

setDocumentation

public void setDocumentation(Locale locale,
                             String fileName)