Public Member Functions | Private Attributes
t_comdef_local_type Class Reference

Allows us to specify a language to the instance (example: English or French) More...

List of all members.

Public Member Functions

 SetLocalLang ($in_lang_enum=null)
 Sets the language.
 GetLocalLang ()
 Returns a reference to the local language setting.
 SetLocalName ($in_name_string)
 Accessor -Sets the _local_type_name_string data member.
 GetLocalName ()
 Accessor -Returns a reference to the _local_type_name_string data member.
 SetLocalDescription ($in_description_string)
 Accessor -Sets the _local_type_desc_string data member.
 GetLocalDescription ()
 Accessor -Returns a reference to the _local_type_desc_string data member.

Private Attributes

 $_local_type_lang_enum = null
 $_local_type_name_string = null
 $_local_type_desc_string = null

Detailed Description

Allows us to specify a language to the instance (example: English or French)

This class also allows us to specify a name for the instance, as a string, as well as a description.


Member Function Documentation

t_comdef_local_type::GetLocalDescription ( )

Accessor -Returns a reference to the _local_type_desc_string data member.

Returns:
A reference to the _local_type_desc_string data member.
t_comdef_local_type::GetLocalLang ( )

Returns a reference to the local language setting.

Returns:
A reference to the _local_type_lang_enum data member
t_comdef_local_type::GetLocalName ( )

Accessor -Returns a reference to the _local_type_name_string data member.

Returns:
A reference to the _local_type_name_string data member.
t_comdef_local_type::SetLocalDescription ( in_description_string)

Accessor -Sets the _local_type_desc_string data member.

Parameters:
in_description_stringThe description as a string up to 4000 characters long.
t_comdef_local_type::SetLocalLang ( in_lang_enum = null)

Sets the language.

This is the server language.

Should never be necessary.

Parameters:
in_lang_enumAn enum, indicating the language
  • Defaults to Global Language
  • as a last resort, English ("en").
t_comdef_local_type::SetLocalName ( in_name_string)

Accessor -Sets the _local_type_name_string data member.

Parameters:
in_name_stringThe name of this object, as a string.

Referenced by DisplayOneServiceBodyEditor().


Member Data Documentation

t_comdef_local_type::$_local_type_desc_string = null [private]
t_comdef_local_type::$_local_type_lang_enum = null [private]
t_comdef_local_type::$_local_type_name_string = null [private]

The documentation for this class was generated from the following file:
 All Classes Files Functions Variables Enumerations