Class NSDocument

Carrier object for Document.

Constructors

NSDocument()

Initializes a new instance of the NSDocument class.

Declaration

NSDocument

Methods

GetAssociateFullName()

Declaration

String GetAssociateFullName()

Examples

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

Returns

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

GetAssociateId()

Declaration

Integer GetAssociateId()

Examples

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

Returns

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

GetAttention()

Declaration

String GetAttention()

Examples

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

Returns

Type	Description
String	Attention/salutation.

GetContactId()

Declaration

Integer GetContactId()

Examples

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

Returns

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

GetContactName()

Declaration

String GetContactName()

Examples

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

Returns

Type	Description
String	Contact name.

GetDescription()

Declaration

String GetDescription()

Examples

NSDocument thing;
String description = thing.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.

GetDocumentId()

Declaration

Integer GetDocumentId()

Examples

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

Returns

Type	Description
Integer	Primary key.

GetDocumentTemplate()

Declaration

String GetDocumentTemplate()

Examples

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

Returns

Type	Description
String

GetHeader()

Declaration

String GetHeader()

Examples

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

Returns

Type	Description
String	Visible document name.

GetIsPublished()

Declaration

Bool GetIsPublished()

Examples

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

Returns

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

GetName()

Declaration

String GetName()

Examples

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

Returns

Type	Description
String	File name.

GetOurRef()

Declaration

String GetOurRef()

Examples

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

Returns

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

GetPersonFullName()

Declaration

String GetPersonFullName()

Examples

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

Returns

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

GetPersonId()

Declaration

Integer GetPersonId()

Examples

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

Returns

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

GetProjectId()

Declaration

Integer GetProjectId()

Examples

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

Returns

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

GetProjectName()

Declaration

String GetProjectName()

Examples

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

Returns

Type	Description
String	Project name.

GetSnum()

Declaration

Integer GetSnum()

Examples

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

Returns

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

GetYourRef()

Declaration

String GetYourRef()

Examples

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

Returns

Type	Description
String	Your reference.

SetAssociateFullName(String)

Declaration

Void SetAssociateFullName(String associateFullName)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetAssociateId(Integer)

Declaration

Void SetAssociateId(Integer associateId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetAttention(String)

Declaration

Void SetAttention(String attention)

Examples

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

Parameters

Type	Name	Description
String	attention	Attention/salutation.

Returns

Type	Description
Void

SetContactId(Integer)

Declaration

Void SetContactId(Integer contactId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetContactName(String)

Declaration

Void SetContactName(String contactName)

Examples

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

Parameters

Type	Name	Description
String	contactName	Contact name.

Returns

Type	Description
Void

SetDescription(String)

Declaration

Void SetDescription(String description)

Examples

NSDocument thing;
String description;
thing.SetDescription(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

SetDocumentId(Integer)

Declaration

Void SetDocumentId(Integer documentId)

Examples

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

Parameters

Type	Name	Description
Integer	documentId	Primary key.

Returns

Type	Description
Void

SetDocumentTemplate(String)

Declaration

Void SetDocumentTemplate(String documentTemplate)

Examples

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

Parameters

Type	Name	Description
String	documentTemplate

Returns

Type	Description
Void

SetHeader(String)

Declaration

Void SetHeader(String header)

Examples

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

Parameters

Type	Name	Description
String	header	Visible document name.

Returns

Type	Description
Void

SetIsPublished(Bool)

Declaration

Void SetIsPublished(Bool isPublished)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetName(String)

Declaration

Void SetName(String name)

Examples

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

Parameters

Type	Name	Description
String	name	File name.

Returns

Type	Description
Void

SetOurRef(String)

Declaration

Void SetOurRef(String ourRef)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetPersonFullName(String)

Declaration

Void SetPersonFullName(String personFullName)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetPersonId(Integer)

Declaration

Void SetPersonId(Integer personId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetProjectId(Integer)

Declaration

Void SetProjectId(Integer projectId)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetProjectName(String)

Declaration

Void SetProjectName(String projectName)

Examples

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

Parameters

Type	Name	Description
String	projectName	Project name.

Returns

Type	Description
Void

SetSnum(Integer)

Declaration

Void SetSnum(Integer snum)

Examples

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

Parameters

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

Returns

Type	Description
Void

SetYourRef(String)

Declaration

Void SetYourRef(String yourRef)

Examples

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

Parameters

Type	Name	Description
String	yourRef	Your reference.

Returns

Type	Description
Void