User class

A User object represents a user stored in a CP2 dataset.

Getters [R]

getName( ) : String
getCompany( ) : String
getStreet( ) : String
getPostalCode( ) : String
getCity( ) : String
getState( ) : String
getCountry( ) : String
getEMail( ) : String
getPhone( ) : String
getFax( ) : String
Returns the corresponding property of this user's contact information, or the empty string if the property is absent.
getUserMessage( ) : String
Returns the user-supplied message associated with this user (CP2:message). This function returns the English language alternate, or the empty string if the property is absent.
getUserMessageLocalized( ) : AltText
Returns the user-supplied message associated with this user (CP2:message). This function returns the complete set of language alternates, which is empty if the property is absent. For the active user, the returned AltText object is writable.

Setters [W]

These functions may be invoked only on the active user. Invoking them on any other user is a programming error and has unpredictable results.
setName( value : String )
setCompany( value : String )
setStreet( value : String )
setPostalCode( value : String )
setCity( value : String )
setState( value : String )
setCountry( value : String )
setEMail( value : String )
setPhone( value : String )
setFax( value : String )
Sets the corresponding property of this user's contact information.
setUserMessage( value : String )
Sets the user-supplied message associated with this user (CP2:message). This function sets the English language alternate and erases all other alternates. To set other language alternates, use appropriate setters on an AltText object obtained with getUserMessageLocalized().