NotesName (JavaScript™)

Represents a user or server name.

Creation

Use the following NotesSession methods:

createName creates a new name.
getUserNameList gets the primary and alternate names for the current user as objects.
getUserNameObject gets the canonical name for the current user as an object.
getUserName gets the canonical name for the current user in string format.
getCommonUserName gets the common name for the current user in string format

Usage

A canonical hierarchical name is a series of components separated by slashes. Each component starts with a keyword and equals sign. Domino® names use the following components: CN (common name), OU (organizational unit - up to four are permitted), O (organization), and C (country). Domino® names do not use the following components but this class recognizes them: G (given name), I (initial), S (surname), Q (generation; for example, "Jr"), A (ADMD name), and P (PRMD name).

The following is an example of a Domino® hierarchical name in canonical format. It uses two of the available organizational units. The hierarchy is right to left, so East is organizational unit 1 and Sales is organizational unit 2.

CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US

An abbreviated name is a series of components separated by slashes. The components are not identified by keyword but depend on order for identification. The above name in abbreviated format is as follows:

John B Goode/Sales/East/Acme/US

This class does not abbreviate a canonical name if the abbreviation would be ambiguous. For example, CN=John B Goode/OU=East cannot be abbreviated because East would appear to be the organization (rather than an organizational unit). This class also does not abbreviate a canonical name if it contains any of the components not used in Domino® names.

A specification of an abbreviated name can include only those components used in Domino® names. The components must be in proper sequence. The following are acceptable:

common name/country
common name/organization (unless the name of the organization is identical to a country code)
common name/organization/country
common name/organizational unit/organization/country (up to four organizational units)

A common name by itself is interpreted as a flat name. A common name followed by a slash receives the organizational and country information of the effective user.

A name that conforms to RFC 821 or RFC 822 is interpreted as an Internet address. Examples of Internet addresses are as follows:

jbg@us.acme.com
"John B Goode" <jbg@us.acme.com>
"John B Goode" <jbg@us.acme.com> (Sales) (East)