Class NSDocument

Carrier object for Document.

Syntax

Constructors

NSDocument()

Initializes a new instance of the NSDocument class.

Introduced or updated in version: 7

Declaration

NSDocument

Methods

GetAssociateFullName()

Introduced or updated in version: 7

Declaration

String GetAssociateFullName()

Returns

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

Examples

NSDocument thing;
String associateFullName = thing.GetAssociateFullName();

GetAssociateId()

Introduced or updated in version: 7

Declaration

Integer GetAssociateId()

Returns

Type	Description
Integer	ID of associate whose diary the appointment is in, REQUIREd.

Examples

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

GetAttention()

Introduced or updated in version: 7

Declaration

String GetAttention()

Returns

Type	Description
String	Attention/salutation.

Examples

NSDocument thing;
String attention = thing.GetAttention();

GetContactId()

Introduced or updated in version: 7

Declaration

Integer GetContactId()

Returns

Type	Description
Integer	Contact ID of owning contact, may be 0

Examples

NSDocument thing;
Integer contactId = thing.GetContactId();

GetContactName()

Introduced or updated in version: 7

Declaration

String GetContactName()

Returns

Type	Description
String	Contact name.

Examples

NSDocument thing;
String contactName = thing.GetContactName();

GetDescription()

Introduced or updated in version: 7

Declaration

String GetDescription()

Returns

Type	Description
String	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

Examples

NSDocument thing;
String description = thing.GetDescription();

GetDocumentId()

Introduced or updated in version: 7

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	Primary key.

Examples

NSDocument thing;
Integer documentId = thing.GetDocumentId();

GetDocumentTemplate()

Introduced or updated in version: 7

Declaration

String GetDocumentTemplate()

Returns

Type	Description
String

Examples

NSDocument thing;
String documentTemplate = thing.GetDocumentTemplate();

GetHeader()

Introduced or updated in version: 7

Declaration

String GetHeader()

Returns

Type	Description
String	Visible document name.

Examples

NSDocument thing;
String header = thing.GetHeader();

GetIsPublished()

Introduced or updated in version: 7

Declaration

Bool GetIsPublished()

Returns

Type	Description
Bool	True if document have an entry in published table.

Examples

NSDocument thing;
Bool isPublished = thing.GetIsPublished();

GetName()

Introduced or updated in version: 7

Declaration

String GetName()

Returns

Type	Description
String	File name.

Examples

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

GetOurRef()

Introduced or updated in version: 7

Declaration

String GetOurRef()

Returns

Type	Description
String	Our reference, searchable field from free-text search.

Examples

NSDocument thing;
String ourRef = thing.GetOurRef();

GetPersonFullName()

Introduced or updated in version: 7

Declaration

String GetPersonFullName()

Returns

Type	Description
String	The full name of the person this document belongs to.

Examples

NSDocument thing;
String personFullName = thing.GetPersonFullName();

GetPersonId()

Introduced or updated in version: 7

Declaration

Integer GetPersonId()

Returns

Type	Description
Integer	Person ID of person the appointment is with, may be 0

Examples

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

GetProjectId()

Introduced or updated in version: 7

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	ID of project referred to, may be 0

Examples

NSDocument thing;
Integer projectId = thing.GetProjectId();

GetProjectName()

Introduced or updated in version: 7

Declaration

String GetProjectName()

Returns

Type	Description
String	Project name.

Examples

NSDocument thing;
String projectName = thing.GetProjectName();

GetSnum()

Introduced or updated in version: 7

Declaration

Integer GetSnum()

Returns

Type	Description
Integer	The sequence number allocated from refcount on used template when creating the document.

Examples

NSDocument thing;
Integer snum = thing.GetSnum();

GetYourRef()

Introduced or updated in version: 7

Declaration

String GetYourRef()

Returns

Type	Description
String	Your reference.

Examples

NSDocument thing;
String yourRef = thing.GetYourRef();

SetAssociateFullName(String)

Introduced or updated in version: 7

Declaration

Void SetAssociateFullName(String associateFullName)

Parameters

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

Examples

NSDocument thing;
String associateFullName;
thing.SetAssociateFullName(associateFullName);

SetAssociateId(Integer)

Introduced or updated in version: 7

Declaration

Void SetAssociateId(Integer associateId)

Parameters

Type	Name	Description
Integer	associateId	ID of associate whose diary the appointment is in, REQUIREd.

Returns

Type	Description
Void

Examples

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

SetAttention(String)

Introduced or updated in version: 7

Declaration

Void SetAttention(String attention)

Parameters

Type	Name	Description
String	attention	Attention/salutation.

Returns

Type	Description
Void

Examples

NSDocument thing;
String attention;
thing.SetAttention(attention);

SetContactId(Integer)

Introduced or updated in version: 7

Declaration

Void SetContactId(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId	Contact ID of owning contact, may be 0

Returns

Type	Description
Void

Examples

NSDocument thing;
Integer contactId;
thing.SetContactId(contactId);

SetContactName(String)

Introduced or updated in version: 7

Declaration

Void SetContactName(String contactName)

Parameters

Type	Name	Description
String	contactName	Contact name.

Returns

Type	Description
Void

Examples

NSDocument thing;
String contactName;
thing.SetContactName(contactName);

SetDescription(String)

Introduced or updated in version: 7

Declaration

Void SetDescription(String description)

Parameters

Type	Name	Description
String	description	The actual text, max 2047 significant characters even though it is stored as a larger data type on some databases.

Returns

Type	Description
Void

Examples

NSDocument thing;
String description;
thing.SetDescription(description);

SetDocumentId(Integer)

Introduced or updated in version: 7

Declaration

Void SetDocumentId(Integer documentId)

Parameters

Type	Name	Description
Integer	documentId	Primary key.

Returns

Type	Description
Void

Examples

NSDocument thing;
Integer documentId;
thing.SetDocumentId(documentId);

SetDocumentTemplate(String)

Introduced or updated in version: 7

Declaration

Void SetDocumentTemplate(String documentTemplate)

Parameters

Type	Name	Description
String	documentTemplate

Returns

Type	Description
Void

Examples

NSDocument thing;
String documentTemplate;
thing.SetDocumentTemplate(documentTemplate);

SetHeader(String)

Introduced or updated in version: 7

Declaration

Void SetHeader(String header)

Parameters

Type	Name	Description
String	header	Visible document name.

Returns

Type	Description
Void

Examples

NSDocument thing;
String header;
thing.SetHeader(header);

SetIsPublished(Bool)

Introduced or updated in version: 7

Declaration

Void SetIsPublished(Bool isPublished)

Parameters

Type	Name	Description
Bool	isPublished	True if document have an entry in published table.

Returns

Type	Description
Void

Examples

NSDocument thing;
Bool isPublished;
thing.SetIsPublished(isPublished);

SetName(String)

Introduced or updated in version: 7

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	File name.

Returns

Type	Description
Void

Examples

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

SetOurRef(String)

Introduced or updated in version: 7

Declaration

Void SetOurRef(String ourRef)

Parameters

Type	Name	Description
String	ourRef	Our reference, searchable field from free-text search.

Returns

Type	Description
Void

Examples

NSDocument thing;
String ourRef;
thing.SetOurRef(ourRef);

SetPersonFullName(String)

Introduced or updated in version: 7

Declaration

Void SetPersonFullName(String personFullName)

Parameters

Type	Name	Description
String	personFullName	The full name of the person this document belongs to.

Returns

Type	Description
Void

Examples

NSDocument thing;
String personFullName;
thing.SetPersonFullName(personFullName);

SetPersonId(Integer)

Introduced or updated in version: 7

Declaration

Void SetPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId	Person ID of person the appointment is with, may be 0

Returns

Type	Description
Void

Examples

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

SetProjectId(Integer)

Introduced or updated in version: 7

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	ID of project referred to, may be 0

Returns

Type	Description
Void

Examples

NSDocument thing;
Integer projectId;
thing.SetProjectId(projectId);

SetProjectName(String)

Introduced or updated in version: 7

Declaration

Void SetProjectName(String projectName)

Parameters

Type	Name	Description
String	projectName	Project name.

Returns

Type	Description
Void

Examples

NSDocument thing;
String projectName;
thing.SetProjectName(projectName);

SetSnum(Integer)

Introduced or updated in version: 7

Declaration

Void SetSnum(Integer snum)

Parameters

Type	Name	Description
Integer	snum	The sequence number allocated from refcount on used template when creating the document.

Returns

Type	Description
Void

Examples

NSDocument thing;
Integer snum;
thing.SetSnum(snum);

SetYourRef(String)

Introduced or updated in version: 7

Declaration

Void SetYourRef(String yourRef)

Parameters

Type	Name	Description
String	yourRef	Your reference.

Returns

Type	Description
Void

Examples

NSDocument thing;
String yourRef;
thing.SetYourRef(yourRef);