Class NSProjectEntity

The Project Service. The service implements all services working with the Project object.

Syntax

Constructors

NSProjectEntity()

Initializes a new instance of the NSProjectEntity class.

Declaration

NSProjectEntity

Methods

GetActiveErpLinks()

The Project Service. The service implements all services working with the Project object.

Declaration

Integer GetActiveErpLinks()

Returns

Type	Description
Integer	The number of active ERP links.

Examples

NSProjectEntity thing;
Integer activeErpLinks = thing.GetActiveErpLinks();

GetActiveLinks()

The Project Service. The service implements all services working with the Project object.

Declaration

Integer GetActiveLinks()

Returns

Type	Description
Integer	Number of active links to documents, other appointments, and such.

Examples

NSProjectEntity thing;
Integer activeLinks = thing.GetActiveLinks();

GetActiveStatusMonitorId()

The Project Service. The service implements all services working with the Project object.

Declaration

Integer GetActiveStatusMonitorId()

Returns

Type	Description
Integer	Active status monitor identity with the lowest rank for project.

Examples

NSProjectEntity thing;
Integer activeStatusMonitorId = thing.GetActiveStatusMonitorId();

GetAssociate()

The Project Service. The service implements all services working with the Project object.

Declaration

NSAssociate GetAssociate()

Returns

Type	Description
NSAssociate	The person that created the project.

Examples

NSProjectEntity thing;
NSAssociate associate = thing.GetAssociate();

GetCompleted()

The Project Service. The service implements all services working with the Project object.

Declaration

Bool GetCompleted()

Returns

Type	Description
Bool	Done (0=false, 1=true); implies changes in which fields are shown in GUI, as well as which fields can be updated.

Examples

NSProjectEntity thing;
Bool completed = thing.GetCompleted();

GetCreatedBy()

The Project Service. The service implements all services working with the Project object.

Declaration

NSAssociate GetCreatedBy()

Returns

Type	Description
NSAssociate	The person that created the project.

Examples

NSProjectEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();

GetCreatedDate()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetCreatedDate()

Returns

Type	Description
DateTime	Registered date.

Examples

NSProjectEntity thing;
DateTime createdDate = thing.GetCreatedDate();

GetCustomFields()

Gets the user-defined + extra fields on a ProjectEntity as a map.

Declaration

Map GetCustomFields()

Returns

Type	Description
Map

Examples

NSProjectEntity thing;
Map fields = thing.GetCustomFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetDescription()

The Project Service. The service implements all services working with the Project object.

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

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

GetEndDate()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetEndDate()

Returns

Type	Description
DateTime	Planned end date for project, inherited from type and later editable.

Examples

NSProjectEntity thing;
DateTime endDate = thing.GetEndDate();

GetExtraFields()

Gets the extra fields on ProjectEntity as a map.

Declaration

Map GetExtraFields()

Returns

Type	Description
Map

Examples

NSProjectEntity thing;
Map fields = thing.GetExtraFields();
String oldValue = fields.get("x_foobar");
fields.insert("x_foobar", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

GetHasImage()

The Project Service. The service implements all services working with the Project object.

Declaration

Bool GetHasImage()

Returns

Type	Description
Bool	True if the project has an image. (This is the image that is displayed in the CRM client).

Examples

NSProjectEntity thing;
Bool hasImage = thing.GetHasImage();

GetImageDescription()

The Project Service. The service implements all services working with the Project object.

Declaration

String GetImageDescription()

Returns

Type	Description
String	Description of the project image if it exists. (This is the image that is displayed in the CRM client).

Examples

NSProjectEntity thing;
String imageDescription = thing.GetImageDescription();

GetIsPublished()

The Project Service. The service implements all services working with the Project object.

Declaration

Bool GetIsPublished()

Returns

Type	Description
Bool	Should this ProjectEntity be published and visible to strangers?

GetLinks()

The Project Service. The service implements all services working with the Project object.

Declaration

NSLink[] GetLinks()

Returns

Type	Description
NSLink[]	All elements linked to the project.

Examples

NSProjectEntity thing;
NSLink[] links = thing.GetLinks();

GetName()

The Project Service. The service implements all services working with the Project object.

Declaration

String GetName()

Returns

Type	Description
String	Project name.

Examples

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

GetNextMilestoneDate()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetNextMilestoneDate()

Returns

Type	Description
DateTime	Calculated date, reflects date of closest non-complete future milestone activity.

Examples

NSProjectEntity thing;
DateTime nextMilestoneDate = thing.GetNextMilestoneDate();

GetNmdAppointmentId()

The Project Service. The service implements all services working with the Project object.

Declaration

Integer GetNmdAppointmentId()

Returns

Type	Description
Integer	ID of appointment that "caused" the nextMilestoneDate, can be 0

Examples

NSProjectEntity thing;
Integer nmdAppointmentId = thing.GetNmdAppointmentId();

GetPostit()

The Project Service. The service implements all services working with the Project object.

Declaration

String GetPostit()

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

NSProjectEntity thing;
String postit = thing.GetPostit();

GetProjectId()

The Project Service. The service implements all services working with the Project object.

Declaration

Integer GetProjectId()

Returns

Type	Description
Integer	Primary key.

Examples

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

GetProjectMembers()

The Project Service. The service implements all services working with the Project object.

Declaration

NSProjectMember[] GetProjectMembers()

Returns

Type	Description
NSProjectMember[]	The persons that are members of the project.

Examples

NSProjectEntity thing;
NSProjectMember[] projectMembers = thing.GetProjectMembers();

GetProjectNumber()

The Project Service. The service implements all services working with the Project object.

Declaration

String GetProjectNumber()

Returns

Type	Description
String	Automatically generated number.

Examples

NSProjectEntity thing;
String projectNumber = thing.GetProjectNumber();

GetProjectStatus()

The Project Service. The service implements all services working with the Project object.

Declaration

NSProjectStatus GetProjectStatus()

Returns

Type	Description
NSProjectStatus	Project status is a list defined by the database administrator. Different statuses of a project may be "In planning", "Started", "Finished" and so on.

Examples

NSProjectEntity thing;
NSProjectStatus projectStatus = thing.GetProjectStatus();

GetProjectType()

The Project Service. The service implements all services working with the Project object.

Declaration

NSProjectType GetProjectType()

Returns

Type	Description
NSProjectType	Project type is a list defined by the database admin. For example, 'Large', 'Small', 'Party'...

Examples

NSProjectEntity thing;
NSProjectType projectType = thing.GetProjectType();

GetPublishEventDate()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetPublishEventDate()

Returns

Type	Description
DateTime	Publish event date on ProjectEntity.

GetPublishFrom()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetPublishFrom()

Returns

Type	Description
DateTime	Publish from date on ProjectEntity.

GetPublishTo()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetPublishTo()

Returns

Type	Description
DateTime	Publish to date on ProjectEntity. After this date the event is no longer visible.

GetUpdatedBy()

The Project Service. The service implements all services working with the Project object.

Declaration

NSAssociate GetUpdatedBy()

Returns

Type	Description
NSAssociate	The person that last updated the project.

Examples

NSProjectEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();

GetUpdatedDate()

The Project Service. The service implements all services working with the Project object.

Declaration

DateTime GetUpdatedDate()

Returns

Type	Description
DateTime	Last updated date.

Examples

NSProjectEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();

GetUrls()

The Project Service. The service implements all services working with the Project object.

Declaration

NSEntityElement[] GetUrls()

Returns

Type	Description
NSEntityElement[]	The project's internet addresses.

Examples

NSProjectEntity thing;
NSEntityElement[] urls = thing.GetUrls();

GetUserDefinedFields()

Gets the user-defined fields on the ProjectEntity as a map.

Declaration

Map GetUserDefinedFields()

Returns

Type	Description
Map

Examples

NSProjectEntity thing;
Map fields = thing.GetUserDefinedFields();
String oldValue = fields.get("SuperOffice:1");
fields.insert("SuperOffice:1", "NewValue");
for (fields.first(); !fields.eof(); fields.next())
  printLine(fields.getKey() + ":  " + fields.getVal());

SetActiveErpLinks(Integer)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetActiveErpLinks(Integer activeErpLinks)

Parameters

Type	Name	Description
Integer	activeErpLinks	The number of active ERP links.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);

SetActiveLinks(Integer)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetActiveLinks(Integer activeLinks)

Parameters

Type	Name	Description
Integer	activeLinks	Number of active links to documents, other appointments, and such.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Integer activeLinks;
thing.SetActiveLinks(activeLinks);

SetActiveStatusMonitorId(Integer)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetActiveStatusMonitorId(Integer activeStatusMonitorId)

Parameters

Type	Name	Description
Integer	activeStatusMonitorId	Active status monitor identity with the lowest rank for project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Integer activeStatusMonitorId;
thing.SetActiveStatusMonitorId(activeStatusMonitorId);

SetAssociate(NSAssociate)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetAssociate(NSAssociate associate)

Parameters

Type	Name	Description
	associate	The person that created the project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);

SetCompleted(Bool)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetCompleted(Bool completed)

Parameters

Type	Name	Description
Bool	completed	Done (0=false, 1=true). Status implies changes in which fields are shown in GUI, as well as which fields can be updated.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Bool completed;
thing.SetCompleted(completed);

SetCreatedBy(NSAssociate)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetCreatedBy(NSAssociate createdBy)

Parameters

Type	Name	Description
	createdBy	The person that created the project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);

SetCreatedDate(DateTime)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetCreatedDate(DateTime createdDate)

Parameters

Type	Name	Description
DateTime	createdDate	Registered date.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);

SetCustomFields(Map)

Sets the user-defined and extra fields on a ProjectEntity with a map.

Declaration

Void SetCustomFields(Map udefs)

Parameters

Type	Name	Description
Map	udefs

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
udefs["x_foo"] = "foobar";
udefs["x_bar"] = "456"; // List item id
thing.SetCustomFields(udefs);

SetDescription(String)

The Project Service. The service implements all services working with the Project object.

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

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

SetEndDate(DateTime)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetEndDate(DateTime endDate)

Parameters

Type	Name	Description
DateTime	endDate	Planned end date for project, inherited from type and later editable.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
DateTime endDate;
thing.SetEndDate(endDate);

SetExtraFields(Map)

Sets the extra field values on ProjectEntity with a map.

Declaration

Void SetExtraFields(Map extras)

Parameters

Type	Name	Description
Map	extras

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Map extras;
extras["SuperOffice:1"] = "[I:123]";
extras["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
extras["custom.progid"] = "foobar";
thing.SetExtraFields(extras);

SetHasImage(Bool)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetHasImage(Bool hasImage)

Parameters

Type	Name	Description
Bool	hasImage	True if the project has an image. (This is the image that is displayed in the CRM client).

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Bool hasImage;
thing.SetHasImage(hasImage);

SetImageDescription(String)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetImageDescription(String imageDescription)

Parameters

Type	Name	Description
String	imageDescription	Description of the project image if it exists. (This is the image that is displayed in the CRM client).

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
String imageDescription;
thing.SetImageDescription(imageDescription);

SetIsPublished(Bool)

Sets the visibility of a ProjectEntity

Declaration

Void SetIsPublished(Bool sPublished)

Parameters

Type	Name	Description
Bool	isPublished	Should this ProjectEntity be published and visible to strangers?

Returns

Type	Description
Void

SetLinks(NSLink[])

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetLinks(NSLink[] links)

Parameters

Type	Name	Description
NSLink[]	links	List of all elements linked to the project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSLink[] links;
thing.SetLinks(links);

SetName(String)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetName(String name)

Parameters

Type	Name	Description
String	name	Project name.

Returns

Type	Description
Void

Examples

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

SetNextMilestoneDate(DateTime)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetNextMilestoneDate(DateTime nextMilestoneDate)

Parameters

Type	Name	Description
DateTime	nextMilestoneDate	Calculated date, reflects date of closest non-complete future milestone activity.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
DateTime nextMilestoneDate;
thing.SetNextMilestoneDate(nextMilestoneDate);

SetNmdAppointmentId(Integer)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetNmdAppointmentId(Integer nmdAppointmentId)

Parameters

Type	Name	Description
Integer	nmdAppointmentId	ID of appointment that "caused" the nextMilestoneDate, can be 0

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Integer nmdAppointmentId;
thing.SetNmdAppointmentId(nmdAppointmentId);

SetPostit(String)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetPostit(String postIt)

Parameters

Type	Name	Description
String	postIt	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

NSProjectEntity thing;
String postIt;
thing.SetPostit(postIt);

SetProjectId(Integer)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	Primary key.

Returns

Type	Description
Void

Examples

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

SetProjectMembers(NSProjectMember[])

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetProjectMembers(NSProjectMember[] projectMembers)

Parameters

Type	Name	Description
NSProjectMember[]	projectMembers	The persons that are members of the project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSProjectMember[] projectMembers;
thing.SetProjectMembers(projectMembers);

SetProjectNumber(String)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetProjectNumber(String projectNumber)

Parameters

Type	Name	Description
String	projectNumber	Automatically generated number.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
String projectNumber;
thing.SetProjectNumber(projectNumber);

SetProjectStatus(NSProjectStatus)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetProjectStatus(NSProjectStatus projectStatus)

Parameters

Type	Name	Description
NSProjectStatus	projectStatus	Project status is a list defined by the database administrator. Different statuses of a project may be "In planning", "Started", "Finished" and so on.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSProjectStatus projectStatus;
thing.SetProjectStatus(projectStatus);

SetProjectType(NSProjectType)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetProjectType(NSProjectType projectType)

Parameters

Type	Name	Description
NSProjectType	projectType	Project type is a list defined by the database admin. For example, 'Large', 'Small', 'Party'...

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSProjectType projectType;
thing.SetProjectType(projectType);

SetPublishEventDate(DateTime)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetPublishEventDate(DateTime publishDate)

Parameters

Type	Name	Description
DateTime	publishDate	Publish event date on ProjectEntity.

Returns

Type	Description
Void

SetPublishFrom(DateTime)

Sets the publish from date on a ProjectEntity.

Declaration

Void SetPublishFrom(DateTime publishFrom)

Parameters

Type	Name	Description
DateTime	publishFrom

Returns

Type	Description
Void

SetPublishTo(DateTime)

Sets the publish to date on ProjectEntity.

Declaration

Void SetPublishTo(DateTime publishTo)

Parameters

Type	Name	Description
DateTime	publishTo	After this date the event is no longer visible.

Returns

Type	Description
Void

SetUpdatedBy(NSAssociate)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetUpdatedBy(NSAssociate updatedBy)

Parameters

Type	Name	Description
	updatedBy	The person that last updated the project.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);

SetUpdatedDate(DateTime)

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetUpdatedDate(DateTime updatedDate)

Parameters

Type	Name	Description
DateTime	updatedDate	Last updated date.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);

SetUrls(NSEntityElement[])

The Project Service. The service implements all services working with the Project object.

Declaration

Void SetUrls(NSEntityElement[] urls)

Parameters

Type	Name	Description
NSEntityElement[]	urls	The project's internet addresses.

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
NSEntityElement[] urls;
thing.SetUrls(urls);

SetUserDefinedFields(Map)

Sets the user-defined fields on the ProjectEntity as a map.

Declaration

Void SetUserDefinedFields(Map udefs)

Parameters

Type	Name	Description
Map	udefs

Returns

Type	Description
Void

Examples

NSProjectEntity thing;
Map udefs;
udefs["SuperOffice:1"] = "[I:123]";
udefs["SuperOffice:1"] = "123"; // this will also work, but beware of decimal point variations in different languages
udefs["custom.progid"] = "foobar";
thing.SetUserDefinedFields(udefs);