HCL Notes and Domino Application Development wiki: Developing XPage Applications: NotesName sample JavaScript code for XPages

NotesName sample JavaScript code for XPages

Added by ~Elizabeth Umkroskiettu | Edited by ~Elizabeth Umkroskiettu on March 30, 2011 | Version 2

Actions ▼

2 comments

Abstract

Abstract

Here is sample JavaScript code for the class NotesName. Eventually this sample code will find its way into the documentation. Corrections and comments are appreciated.

ShowTable of Contents

Abbreviated

This computed field returns John B Goode/Sales/East/Acme/US.

var nam:NotesName = session.createName(

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

return nam.getAbbreviated();

This computed field returns the canonical hierarchical name of the current user.

return session.getUserNameObject().getAbbreviated();

Addr821

This computed field returns jbgoode@us.acme.com.

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr821();

Addr822Comment1

This computed field returns Guitars.

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr822Comment1();

Addr822Comment2

This computed field returns Music.

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr822Comment2();

Addr822Comment3

This computed field returns East.

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr822Comment3();

Addr822LocalPart

This computed field returns jbgoode.

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr822LocalPart();

Addr822Phrase

This computed field returns "John B Goode".

var nam:NotesName = session.createName(

	"\"John B Goode\" <jbgoode@us.acme.com> (Guitars) (Music) (East)");

return nam.getAddr822Phrase();

ADMD

This computed field returns acmeadmd.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/A=acmeadmd/P=acmeprmd");

return nam.getADMD();

Canonical

This computed field returns CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US.

var nam:NotesName = session.createName(

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

return nam.getCanonical();

This computed field returns the canonical hierarchical name of the current user.

return session.getUserNameObject().getCanonical();

This computed field also returns the canonical hierarchical name of the current user.

return session.getUserName();

Common

This computed field returns John B Goode.

var nam:NotesName = session.createName(

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

return nam.getCommon();

This computed field returns jbgoode.

var nam:NotesName = session.createName(

	"jbgoode@us.acme.com");

return nam.getCommon();

This computed field returns the canonical hierarchical name of the current user.

return session.getUserNameObject().getCommon();

This computed field also returns the canonical hierarchical name of the current user.

return session.getCommonUserName();

Country

This computed field returns US.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/A=acmeadmd/P=acmeprmd");

return nam.getCountry();

Generation

This computed field returns Jr.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/S=Goode/G=John/I=B/Q=Jr");

return nam.getGeneration();

Given

This computed field returns John.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/S=Goode/G=John/I=B/Q=Jr");

return nam.getGiven();

Initials

This computed field returns B.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/S=Goode/G=John/I=B/Q=Jr");

return nam.getInitials();

IsHierarchical

This computed field returns the From item from a mail message but only the common name if it is hierarchical.

if (currentDocument.hasItem("From")) {

	var from:NotesName = session.createName(

		currentDocument.getItemValueString("From"));

	return from.isHierarchical() ? from.getCommon() : from.getCanonical();

} else {

	return "Not a mail message";

Keyword

This computed field returns US\Acme\East\Sales.

var nam:NotesName = session.createName(

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

return nam.getKeyword();

Language

This computed field returns fr-CA.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US", "fr-CA");

return nam.getLanguage();

Organization

This computed field returns Acme.

var nam:NotesName = session.createName(

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

return nam.getOrganization();

OrgUnit1

This computed field returns East.

var nam:NotesName = session.createName(

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

return nam.getOrgUnit1();

OrgUnit2

This computed field returns Sales.

var nam:NotesName = session.createName(

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

return nam.getOrgUnit2();

OrgUnit3

This computed field returns Music.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Guitars/OU=Music/OU=Sales/OU=East/O=Acme/C=US");

return nam.getOrgUnit3();

OrgUnit4

This computed field returns Guitars.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Guitars/OU=Music/OU=Sales/OU=East/O=Acme/C=US");

return nam.getOrgUnit4();

Parent

This computed field returns the effective user name for the parent of a NotesName object defined elsewhere on the page.

var nam:NotesName = requestScope.nam;

return nam.getParent().getEffectiveUserName();

PRMD

This computed field returns acmeprmd.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/A=acmeadmd/P=acmeprmd");

return nam.getPRMD();

Surname

This computed field returns Goode.

var nam:NotesName = session.createName(

	"CN=John B Goode/OU=Sales/OU=East/O=Acme/C=US/S=Goode/G=John/I=B");

return nam.getSurname();

Actions ▼

Attachments (0)

Edit the article to add or modify attachments.

Versions (2)

Version ComparisonCompare version with version

Version

Date

Changed by

Summary of changes

This version (2)

Mar 30, 2011, 1:32:20 PM

~Elizabeth Umkroskiettu

Mar 29, 2011, 7:01:09 PM

~Ben Eljipypulettu

Comments (2)

~Tanita Bubazenikle commented on Jan 12, 2012

Re: NotesName sample JavaScript code for XPages

checked 1/12

~Laura Umkropulobu commented on Mar 31, 2011

Re: NotesName sample JavaScript code for XPages

Please be aware that a NotesName object has to be recycled afterwards. This might be an issue if you walk through a view and use a lot of NotesName objects.

Copy and paste this wiki markup to link to this article from another article in this wiki.

Link:

Recent articles by this author

NotesName sample JavaScript code for XPages

NotesMIMEEntity sample JavaScript code for XPages

NotesViewEntryCollection sample JavaScript code for XPages

NotesViewNavigator sample JavaScript code for XPages

NotesViewEntry sample JavaScript code for XPages

Abbreviated

Addr821

Addr822Comment1

Addr822Comment2

Addr822Comment3

Addr822LocalPart

Addr822Phrase

ADMD

Canonical

Common

Country

Generation

Given

Initials

IsHierarchical

Keyword

Language

Organization

OrgUnit1

OrgUnit2

OrgUnit3

OrgUnit4

Parent

PRMD

Surname