Class NSAssociate

Carrier object for Associate.

Syntax

Constructors

NSAssociate()

Initializes a new instance of the NSAssociate class.

Declaration

NSAssociate

Methods

GetAssociateId()

Carrier object for Associate.

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	Primary key.

Examples

NSAssociate thing;
Integer associateId = thing.GetAssociateId();

GetDeleted()

Carrier object for Associate.

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	If true, the user is retired and should have no rights, not appear in lists, and so on.

Examples

NSAssociate thing;
Bool deleted = thing.GetDeleted();

GetEjUserId()

Carrier object for Associate.

Declaration

Integer GetEjUserId()

Returns

Type	Description
Integer	ID of the ej user record corresponding to this associate; 0 for associates that are not ej users.

Examples

NSAssociate thing;
Integer ejUserId = thing.GetEjUserId();

GetFormalName()

Carrier object for Associate.

Declaration

String GetFormalName()

Returns

Type	Description
String	The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs).

Examples

NSAssociate thing;
String formalName = thing.GetFormalName();

GetFullName()

Carrier object for Associate.

Declaration

String GetFullName()

Returns

Type	Description
String	The associate's culture formatted fullname (firstname, middleName and lastname).

Examples

NSAssociate thing;
String fullName = thing.GetFullName();

GetGroupIdx()

Carrier object for Associate.

Declaration

Integer GetGroupIdx()

Returns

Type	Description
Integer	Primary group membership.

Remarks

See the UserGroupLink database table reference for secondary memberships.

Examples

NSAssociate thing;
Integer groupIdx = thing.GetGroupIdx();

GetName()

Carrier object for Associate.

Declaration

String GetName()

Returns

Type	Description
String	Initials, also login name, possibly database user name.

Examples

NSAssociate thing;
String name = thing.GetName();

GetPersonId()

Carrier object for Associate.

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Owning person record.

Examples

NSAssociate thing;
Integer personId = thing.GetPersonId();

GetRank()

Carrier object for Associate.

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank order.

Examples

NSAssociate thing;
Integer rank = thing.GetRank();

GetTooltip()

Carrier object for Associate.

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip or other description.

Examples

NSAssociate thing;
String tooltip = thing.GetTooltip();

GetType()

Carrier object for Associate.

Declaration

Integer GetType()

Returns

Type	Description
Integer	User type. See AssociateType

Examples

NSAssociate thing;
Integer type = thing.GetType();

GetUserName()

Carrier object for Associate.

Declaration

String GetUserName()

Returns

Type	Description
String	User name.

Examples

NSAssociate thing;
String userName = thing.GetUserName();

SetAssociateId(Integer)

Carrier object for Associate.

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	Primary key.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetDeleted(Bool)

Carrier object for Associate.

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	If true, the user is retired and should have no rights, not appear in lists, and so on.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Bool deleted;
thing.SetDeleted(deleted);

SetEjUserId(Integer)

Carrier object for Associate.

Declaration

Void SetEjUserId(Integer ejUserId)

Parameters

Type	Name	Description
Integer	ejUserId	ID of the ej user record corresponding to this associate; 0 for associates that are not ej users.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Integer ejUserId;
thing.SetEjUserId(ejUserId);

SetFormalName(String)

Carrier object for Associate.

Declaration

Void SetFormalName(String formalName)

Parameters

Type	Name	Description
String	formalName	The associate's culture formatted formalname (firstname, middleName and lastname, title, mrmrs).

Returns

Type	Description
Void

Examples

NSAssociate thing;
String formalName;
thing.SetFormalName(formalName);

SetFullName(String)

Carrier object for Associate.

Declaration

Void SetFullName(String fullName)

Parameters

Type	Name	Description
String	fullName	The associate's culture formatted fullname (firstname, middleName and lastname).

Returns

Type	Description
Void

Examples

NSAssociate thing;
String fullName;
thing.SetFullName(fullName);

SetGroupIdx(Integer)

Carrier object for Associate.

Declaration

Void SetGroupIdx(Integer groupIdx)

Parameters

Type	Name	Description
Integer	groupIdx	Primary group membership.

Returns

Type	Description
Void

Remarks

See the UserGroupLink database table reference for secondary memberships

Examples

NSAssociate thing;
Integer groupIdx;
thing.SetGroupIdx(groupIdx);

SetName(String)

Carrier object for Associate.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Initials, also login name, possibly database user name.

Returns

Type	Description
Void

Examples

NSAssociate thing;
String name;
thing.SetName(name);

SetPersonId(Integer)

Carrier object for Associate.

Declaration

Void SetPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId	Owning person record.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Integer personId;
thing.SetPersonId(personId);

SetRank(Integer)

Carrier object for Associate.

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank order.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Integer rank;
thing.SetRank(rank);

SetTooltip(String)

Carrier object for Associate.

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip or other description.

Returns

Type	Description
Void

Examples

NSAssociate thing;
String tooltip;
thing.SetTooltip(tooltip);

SetType(Integer)

Carrier object for Associate.

Declaration

Void SetType(Integer type)

Parameters

Type	Name	Description
Integer	type	User type. See AssociateType.

Returns

Type	Description
Void

Examples

NSAssociate thing;
Integer type;
thing.SetType(type);

SetUserName(String)

Carrier object for Associate.

Declaration

Void SetUserName(String userName)

Parameters

Type	Name	Description
String	userName	User name.

Returns

Type	Description
Void

Examples

NSAssociate thing;
String userName;
thing.SetUserName(userName);