Class NSAssociate

Carrier object for Associate.

Constructors

NSAssociate()

Initializes a new instance of the NSAssociate class.

Declaration

NSAssociate

Methods

GetAssociateId()

Declaration

Integer GetAssociateId()

Examples

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

Returns

Type Description
Integer Primary key.

GetDeleted()

Declaration

Bool GetDeleted()

Examples

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

Returns

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

GetEjUserId()

Declaration

Integer GetEjUserId()

Examples

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

Returns

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

GetFormalName()

Declaration

String GetFormalName()

Examples

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

Returns

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

GetFullName()

Declaration

String GetFullName()

Examples

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

Returns

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

GetGroupIdx()

Declaration

Integer GetGroupIdx()

Examples

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

Returns

Type Description
Integer Primary group membership.

GetName()

Declaration

String GetName()

Examples

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

Returns

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

GetPersonId()

Declaration

Integer GetPersonId()

Examples

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

Returns

Type Description
Integer Owning person record.

GetRank()

Declaration

Integer GetRank()

Examples

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

Returns

Type Description
Integer Rank order.

GetTooltip()

Declaration

String GetTooltip()

Examples

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

Returns

Type Description
String Tooltip or other description.

GetType()

Declaration

Integer GetType()

Examples

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

Returns

Type Description
Integer User type. See <xref href="CRMScript.NetServer.AssociateType" data-throw-if-not-resolved="false"></xref>

GetUserName()

Declaration

String GetUserName()

Examples

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

Returns

Type Description
String User name.

SetAssociateId(Integer)

Declaration

Void SetAssociateId(Integer associateId)

Examples

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

Parameters

Type Name Description
Integer associateId Primary key.

Returns

Type Description
Void

SetDeleted(Bool)

Declaration

Void SetDeleted(Bool deleted)

Examples

NSAssociate thing;
Bool deleted;
thing.SetDeleted(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

SetEjUserId(Integer)

Declaration

Void SetEjUserId(Integer ejUserId)

Examples

NSAssociate thing;
Integer ejUserId;
thing.SetEjUserId(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

SetFormalName(String)

Declaration

Void SetFormalName(String formalName)

Examples

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

Parameters

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

Returns

Type Description
Void

SetFullName(String)

Declaration

Void SetFullName(String fullName)

Examples

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

Parameters

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

Returns

Type Description
Void

SetGroupIdx(Integer)

Declaration

Void SetGroupIdx(Integer groupIdx)

Examples

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

Parameters

Type Name Description
Integer groupIdx Primary group membership.

Returns

Type Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

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

Returns

Type Description
Void

SetPersonId(Integer)

Declaration

Void SetPersonId(Integer personId)

Examples

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

Parameters

Type Name Description
Integer personId Owning person record.

Returns

Type Description
Void

SetRank(Integer)

Declaration

Void SetRank(Integer rank)

Examples

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

Parameters

Type Name Description
Integer rank Rank order.

Returns

Type Description
Void

SetTooltip(String)

Declaration

Void SetTooltip(String tooltip)

Examples

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

Parameters

Type Name Description
String tooltip Tooltip or other description.

Returns

Type Description
Void

SetType(Integer)

Declaration

Void SetType(Integer type)

Examples

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

Parameters

Type Name Description
Integer type User type. See <xref href="CRMScript.NetServer.AssociateType" data-throw-if-not-resolved="false"></xref>.

Returns

Type Description
Void

SetUserName(String)

Declaration

Void SetUserName(String userName)

Examples

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

Parameters

Type Name Description
String userName User name.

Returns

Type Description
Void