Name Class Reference

The Name data type class represents a string containing a name. More...

Inheritance diagram for Name:

Collaboration diagram for Name:

Static Public Member Functions
_.Library.Name	DisplayToLogical (_, _.Library.String val)
	Converts the input value val, which is a string representing. More...
_.Library.Status	IsValid (_, _.Library.RawString val)
	Tests if the logical value val, which is a string, is valid. More...
_.Library.String	LogicalToDisplay (_, _.Library.Name val)
	Converts the value of val into a display string. More...

Static Public Attributes
	COLLATION = None
	The Name data type class represents a string containing a name. More...
	INDEXSUBSCRIPTS = None
	The number of subscripts used by the attribute in indices. More...
	JSONTYPE = None
	JSONTYPE is JSON type used for this datatype.
	MAXLEN = None
	The maximum number of characters the string can contain.
	XSDTYPE = None
	Declares the XSD type used when projecting XML Schemas.
Static Public Attributes inherited from DataType
	INDEXNULLMARKER = None
	Override this parameter value to specify what value should be used as a null marker when a property of the type is used in a subscript of an index map. More...

Detailed Description

The Name data type class represents a string containing a name.

The logical value of the Name data type is a string of the form "lastname,firstname".

The Name data type has special indexing support when used in conjunction with the <CLASS>Storage.Persistent</CLASS> class (see the INDEXSUBSCRIPTS parameter).

Member Function Documentation

DisplayToLogical()

_.Library.Name DisplayToLogical (   _, _.Library.String  val  )

static

Converts the input value val, which is a string representing.

a name, into the internal format.

Returns the internal value of the input string val.

IsValid()

_.Library.Status IsValid (   _, _.Library.RawString  val  )

static

Tests if the logical value val, which is a string, is valid.

The validation is based on the class parameter settings used for the class attribute this data type is associated with.

Reimplemented from DataType.

LogicalToDisplay()

_.Library.String LogicalToDisplay (   _, _.Library.Name  val  )

static

Converts the value of val into a display string.

Returns the formatted value of val.

Member Data Documentation

COLLATION

COLLATION = None

static

The Name data type class represents a string containing a name.

The logical value of the Name data type is a string of the form "lastname,firstname".

The Name data type has special indexing support when used in conjunction with the <CLASS>Storage.Persistent</CLASS> class (see the INDEXSUBSCRIPTS parameter).

The default collation value used for this data type.

INDEXSUBSCRIPTS

INDEXSUBSCRIPTS = None

static

The number of subscripts used by the attribute in indices.

This parameter, if present, tells the methods of the <class>Storage.Persistent</class> class (that is, the default storage structure) the number of subscripts used by the attribute in indices, using a comma as a delimiter in the property value.

The Name data type has the value 2 for INDEXSUBSCRIPTS, meaning the 1st comma piece of the name (the last name) is stored as the first subscript and the 2nd comma piece of the name (the first name) is stored as the second subscript.