Class NSSuggestedDocumentEntity

Syntax

Constructors

NSSuggestedDocumentEntity()

Initializes a new instance of the NSSuggestedDocumentEntity class.

Introduced or updated in version: 7.5

Declaration

NSSuggestedDocumentEntity

Methods

GetDeleted()

Introduced or updated in version: 7.5

Declaration

Bool GetDeleted()

Returns

Type	Description
Bool	0 -> record is active 1 -> record is 'deleted' and should not be shown in lists.

Examples

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

GetDocTmpl()

Introduced or updated in version: 7.5

Declaration

NSDocumentTemplate GetDocTmpl()

Returns

Type	Description
NSDocumentTemplate	Document template.

Examples

NSSuggestedDocumentEntity thing;
NSDocumentTemplate docTmpl = thing.GetDocTmpl();

GetDoctmplId()

Introduced or updated in version: 7.5

Declaration

Integer GetDoctmplId()

Returns

Type	Description
Integer	Type of the suggested document.

Examples

NSSuggestedDocumentEntity thing;
Integer doctmplId = thing.GetDoctmplId();

GetHeader()

Introduced or updated in version: 7.5

Declaration

String GetHeader()

Returns

Type	Description
String	Suggested 'header'

Examples

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

GetName()

Introduced or updated in version: 7.5

Declaration

String GetName()

Returns

Type	Description
String	Item name, visible in Guide.

Examples

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

GetOurRef()

Introduced or updated in version: 7.5

Declaration

String GetOurRef()

Returns

Type	Description
String	Suggested 'our reference'

Examples

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

GetProjectTypeStatusLink()

Introduced or updated in version: 7.5

Declaration

NSProjectTypeStatusLink GetProjectTypeStatusLink()

Returns

Type	Description
NSProjectTypeStatusLink	Project type and project status link info.

Examples

NSSuggestedDocumentEntity thing;
NSProjectTypeStatusLink projectTypeStatusLink = thing.GetProjectTypeStatusLink();

GetRank()

Introduced or updated in version: 7.5

Declaration

Integer GetRank()

Returns

Type	Description
Integer	Rank, controls rank of non-instantiated items in Guide.

Examples

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

GetSaleTypeStageLink()

Introduced or updated in version: 7.5

Declaration

NSSaleTypeStageLink GetSaleTypeStageLink()

Returns

Type	Description
NSSaleTypeStageLink	Sale type and stage link info.

Examples

NSSuggestedDocumentEntity thing;
NSSaleTypeStageLink saleTypeStageLink = thing.GetSaleTypeStageLink();

GetSuggestedDocumentId()

Introduced or updated in version: 7.5

Declaration

Integer GetSuggestedDocumentId()

Returns

Type	Description
Integer	Primary key.

Examples

NSSuggestedDocumentEntity thing;
Integer suggestedDocumentId = thing.GetSuggestedDocumentId();

GetTooltip()

Introduced or updated in version: 7.5

Declaration

String GetTooltip()

Returns

Type	Description
String	Tooltip / description.

Examples

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

SetDeleted(Bool)

Introduced or updated in version: 7.5

Declaration

Void SetDeleted(Bool deleted)

Parameters

Type	Name	Description
Bool	deleted	0 -> record is active 1 -> record is 'deleted' and should not be shown in lists.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
Bool deleted;
thing.SetDeleted(deleted);

SetDocTmpl(NSDocumentTemplate)

Introduced or updated in version: 7.5

Declaration

Void SetDocTmpl(NSDocumentTemplate docTmpl)

Parameters

Type	Name	Description
NSDocumentTemplate	docTmpl	Document template.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
NSDocumentTemplate docTmpl;
thing.SetDocTmpl(docTmpl);

SetDoctmplId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetDoctmplId(Integer doctmplId)

Parameters

Type	Name	Description
Integer	doctmplId	Type of the suggested document.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
Integer doctmplId;
thing.SetDoctmplId(doctmplId);

SetHeader(String)

Introduced or updated in version: 7.5

Declaration

Void SetHeader(String header)

Parameters

Type	Name	Description
String	header	Suggested 'header'

Returns

Type	Description
Void

Examples

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

SetName(String)

Introduced or updated in version: 7.5

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Item name, visible in Guide.

Returns

Type	Description
Void

Examples

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

SetOurRef(String)

Introduced or updated in version: 7.5

Declaration

Void SetOurRef(String ourRef)

Parameters

Type	Name	Description
String	ourRef	Suggested 'our reference'

Returns

Type	Description
Void

Examples

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

SetProjectTypeStatusLink(NSProjectTypeStatusLink)

Introduced or updated in version: 7.5

Declaration

Void SetProjectTypeStatusLink(NSProjectTypeStatusLink projectTypeStatusLink)

Parameters

Type	Name	Description
NSProjectTypeStatusLink	projectTypeStatusLink	Project type and project status link info.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
NSProjectTypeStatusLink projectTypeStatusLink;
thing.SetProjectTypeStatusLink(projectTypeStatusLink);

SetRank(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetRank(Integer rank)

Parameters

Type	Name	Description
Integer	rank	Rank, controls rank of non-instantiated items in Guide.

Returns

Type	Description
Void

Examples

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

SetSaleTypeStageLink(NSSaleTypeStageLink)

Introduced or updated in version: 7.5

Declaration

Void SetSaleTypeStageLink(NSSaleTypeStageLink saleTypeStageLink)

Parameters

Type	Name	Description
NSSaleTypeStageLink	saleTypeStageLink	Sale type and stage link info.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
NSSaleTypeStageLink saleTypeStageLink;
thing.SetSaleTypeStageLink(saleTypeStageLink);

SetSuggestedDocumentId(Integer)

Introduced or updated in version: 7.5

Declaration

Void SetSuggestedDocumentId(Integer suggestedDocumentId)

Parameters

Type	Name	Description
Integer	suggestedDocumentId	Primary key.

Returns

Type	Description
Void

Examples

NSSuggestedDocumentEntity thing;
Integer suggestedDocumentId;
thing.SetSuggestedDocumentId(suggestedDocumentId);

SetTooltip(String)

Introduced or updated in version: 7.5

Declaration

Void SetTooltip(String tooltip)

Parameters

Type	Name	Description
String	tooltip	Tooltip / description.

Returns

Type	Description
Void

Examples

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