Class NSDocument

Carrier object for Document.

Syntax

Constructors

NSDocument()

Initializes a new instance of the NSDocument class.

Declaration

NSDocument

Methods

GetAssociateFullName()

Carrier object for Document.

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()

Carrier object for Document.

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()

Carrier object for Document.

Declaration

String GetAttention()

Returns

Type	Description
String	Attention/salutation.

Examples

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

GetContactId()

Carrier object for Document.

Declaration

Integer GetContactId()

Returns

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

Examples

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

GetContactName()

Carrier object for Document.

Declaration

String GetContactName()

Returns

Type	Description
String	Contact name.

Examples

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

GetDescription()

Carrier object for Document.

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()

Carrier object for Document.

Declaration

Integer GetDocumentId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetDocumentTemplate()

Carrier object for Document.

Declaration

String GetDocumentTemplate()

Returns

Type	Description
String

Examples

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

GetHeader()

Carrier object for Document.

Declaration

String GetHeader()

Returns

Type	Description
String	Visible document name.

Examples

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

GetIsPublished()

Carrier object for Document.

Declaration

Bool GetIsPublished()

Returns

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

Examples

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

GetName()

Carrier object for Document.

Declaration

String GetName()

Returns

Type	Description
String	File name.

Examples

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

GetOurRef()

Carrier object for Document.

Declaration

String GetOurRef()

Returns

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

Examples

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

GetPersonFullName()

Carrier object for Document.

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()

Carrier object for Document.

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()

Carrier object for Document.

Declaration

Integer GetProjectId()

Returns

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

Examples

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

GetProjectName()

Carrier object for Document.

Declaration

String GetProjectName()

Returns

Type	Description
String	Project name.

Examples

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

GetSnum()

Carrier object for Document.

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()

Carrier object for Document.

Declaration

String GetYourRef()

Returns

Type	Description
String	Your reference.

Examples

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

SetAssociateFullName(String)

Carrier object for Document.

Declaration

Void SetAssociateFullName(String associateFullName)

Parameters

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

Returns

Type	Description
Void

Examples

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

SetAssociateId(Integer)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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)

Carrier object for Document.

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);