CoreandServices.book - Ocean - Schlumberger

Description Interfaces and Classes
Description Interfaces and Classes
The Ocean Core provides two interfaces defining descriptions for objects. The interfaces
are IDescription and IDescriptionSource.
The IDescription interface provides a set of properties that are used to describe an
object. These properties are Name, Description, and ShortDescription.
public interface IDescription
{
string Description;
string Name;
string ShortDescription;
}
The Name property is a string that contains the name of the object for which the interface
is implemented. The name may not be null.
The Description property is a string that is intended to completely define the object for
which the interface is implemented. It can be null but is more typically a sentence or
paragraph.
The ShortDescription property is a brief description. It can be null, but it is usually a
short sentence describing the object that may be used in a tooltip.
Schlumberger Private
Ocean Core 3-75