org.eclipse.higgins.idas.api.model
Interface IDisplayData

public interface IDisplayData

Represents an information which could be used for visual representation of entity.

See Also:

http://www.eclipse.org/higgins/ontologies/2006/display-data

Method Summary

String	getDescription() Returns extended description of the entity.
URL	getImage() Returns an URL of the image which could be used for visual representation of entity or null if not available.
String	getLabel() Returns display label of entity.
int	getOrder() Returns an information on display order of entity which could be used for visual representation of entity.

Method Detail

getLabel

public String getLabel()

Returns display label of entity.

Returns:

String containing display label of entity.

getDescription

public String getDescription()

Returns extended description of the entity.

Returns:

String containing extended description of entity or null if not available.

getImage

public URL getImage()

Returns an URL of the image which could be used for visual representation of entity or null if not available.

getOrder

public int getOrder()

Returns an information on display order of entity which could be used for visual representation of entity.

Returns:

positive int value which represents display order of entity or 0 if not availabe.