fuego.papi
Interface MDObject

All Known Subinterfaces:

Process, Task

All Known Implementing Classes:

Activity

public interface MDObject

Contains the basic information of any metadata object.
The metadata is all information about a process deployed, included Process, Activity and Task.

Method Summary

boolean	containsDocumentation(Locale locale) Returns if the documentation for the given locale was already loaded
String	getDescription(Locale locale) Gets the localized description for this object
String	getDocumentation(Locale locale) Gets the path of the localized documentation HTML. If the localized documentation is not available, null must be returned.
String	getFolderName() Getss 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() Gets the deployment Id (LogicalId) of this object
String	getLabel(Locale locale) Gets the localized label that identify this object for a final user.
String	getName() Gets this object name
boolean	hasLocalDocumentation() Returns if the object has local documentation
void	setDocumentation(Locale locale, String fileName) Sets the documentation for a given locale.

Method Detail

getDescription

public String getDescription(Locale locale)

Gets the localized description for this object

Parameters:

locale - the desired locale.

Returns:

localized descriptin of this object.

getDocumentation

public String getDocumentation(Locale locale)

Gets 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()

Getss 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()

Gets the deployment Id (LogicalId) of this object

Returns:

deployed Id for this object

getLabel

public String getLabel(Locale locale)

Gets the localized label that identify this object for a final user.

Parameters:

locale - the desired locale.

Returns:

localized lebel of this object.

getName

public String getName()

Gets this object name

Returns:

name of this object

containsDocumentation

public boolean containsDocumentation(Locale locale)

Returns if the documentation for the given locale was already loaded

Parameters:

locale - the desired locale.

Returns:

true if the documentation was already loaded.

hasLocalDocumentation

public boolean hasLocalDocumentation()

Returns if the object has local documentation

Returns:

true if the object has local documentation.

setDocumentation

public void setDocumentation(Locale locale,
                             String fileName)

Sets the documentation for a given locale.

Parameters:

locale - locale for this documentation. Cannot be null.

fileName - html documentation Cannot be null.