Class NSProjectEntity
The Project Service. The service implements all services working with the Project object.
Constructors
NSProjectEntity()
Initializes a new instance of the NSProjectEntity class.
Declaration
NSProjectEntityMethods
GetActiveErpLinks()
Declaration
Integer GetActiveErpLinks()Examples
NSProjectEntity thing;
Integer activeErpLinks = thing.GetActiveErpLinks();Returns
| Type | Description |
| Integer | The number of active ERP links. |
GetActiveLinks()
Declaration
Integer GetActiveLinks()Examples
NSProjectEntity thing;
Integer activeLinks = thing.GetActiveLinks();Returns
| Type | Description |
| Integer | Number of active links to documents, other appointments, and such. |
GetActiveStatusMonitorId()
Declaration
Integer GetActiveStatusMonitorId()Examples
NSProjectEntity thing;
Integer activeStatusMonitorId = thing.GetActiveStatusMonitorId();Returns
| Type | Description |
| Integer | Active status monitor identity with the lowest rank for project. |
GetAssociate()
Declaration
NSAssociate GetAssociate()Examples
NSProjectEntity thing;
NSAssociate associate = thing.GetAssociate();Returns
| Type | Description |
| NSAssociate | The person that created the project. |
GetCompleted()
Declaration
Bool GetCompleted()Examples
NSProjectEntity thing;
Bool completed = thing.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. |
GetCreatedBy()
Declaration
NSAssociate GetCreatedBy()Examples
NSProjectEntity thing;
NSAssociate createdBy = thing.GetCreatedBy();Returns
| Type | Description |
| NSAssociate | The person that created the project. |
GetCreatedDate()
Declaration
DateTime GetCreatedDate()Examples
NSProjectEntity thing;
DateTime createdDate = thing.GetCreatedDate();Returns
| Type | Description |
| DateTime | Registered date. |
GetCustomFields()
Gets the user-defined + extra fields on a ProjectEntity as a map.
Declaration
Map GetCustomFields()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());Returns
| Type | Description |
| Map |
GetDescription()
Declaration
String GetDescription()Examples
NSProjectEntity 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. |
GetEndDate()
Declaration
DateTime GetEndDate()Examples
NSProjectEntity thing;
DateTime endDate = thing.GetEndDate();Returns
| Type | Description |
| DateTime | Planned end date for project, inherited from type and later editable. |
GetExtraFields()
Gets the extra fields on ProjectEntity as a map.
Declaration
Map GetExtraFields()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());Returns
| Type | Description |
| Map |
GetHasImage()
Declaration
Bool GetHasImage()Examples
NSProjectEntity thing;
Bool hasImage = thing.GetHasImage();Returns
| Type | Description |
| Bool | True if the project has an image. (This is the image that is displayed in the CRM client). |
GetImageDescription()
Declaration
String GetImageDescription()Examples
NSProjectEntity thing;
String imageDescription = thing.GetImageDescription();Returns
| Type | Description |
| String | Description of the project image if it exists. (This is the image that is displayed in the CRM client). |
GetIsPublished()
Declaration
Bool GetIsPublished()Returns
| Type | Description |
| Bool | Should this ProjectEntity be published and visible to strangers? |
GetLinks()
Declaration
NSLink[] GetLinks()Examples
NSProjectEntity thing;
NSLink[] links = thing.GetLinks();Returns
| Type | Description |
| NSLink[] | All elements linked to the project. |
GetName()
Declaration
String GetName()Examples
NSProjectEntity thing;
String name = thing.GetName();Returns
| Type | Description |
| String | Project name. |
GetNextMilestoneDate()
Declaration
DateTime GetNextMilestoneDate()Examples
NSProjectEntity thing;
DateTime nextMilestoneDate = thing.GetNextMilestoneDate();Returns
| Type | Description |
| DateTime | Calculated date, reflects date of closest non-complete future milestone activity. |
GetNmdAppointmentId()
Declaration
Integer GetNmdAppointmentId()Examples
NSProjectEntity thing;
Integer nmdAppointmentId = thing.GetNmdAppointmentId();Returns
| Type | Description |
| Integer | ID of appointment that "caused" the nextMilestoneDate, can be 0 |
GetPostit()
Declaration
String GetPostit()Examples
NSProjectEntity thing;
String postit = thing.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. |
GetProjectId()
Declaration
Integer GetProjectId()Examples
NSProjectEntity thing;
Integer projectId = thing.GetProjectId();Returns
| Type | Description |
| Integer | Primary key. |
GetProjectMembers()
Declaration
NSProjectMember[] GetProjectMembers()Examples
NSProjectEntity thing;
NSProjectMember[] projectMembers = thing.GetProjectMembers();Returns
| Type | Description |
| NSProjectMember[] | The persons that are members of the project. |
GetProjectNumber()
Declaration
String GetProjectNumber()Examples
NSProjectEntity thing;
String projectNumber = thing.GetProjectNumber();Returns
| Type | Description |
| String | Automatically generated number. |
GetProjectStatus()
Declaration
NSProjectStatus GetProjectStatus()Examples
NSProjectEntity thing;
NSProjectStatus projectStatus = thing.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. |
GetProjectType()
Declaration
NSProjectType GetProjectType()Examples
NSProjectEntity thing;
NSProjectType projectType = thing.GetProjectType();Returns
| Type | Description |
| NSProjectType | Project type is a list defined by the database admin. For example, 'Large', 'Small', 'Party'... |
GetPublishEventDate()
Declaration
DateTime GetPublishEventDate()Returns
| Type | Description |
| DateTime | Publish event date on ProjectEntity. |
GetPublishFrom()
Declaration
DateTime GetPublishFrom()Returns
| Type | Description |
| DateTime | Publish from date on ProjectEntity. |
GetPublishTo()
Declaration
DateTime GetPublishTo()Returns
| Type | Description |
| DateTime | Publish to date on ProjectEntity. After this date the event is no longer visible. |
GetUpdatedBy()
Declaration
NSAssociate GetUpdatedBy()Examples
NSProjectEntity thing;
NSAssociate updatedBy = thing.GetUpdatedBy();Returns
| Type | Description |
| NSAssociate | The person that last updated the project. |
GetUpdatedDate()
Declaration
DateTime GetUpdatedDate()Examples
NSProjectEntity thing;
DateTime updatedDate = thing.GetUpdatedDate();Returns
| Type | Description |
| DateTime | Last updated date. |
GetUrls()
Declaration
NSEntityElement[] GetUrls()Examples
NSProjectEntity thing;
NSEntityElement[] urls = thing.GetUrls();Returns
| Type | Description |
| NSEntityElement[] | The project's internet addresses. |
GetUserDefinedFields()
Gets the user-defined fields on the ProjectEntity as a map.
Declaration
Map GetUserDefinedFields()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());Returns
| Type | Description |
| Map |
SetActiveErpLinks(Integer)
Declaration
Void SetActiveErpLinks(Integer activeErpLinks)Examples
NSProjectEntity thing;
Integer activeErpLinks;
thing.SetActiveErpLinks(activeErpLinks);Parameters
| Type | Name | Description |
| Integer | activeErpLinks | The number of active ERP links. |
Returns
| Type | Description |
| Void |
SetActiveLinks(Integer)
Declaration
Void SetActiveLinks(Integer activeLinks)Examples
NSProjectEntity thing;
Integer activeLinks;
thing.SetActiveLinks(activeLinks);Parameters
| Type | Name | Description |
| Integer | activeLinks | Number of active links to documents, other appointments, and such. |
Returns
| Type | Description |
| Void |
SetActiveStatusMonitorId(Integer)
Declaration
Void SetActiveStatusMonitorId(Integer activeStatusMonitorId)Examples
NSProjectEntity thing;
Integer activeStatusMonitorId;
thing.SetActiveStatusMonitorId(activeStatusMonitorId);Parameters
| Type | Name | Description |
| Integer | activeStatusMonitorId | Active status monitor identity with the lowest rank for project. |
Returns
| Type | Description |
| Void |
SetAssociate(NSAssociate)
Declaration
Void SetAssociate(NSAssociate associate)Examples
NSProjectEntity thing;
NSAssociate associate;
thing.SetAssociate(associate);Parameters
| Type | Name | Description |
| associate | The person that created the project. |
Returns
| Type | Description |
| Void |
SetCompleted(Bool)
Declaration
Void SetCompleted(Bool completed)Examples
NSProjectEntity thing;
Bool completed;
thing.SetCompleted(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 |
SetCreatedBy(NSAssociate)
Declaration
Void SetCreatedBy(NSAssociate createdBy)Examples
NSProjectEntity thing;
NSAssociate createdBy;
thing.SetCreatedBy(createdBy);Parameters
| Type | Name | Description |
| createdBy | The person that created the project. |
Returns
| Type | Description |
| Void |
SetCreatedDate(DateTime)
Declaration
Void SetCreatedDate(DateTime createdDate)Examples
NSProjectEntity thing;
DateTime createdDate;
thing.SetCreatedDate(createdDate);Parameters
| Type | Name | Description |
| DateTime | createdDate | Registered date. |
Returns
| Type | Description |
| Void |
SetCustomFields(Map)
Sets the user-defined and extra fields on a ProjectEntity with a map.
Declaration
Void SetCustomFields(Map udefs)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);Parameters
| Type | Name | Description |
| Map | udefs |
Returns
| Type | Description |
| Void |
SetDescription(String)
Declaration
Void SetDescription(String description)Examples
NSProjectEntity 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 |
SetEndDate(DateTime)
Declaration
Void SetEndDate(DateTime endDate)Examples
NSProjectEntity thing;
DateTime endDate;
thing.SetEndDate(endDate);Parameters
| Type | Name | Description |
| DateTime | endDate | Planned end date for project, inherited from type and later editable. |
Returns
| Type | Description |
| Void |
SetExtraFields(Map)
Sets the extra field values on ProjectEntity with a map.
Declaration
Void SetExtraFields(Map extras)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);Parameters
| Type | Name | Description |
| Map | extras |
Returns
| Type | Description |
| Void |
SetHasImage(Bool)
Declaration
Void SetHasImage(Bool hasImage)Examples
NSProjectEntity thing;
Bool hasImage;
thing.SetHasImage(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 |
SetImageDescription(String)
Declaration
Void SetImageDescription(String imageDescription)Examples
NSProjectEntity thing;
String imageDescription;
thing.SetImageDescription(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 |
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[])
Declaration
Void SetLinks(NSLink[] links)Examples
NSProjectEntity thing;
NSLink[] links;
thing.SetLinks(links);Parameters
| Type | Name | Description |
| NSLink[] | links | List of all elements linked to the project. |
Returns
| Type | Description |
| Void |
SetName(String)
Declaration
Void SetName(String name)Examples
NSProjectEntity thing;
String name;
thing.SetName(name);Parameters
| Type | Name | Description |
| String | name | Project name. |
Returns
| Type | Description |
| Void |
SetNextMilestoneDate(DateTime)
Declaration
Void SetNextMilestoneDate(DateTime nextMilestoneDate)Examples
NSProjectEntity thing;
DateTime nextMilestoneDate;
thing.SetNextMilestoneDate(nextMilestoneDate);Parameters
| Type | Name | Description |
| DateTime | nextMilestoneDate | Calculated date, reflects date of closest non-complete future milestone activity. |
Returns
| Type | Description |
| Void |
SetNmdAppointmentId(Integer)
Declaration
Void SetNmdAppointmentId(Integer nmdAppointmentId)Examples
NSProjectEntity thing;
Integer nmdAppointmentId;
thing.SetNmdAppointmentId(nmdAppointmentId);Parameters
| Type | Name | Description |
| Integer | nmdAppointmentId | ID of appointment that "caused" the nextMilestoneDate, can be 0 |
Returns
| Type | Description |
| Void |
SetPostit(String)
Declaration
Void SetPostit(String postIt)Examples
NSProjectEntity thing;
String postIt;
thing.SetPostit(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 |
SetProjectId(Integer)
Declaration
Void SetProjectId(Integer projectId)Examples
NSProjectEntity thing;
Integer projectId;
thing.SetProjectId(projectId);Parameters
| Type | Name | Description |
| Integer | projectId | Primary key. |
Returns
| Type | Description |
| Void |
SetProjectMembers(NSProjectMember[])
Declaration
Void SetProjectMembers(NSProjectMember[] projectMembers)Examples
NSProjectEntity thing;
NSProjectMember[] projectMembers;
thing.SetProjectMembers(projectMembers);Parameters
| Type | Name | Description |
| NSProjectMember[] | projectMembers | The persons that are members of the project. |
Returns
| Type | Description |
| Void |
SetProjectNumber(String)
Declaration
Void SetProjectNumber(String projectNumber)Examples
NSProjectEntity thing;
String projectNumber;
thing.SetProjectNumber(projectNumber);Parameters
| Type | Name | Description |
| String | projectNumber | Automatically generated number. |
Returns
| Type | Description |
| Void |
SetProjectStatus(NSProjectStatus)
Declaration
Void SetProjectStatus(NSProjectStatus projectStatus)Examples
NSProjectEntity thing;
NSProjectStatus projectStatus;
thing.SetProjectStatus(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 |
SetProjectType(NSProjectType)
Declaration
Void SetProjectType(NSProjectType projectType)Examples
NSProjectEntity thing;
NSProjectType projectType;
thing.SetProjectType(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 |
SetPublishEventDate(DateTime)
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)
Declaration
Void SetUpdatedBy(NSAssociate updatedBy)Examples
NSProjectEntity thing;
NSAssociate updatedBy;
thing.SetUpdatedBy(updatedBy);Parameters
| Type | Name | Description |
| updatedBy | The person that last updated the project. |
Returns
| Type | Description |
| Void |
SetUpdatedDate(DateTime)
Declaration
Void SetUpdatedDate(DateTime updatedDate)Examples
NSProjectEntity thing;
DateTime updatedDate;
thing.SetUpdatedDate(updatedDate);Parameters
| Type | Name | Description |
| DateTime | updatedDate | Last updated date. |
Returns
| Type | Description |
| Void |
SetUrls(NSEntityElement[])
Declaration
Void SetUrls(NSEntityElement[] urls)Examples
NSProjectEntity thing;
NSEntityElement[] urls;
thing.SetUrls(urls);Parameters
| Type | Name | Description |
| NSEntityElement[] | urls | The project's internet addresses. |
Returns
| Type | Description |
| Void |
SetUserDefinedFields(Map)
Sets the user-defined fields on the ProjectEntity as a map.
Declaration
Void SetUserDefinedFields(Map udefs)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);Parameters
| Type | Name | Description |
| Map | udefs |
Returns
| Type | Description |
| Void |