Show / Hide Table of Contents

Class NSPerson

Carrier object for Person.

Syntax

Constructors

NSPerson()

Initializes a new instance of the NSPerson class.

Declaration
NSPerson

Methods

GetActiveErpLinks()

How many active ERP links are there for this person?

Declaration
Integer GetActiveErpLinks()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer activeErpLinks = thing.GetActiveErpLinks();

GetActiveInterests()

Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true

Declaration
Integer GetActiveInterests()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer activeInterests = thing.GetActiveInterests();

GetAssociateId()

ID of the item's owner (Associate id)

Declaration
Integer GetAssociateId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer associateId = thing.GetAssociateId();

GetAssociateName()

Name of the person's owner

Declaration
String GetAssociateName()
Returns
Type Description
String
Examples
NSPerson thing;
String associateName = thing.GetAssociateName();

GetCategoryName()

The category list item name

Declaration
String GetCategoryName()
Returns
Type Description
String
Examples
NSPerson thing;
String categoryName = thing.GetCategoryName();

GetContactCountryId()

The persons contact country ID

Declaration
Integer GetContactCountryId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer contactCountryId = thing.GetContactCountryId();

GetContactDepartment()

The persons contact department

Declaration
String GetContactDepartment()
Returns
Type Description
String
Examples
NSPerson thing;
String contactDepartment = thing.GetContactDepartment();

GetContactFax()

Actual phone number as entered by the user

Declaration
String GetContactFax()
Returns
Type Description
String
Examples
NSPerson thing;
String contactFax = thing.GetContactFax();

GetContactFullName()

Company full name + department

Declaration
String GetContactFullName()
Returns
Type Description
String
Examples
NSPerson thing;
String contactFullName = thing.GetContactFullName();

GetContactId()

Owning contact ID

Declaration
Integer GetContactId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer contactId = thing.GetContactId();

GetContactName()

The persons company name

Declaration
String GetContactName()
Returns
Type Description
String
Examples
NSPerson thing;
String contactName = thing.GetContactName();

GetContactOrgNr()

The persons contact organization number

Declaration
String GetContactOrgNr()
Returns
Type Description
String
Examples
NSPerson thing;
String contactOrgNr = thing.GetContactOrgNr();

GetContactPhone()

Returns the direct phone that belong to the persons contact.

Declaration
String GetContactPhone()
Returns
Type Description
String
Examples
NSPerson thing;
String contactPhone = thing.GetContactPhone();

GetCountryId()

Country

Declaration
Integer GetCountryId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer countryId = thing.GetCountryId();

GetDescription()

Info text/description on person.

Declaration
String GetDescription()
Returns
Type Description
String
Examples
NSPerson thing;
String description = thing.GetDescription();

GetDirectPhone()

Returns the direct phone that belong to the contact person.

Declaration
String GetDirectPhone()
Returns
Type Description
String
Examples
NSPerson thing;
String directPhone = thing.GetDirectPhone();

GetEmail()

First email on contact person.

Declaration
String GetEmail()
Returns
Type Description
String
Examples
NSPerson thing;
String email = thing.GetEmail();

GetEmailName()

Email description

Declaration
String GetEmailName()
Returns
Type Description
String
Examples
NSPerson thing;
String emailName = thing.GetEmailName();

GetFaxPhone()

Returns the fax phone that belong to the contact person.

Declaration
String GetFaxPhone()
Returns
Type Description
String
Examples
NSPerson thing;
String faxPhone = thing.GetFaxPhone();

GetFirstname()

First name

Declaration
String GetFirstname()
Returns
Type Description
String
Examples
NSPerson thing;
String firstname = thing.GetFirstname();

GetFormalName()

Gets formal name for a person, as used in labels. (Full name + person title + academic title)

Declaration
String GetFormalName()
Returns
Type Description
String
Examples
NSPerson thing;
String formalName = thing.GetFormalName();

GetFullName()

Gets the persons full name (internal name used in clients for employees).

Declaration
String GetFullName()
Returns
Type Description
String
Examples
NSPerson thing;
String fullName = thing.GetFullName();

GetKanafname()

Kana first name, used in Japanese versions only

Declaration
String GetKanafname()
Returns
Type Description
String
Examples
NSPerson thing;
String kanafname = thing.GetKanafname();

GetKanalname()

Kana last name, used in Japanese versions only

Declaration
String GetKanalname()
Returns
Type Description
String
Examples
NSPerson thing;
String kanalname = thing.GetKanalname();

GetLastname()

Last name

Declaration
String GetLastname()
Returns
Type Description
String
Examples
NSPerson thing;
String lastname = thing.GetLastname();

GetMiddleName()

Middle name or 'van' etc.

Declaration
String GetMiddleName()
Returns
Type Description
String
Examples
NSPerson thing;
String middleName = thing.GetMiddleName();

GetMobilePhone()

Returns the mobile phone that belong to the contact person.

Declaration
String GetMobilePhone()
Returns
Type Description
String
Examples
NSPerson thing;
String mobilePhone = thing.GetMobilePhone();

GetMrmrs()

Carrier object for Person.

Declaration
String GetMrmrs()
Returns
Type Description
String
Examples
NSPerson thing;
String mrmrs = thing.GetMrmrs();

GetPersonId()

Primary key

Declaration
Integer GetPersonId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer personId = thing.GetPersonId();

GetPosition()

The position. This is a predefined SuperOffice value, different from Title

Declaration
String GetPosition()
Returns
Type Description
String
Examples
NSPerson thing;
String position = thing.GetPosition();

GetPost1()

Postal address, used in Japanese versions only

Declaration
String GetPost1()
Returns
Type Description
String
Examples
NSPerson thing;
String post1 = thing.GetPost1();

GetPost2()

Postal address, used in Japanese versions only

Declaration
String GetPost2()
Returns
Type Description
String
Examples
NSPerson thing;
String post2 = thing.GetPost2();

GetPost3()

Postal address, used in Japanese versions only

Declaration
String GetPost3()
Returns
Type Description
String
Examples
NSPerson thing;
String post3 = thing.GetPost3();

GetRank()

Display sort sequence for default sort order

Declaration
Integer GetRank()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer rank = thing.GetRank();

GetRetired()

1 = the user is retired and should have no rights, not appear in lists, etc.

Declaration
Integer GetRetired()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer retired = thing.GetRetired();

GetSupportAssociateId()

Our support contact for this person

Declaration
Integer GetSupportAssociateId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer supportAssociateId = thing.GetSupportAssociateId();

GetSupportLanguageId()

Support priority ID

Declaration
Integer GetSupportLanguageId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer supportLanguageId = thing.GetSupportLanguageId();

GetTicketPriorityId()

Ticket priority ID

Declaration
Integer GetTicketPriorityId()
Returns
Type Description
Integer
Examples
NSPerson thing;
Integer ticketPriorityId = thing.GetTicketPriorityId();

GetTitle()

Title

Declaration
String GetTitle()
Returns
Type Description
String
Examples
NSPerson thing;
String title = thing.GetTitle();

GetUsePersonAddress()

If 1, use person's address for mailing instead of company address

Declaration
Bool GetUsePersonAddress()
Returns
Type Description
Bool
Examples
NSPerson thing;
Bool usePersonAddress = thing.GetUsePersonAddress();

SetActiveErpLinks(Integer)

How many active ERP links are there for this person?

Declaration
Void SetActiveErpLinks(Integer activeErpLinks)
Parameters
Type Name Description
Integer activeErpLinks
Returns
Type Description
Void
Examples
NSPerson thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);

SetActiveInterests(Integer)

Number of records in pintr table; select count(*) from pintr pi where pi.person_id = this.person_id == activeInterests is always true

Declaration
Void SetActiveInterests(Integer activeInterests)
Parameters
Type Name Description
Integer activeInterests
Returns
Type Description
Void
Examples
NSPerson thing;
Integer activeInterests;
thing.SetActiveInterests(activeInterests);

SetAssociateId(Integer)

ID of the item's owner (Associate id)

Declaration
Void SetAssociateId(Integer associateId)
Parameters
Type Name Description
Integer associateId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer associateId;
thing.SetAssociateId(associateId);

SetAssociateName(String)

Name of the person's owner

Declaration
Void SetAssociateName(String associateName)
Parameters
Type Name Description
String associateName
Returns
Type Description
Void
Examples
NSPerson thing;
String associateName;
thing.SetAssociateName(associateName);

SetCategoryName(String)

The category list item name

Declaration
Void SetCategoryName(String categoryName)
Parameters
Type Name Description
String categoryName
Returns
Type Description
Void
Examples
NSPerson thing;
String categoryName;
thing.SetCategoryName(categoryName);

SetContactCountryId(Integer)

The persons contact country ID

Declaration
Void SetContactCountryId(Integer contactCountryId)
Parameters
Type Name Description
Integer contactCountryId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer contactCountryId;
thing.SetContactCountryId(contactCountryId);

SetContactDepartment(String)

The persons contact department

Declaration
Void SetContactDepartment(String contactDepartment)
Parameters
Type Name Description
String contactDepartment
Returns
Type Description
Void
Examples
NSPerson thing;
String contactDepartment;
thing.SetContactDepartment(contactDepartment);

SetContactFax(String)

Actual phone number as entered by the user

Declaration
Void SetContactFax(String contactFax)
Parameters
Type Name Description
String contactFax
Returns
Type Description
Void
Examples
NSPerson thing;
String contactFax;
thing.SetContactFax(contactFax);

SetContactFullName(String)

Company full name + department

Declaration
Void SetContactFullName(String contactFullName)
Parameters
Type Name Description
String contactFullName
Returns
Type Description
Void
Examples
NSPerson thing;
String contactFullName;
thing.SetContactFullName(contactFullName);

SetContactId(Integer)

Owning contact ID

Declaration
Void SetContactId(Integer contactId)
Parameters
Type Name Description
Integer contactId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer contactId;
thing.SetContactId(contactId);

SetContactName(String)

The persons company name

Declaration
Void SetContactName(String contactName)
Parameters
Type Name Description
String contactName
Returns
Type Description
Void
Examples
NSPerson thing;
String contactName;
thing.SetContactName(contactName);

SetContactOrgNr(String)

The persons contact organization number

Declaration
Void SetContactOrgNr(String contactOrgNr)
Parameters
Type Name Description
String contactOrgNr
Returns
Type Description
Void
Examples
NSPerson thing;
String contactOrgNr;
thing.SetContactOrgNr(contactOrgNr);

SetContactPhone(String)

Returns the direct phone that belong to the persons contact.

Declaration
Void SetContactPhone(String contactPhone)
Parameters
Type Name Description
String contactPhone
Returns
Type Description
Void
Examples
NSPerson thing;
String contactPhone;
thing.SetContactPhone(contactPhone);

SetCountryId(Integer)

Country

Declaration
Void SetCountryId(Integer countryId)
Parameters
Type Name Description
Integer countryId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer countryId;
thing.SetCountryId(countryId);

SetDescription(String)

Info text/description on person.

Declaration
Void SetDescription(String description)
Parameters
Type Name Description
String description
Returns
Type Description
Void
Examples
NSPerson thing;
String description;
thing.SetDescription(description);

SetDirectPhone(String)

Returns the direct phone that belong to the contact person.

Declaration
Void SetDirectPhone(String directPhone)
Parameters
Type Name Description
String directPhone
Returns
Type Description
Void
Examples
NSPerson thing;
String directPhone;
thing.SetDirectPhone(directPhone);

SetEmail(String)

First email on contact person.

Declaration
Void SetEmail(String email)
Parameters
Type Name Description
String email
Returns
Type Description
Void
Examples
NSPerson thing;
String email;
thing.SetEmail(email);

SetEmailName(String)

Email description

Declaration
Void SetEmailName(String emailName)
Parameters
Type Name Description
String emailName
Returns
Type Description
Void
Examples
NSPerson thing;
String emailName;
thing.SetEmailName(emailName);

SetFaxPhone(String)

Returns the fax phone that belong to the contact person.

Declaration
Void SetFaxPhone(String faxPhone)
Parameters
Type Name Description
String faxPhone
Returns
Type Description
Void
Examples
NSPerson thing;
String faxPhone;
thing.SetFaxPhone(faxPhone);

SetFirstname(String)

First name

Declaration
Void SetFirstname(String firstname)
Parameters
Type Name Description
String firstname
Returns
Type Description
Void
Examples
NSPerson thing;
String firstname;
thing.SetFirstname(firstname);

SetFormalName(String)

Gets formal name for a person, as used in labels. (Full name + person title + academic title)

Declaration
Void SetFormalName(String formalName)
Parameters
Type Name Description
String formalName
Returns
Type Description
Void
Examples
NSPerson thing;
String formalName;
thing.SetFormalName(formalName);

SetFullName(String)

Gets the persons full name (internal name used in clients for employees).

Declaration
Void SetFullName(String fullName)
Parameters
Type Name Description
String fullName
Returns
Type Description
Void
Examples
NSPerson thing;
String fullName;
thing.SetFullName(fullName);

SetKanafname(String)

Kana first name, used in Japanese versions only

Declaration
Void SetKanafname(String kanafname)
Parameters
Type Name Description
String kanafname
Returns
Type Description
Void
Examples
NSPerson thing;
String kanafname;
thing.SetKanafname(kanafname);

SetKanalname(String)

Kana last name, used in Japanese versions only

Declaration
Void SetKanalname(String kanalname)
Parameters
Type Name Description
String kanalname
Returns
Type Description
Void
Examples
NSPerson thing;
String kanalname;
thing.SetKanalname(kanalname);

SetLastname(String)

Last name

Declaration
Void SetLastname(String lastname)
Parameters
Type Name Description
String lastname
Returns
Type Description
Void
Examples
NSPerson thing;
String lastname;
thing.SetLastname(lastname);

SetMiddleName(String)

Middle name or 'van' etc.

Declaration
Void SetMiddleName(String middleName)
Parameters
Type Name Description
String middleName
Returns
Type Description
Void
Examples
NSPerson thing;
String middleName;
thing.SetMiddleName(middleName);

SetMobilePhone(String)

Returns the mobile phone that belong to the contact person.

Declaration
Void SetMobilePhone(String mobilePhone)
Parameters
Type Name Description
String mobilePhone
Returns
Type Description
Void
Examples
NSPerson thing;
String mobilePhone;
thing.SetMobilePhone(mobilePhone);

SetMrmrs(String)

Carrier object for Person.

Declaration
Void SetMrmrs(String mrmrs)
Parameters
Type Name Description
String mrmrs
Returns
Type Description
Void
Examples
NSPerson thing;
String mrmrs;
thing.SetMrmrs(mrmrs);

SetPersonId(Integer)

Primary key

Declaration
Void SetPersonId(Integer personId)
Parameters
Type Name Description
Integer personId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer personId;
thing.SetPersonId(personId);

SetPosition(String)

The position. This is a predefined SuperOffice value, different from Title

Declaration
Void SetPosition(String position)
Parameters
Type Name Description
String position
Returns
Type Description
Void
Examples
NSPerson thing;
String position;
thing.SetPosition(position);

SetPost1(String)

Postal address, used in Japanese versions only

Declaration
Void SetPost1(String post1)
Parameters
Type Name Description
String post1
Returns
Type Description
Void
Examples
NSPerson thing;
String post1;
thing.SetPost1(post1);

SetPost2(String)

Postal address, used in Japanese versions only

Declaration
Void SetPost2(String post2)
Parameters
Type Name Description
String post2
Returns
Type Description
Void
Examples
NSPerson thing;
String post2;
thing.SetPost2(post2);

SetPost3(String)

Postal address, used in Japanese versions only

Declaration
Void SetPost3(String post3)
Parameters
Type Name Description
String post3
Returns
Type Description
Void
Examples
NSPerson thing;
String post3;
thing.SetPost3(post3);

SetRank(Integer)

Display sort sequence for default sort order

Declaration
Void SetRank(Integer rank)
Parameters
Type Name Description
Integer rank
Returns
Type Description
Void
Examples
NSPerson thing;
Integer rank;
thing.SetRank(rank);

SetRetired(Integer)

1 = the user is retired and should have no rights, not appear in lists, etc.

Declaration
Void SetRetired(Integer retired)
Parameters
Type Name Description
Integer retired
Returns
Type Description
Void
Examples
NSPerson thing;
Integer retired;
thing.SetRetired(retired);

SetSupportAssociateId(Integer)

Our support contact for this person

Declaration
Void SetSupportAssociateId(Integer supportAssociateId)
Parameters
Type Name Description
Integer supportAssociateId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer supportAssociateId;
thing.SetSupportAssociateId(supportAssociateId);

SetSupportLanguageId(Integer)

Support priority ID

Declaration
Void SetSupportLanguageId(Integer supportLanguageId)
Parameters
Type Name Description
Integer supportLanguageId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer supportLanguageId;
thing.SetSupportLanguageId(supportLanguageId);

SetTicketPriorityId(Integer)

Ticket priority ID

Declaration
Void SetTicketPriorityId(Integer ticketPriorityId)
Parameters
Type Name Description
Integer ticketPriorityId
Returns
Type Description
Void
Examples
NSPerson thing;
Integer ticketPriorityId;
thing.SetTicketPriorityId(ticketPriorityId);

SetTitle(String)

Title

Declaration
Void SetTitle(String title)
Parameters
Type Name Description
String title
Returns
Type Description
Void
Examples
NSPerson thing;
String title;
thing.SetTitle(title);

SetUsePersonAddress(Bool)

If 1, use person's address for mailing instead of company address

Declaration
Void SetUsePersonAddress(Bool usePersonAddress)
Parameters
Type Name Description
Bool usePersonAddress
Returns
Type Description
Void
Examples
NSPerson thing;
Bool usePersonAddress;
thing.SetUsePersonAddress(usePersonAddress);
In This Article
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top