Retrieving description texts

There are severaloperations of the class SM_System that can be used to retrieve description texts or objects. The texts that are retrieved will be in the locale that was set either by the initial connection, or by the locale set by the most recent call to the setLocale().

If these operations are run outside of the context of a remote session, then the effective locale is CI_Locale::DEFAULT.

The getClassDescription() operation retrieves the descriptive text associated with the MODEL class name.

/// get model class description

string getClassDescription(in string className);

The getOpDescription() operation retrieves the descriptive text associated with a MODEL operation.

/// get model operation description

string getOpDescription(in string className, in string opName);

The getPropDescription() operation retrieves the descriptive text associated with a class property, such as an attribute.

/// get model property description
string getPropDescription(in string className, in string propName);

The getEventDescription operation retrieves the descriptive text associated with a MODEL event.

/// get model event description
string getEventDescription(in string className, in string eventName);

In this example, the description of the Attr1 attribute in the MyClass class is printed, in Japanese.

sysObj = object("SM_System","SM-System");
setLocale("ja_JP");
foo = sysObj->getPropDescription("MyClass","Attr1");
print(foo);