Class NSProjectAgent

Collection of all services that work with Project data.

Syntax

Examples

NSProjectAgent agent;
agent.callMethod(arg1, arg2);

Constructors

NSProjectAgent()

Collection of all services that work with Project data.

Introduced or updated in version: 7

Declaration

NSProjectAgent

Examples

NSProjectAgent agent;
agent.callMethod(arg1, arg2);

Methods

AddProjectMembers(Integer,NSProjectMember[])

Adds multiple project members to a project

Introduced or updated in version: 7

Declaration

Void AddProjectMembers(Integer projectEntityId, NSProjectMember[] projectMembers)

Parameters

Type	Name	Description
Integer	projectEntityId
NSProjectMember[]	projectMembers

Returns

Type	Description
Void

CreateDefaultProjectEntity()

Sets default values into a new NSProjectEntity.

Introduced or updated in version: 7

Declaration

NSProjectEntity CreateDefaultProjectEntity()

Returns

Type	Description
NSProjectEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSProjectAgent agent;
NSProjectEntity thing = agent.CreateDefaultProjectEntity();
thing = agent.SaveProjectEntity(thing);

CreateDefaultProjectEventEntity()

Sets default values into a new NSProjectEventEntity.

Introduced or updated in version: 7

Declaration

NSProjectEventEntity CreateDefaultProjectEventEntity()

Returns

Type	Description
NSProjectEventEntity

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSProjectAgent agent;
NSProjectEventEntity thing = agent.CreateDefaultProjectEventEntity();
thing = agent.SaveProjectEventEntity(thing);

CreateDefaultProjectMember()

Sets default values into a new NSProjectMember.

Introduced or updated in version: 8.2

Declaration

NSProjectMember CreateDefaultProjectMember()

Returns

Type	Description
NSProjectMember

Remarks

NetServer calculates default values (for example, Country) on the entity, which is required when creating/storing a new instance

Examples

NSProjectAgent agent;
NSProjectMember thing = agent.CreateDefaultProjectMember();
thing = agent.SaveProjectMember(thing);

CreateNewEntry()

Creates a new project based on external duplicate

Introduced or updated in version: 7

Declaration

Integer CreateNewEntry(NSDuplicateEntry duplicate)

Returns

Type	Description
Integer

Examples

NSProjectAgent agent;
NSDuplicateEntry duplicate;
Integer res = agent.CreateNewEntry(duplicate);

DeleteProjectEntity(Integer)

Deletes the NSProjectEntity

Introduced or updated in version: 7

Declaration

DeleteProjectEntity(Integer projectEntity)

Parameters

Type	Name	Description
Integer	projectEntity

Returns

Type	Description
Void

Examples

NSProjectAgent agent;
agent.DeleteProjectEntity(123);

DeleteProjectEventEntity(Integer)

Deletes the NSProjectEventEntity

Introduced or updated in version: 7

Declaration

DeleteProjectEventEntity(Integer projectEventEntity)

Parameters

Type	Name	Description
Integer	projectEventEntity

Returns

Type	Description
Void

Examples

NSProjectAgent agent;
agent.DeleteProjectEventEntity(123);

DeleteProjectEventEntityFromProjectId(Integer)

Deletes a project event based on a project ID. Does not delete the project, but does delete the published and ExternalEvent and AudienceVisibility records.

Introduced or updated in version: 7

Declaration

Void DeleteProjectEventEntityFromProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
Void

Examples

NSProjectAgent agent;
Integer projectId;
agent.DeleteProjectEventEntityFromProjectId(projectId);

DeleteProjectMember(Integer)

Deletes the NSProjectMember

Introduced or updated in version: 8.2

Declaration

DeleteProjectMember(Integer projectMember)

Parameters

Type	Name	Description
Integer	projectMember

Returns

Type	Description
Void

Examples

NSProjectAgent agent;
agent.DeleteProjectMember(123);

DeleteProjectMemberByIds(Integer[])

Deletes project-member rows.

Introduced or updated in version: 7

Declaration

Void DeleteProjectMemberByIds(Integer[] projectMemberIds)

Parameters

Type	Name	Description
Integer[]	projectMemberIds

Returns

Type	Description
Void

DeleteProjectMembers(Integer,Integer[])

Deletes the given project members from a project

Introduced or updated in version: 7

Declaration

Void DeleteProjectMembers(Integer projectEntityId, Integer[] memberIds)

Parameters

Type	Name	Description
Integer	projectEntityId
Integer[]	memberIds

Returns

Type	Description
Void

GetDuplicateRules()

Retrieve all available duplicate rules for project

Introduced or updated in version: 7

Declaration

NSDuplicateRule[] GetDuplicateRules()

Returns

Type	Description
NSDuplicateRule[]

Examples

NSProjectAgent agent;
NSDuplicateRule[] res = agent.GetDuplicateRules();

GetDuplicates(String)

Gets duplicates(exact or similar in the database) based on the name

Introduced or updated in version: 7

Declaration

NSDuplicateEntry[] GetDuplicates(String name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
NSDuplicateEntry[]

Examples

NSProjectAgent agent;
String name;
NSDuplicateEntry[] res = agent.GetDuplicates(name);

GetMyMemberProjects()

Returns projects where an user is project member.

Introduced or updated in version: 7

Declaration

NSProject[] GetMyMemberProjects()

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
NSProject[] res = agent.GetMyMemberProjects();

GetMyProjectEvents()

Gets all project events that belongs to the currently logged-on user.

Introduced or updated in version: 7

Declaration

NSProjectEvent[] GetMyProjectEvents()

Returns

Type	Description
NSProjectEvent[]	The list of events is filtered by the Audience Visibility restrictions set when the project event is created.

Examples

NSProjectAgent agent;
NSProjectEvent[] res = agent.GetMyProjectEvents();

GetMyProjects(Bool)

Returns projects belonging to an associate. If memberProjects is false only the projects where the associate is project responsible is returned, otherwise both the projects where the associate is project responsible and project member is returned.

Introduced or updated in version: 7

Declaration

NSProject[] GetMyProjects(Bool includeMemberProjects)

Parameters

Type	Name	Description
Bool	includeMemberProjects

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
Bool includeMemberProjects;
NSProject[] res = agent.GetMyProjects(includeMemberProjects);

GetMyPublishedProjects()

Gets published projects from the logged in user.

Introduced or updated in version: 7

Declaration

NSProject[] GetMyPublishedProjects()

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
NSProject[] res = agent.GetMyPublishedProjects();

GetNextMilestone(Integer)

Introduced or updated in version: 7.1.1

Declaration

NSAppointment GetNextMilestone(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId	Next upcoming milestone appointment.

Returns

Type	Description
NSAppointment

Examples

NSProjectAgent agent;
Integer projectId;
NSAppointment res = agent.GetNextMilestone(projectId);

GetNextProjectStatus(Integer)

Introduced or updated in version: 7.1.1

Declaration

Integer GetNextProjectStatus(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
Integer

GetProject(Integer)

Gets an NSProject object.

Introduced or updated in version: 7

Declaration

NSProject GetProject(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
NSProject

Examples

NSProjectAgent agent;
NSProject thing = agent.GetProject(123);

GetProjectEntity(Integer)

Gets an NSProjectEntity object.

Introduced or updated in version: 7

Declaration

NSProjectEntity GetProjectEntity(Integer projectEntityId)

Parameters

Type	Name	Description
Integer	projectEntityId

Returns

Type	Description
NSProjectEntity

Examples

NSProjectAgent agent;
NSProjectEntity thing = agent.GetProjectEntity(123);

GetProjectEvent(Integer)

Gets an NSProjectEvent object.

Introduced or updated in version: 7

Declaration

NSProjectEvent GetProjectEvent(Integer projectEventId)

Parameters

Type	Name	Description
Integer	projectEventId

Returns

Type	Description
NSProjectEvent

Examples

NSProjectAgent agent;
NSProjectEvent thing = agent.GetProjectEvent(123);

GetProjectEventEntity(Integer)

Gets an NSProjectEventEntity object.

Introduced or updated in version: 7

Declaration

NSProjectEventEntity GetProjectEventEntity(Integer projectEventEntityId)

Parameters

Type	Name	Description
Integer	projectEventEntityId

Returns

Type	Description
NSProjectEventEntity

Examples

NSProjectAgent agent;
NSProjectEventEntity thing = agent.GetProjectEventEntity(123);

GetProjectEventEntityFromProjectId(Integer)

Gets an NSProjectEventEntity based on a projectId.

Introduced or updated in version: 7

Declaration

NSProjectEventEntity GetProjectEventEntityFromProjectId(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
NSProjectEventEntity

Examples

NSProjectAgent agent;
Integer projectId;
NSProjectEventEntity res = agent.GetProjectEventEntityFromProjectId(projectId);

GetProjectEventList(Integer[])

Gets an array of NSProjectEvent objects.

Introduced or updated in version: 7

Declaration

NSProjectEvent[] GetProjectEventList(Integer[]  projectEventIds)

Parameters

Type	Name	Description
Integer[]	projectEventIds

Returns

Type	Description
NSProjectEvent[]

Examples

Integer[] ids;
NSProjectAgent agent;
NSProjectEvent[] res = agent.GetProjectEventList(ids);

GetProjectEventOnPerson(Integer,Integer)

Gets an NSProjectEvent object from a project and a person.

Introduced or updated in version: 7

Declaration

NSProjectEvent GetProjectEventOnPerson(Integer projectId, Integer personId)

Parameters

Type	Name	Description
Integer	projectId
Integer	personId

Returns

Type	Description
NSProjectEvent

GetProjectEventsOnPerson(Integer)

Gets all project events that belongs to the person specified.

Introduced or updated in version: 7

Declaration

NSProjectEvent[] GetProjectEventsOnPerson(Integer personId)

Parameters

Type	Name	Description
Integer	personId

Returns

Type	Description
NSProjectEvent[]	The list of events are filtered by the Audience Visibility restrictions set when the project event is created.

Examples

NSProjectAgent agent;
Integer personId;
NSProjectEvent[] res = agent.GetProjectEventsOnPerson(personId);

GetProjectImage(Integer)

Returns the project image that is displayed in the CRM application.

Introduced or updated in version: 7

Declaration

NSImage GetProjectImage(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
NSImage

Examples

NSProjectAgent agent;
Integer projectId;
NSImage res = agent.GetProjectImage(projectId);

GetProjectList(Integer[])

Gets an array of Project objects.

Introduced or updated in version: 7

Declaration

NSProject[] GetProjectList(Integer[] projectIds)

Parameters

Type	Name	Description
Integer[]	projectIds

Returns

Type	Description
NSProject[]

Examples

Integer[] ids;
NSProjectAgent agent;
NSProject[] res = agent.GetProjectList(ids);

GetProjectMember(Integer)

Gets an NSProjectMember object.

Introduced or updated in version: 7

Declaration

NSProjectMember GetProjectMember(Integer projectMemberId)

Parameters

Type	Name	Description
Integer	projectMemberId

Returns

Type	Description
NSProjectMember

Examples

NSProjectAgent agent;
NSProjectMember thing = agent.GetProjectMember(123);

GetProjectMembers(Integer)

Returns an array of project members

Introduced or updated in version: 7

Declaration

NSProjectMember[] GetProjectMembers(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
NSProjectMember[]

Examples

NSProjectAgent agent;
Integer projectId;
NSProjectMember[] res = agent.GetProjectMembers(projectId);

GetProjectMembersById(Integer[])

Returns an array of project members.

Introduced or updated in version: 7

Declaration

NSProjectMember[] GetProjectMembersById(Integer[] projectMemberIds)

Parameters

Type	Name	Description
Integer[]	projectMemberIds

Returns

Type	Description
NSProjectMember[]

Examples

NSProjectAgent agent;
Integer rojectMemberIds;
NSProjectMember[] res = agent.GetProjectMembersById(projectMemberIds);

GetProjectsFromContact(Integer)

Returns all projects where the given contact has project members.

Introduced or updated in version: 7

Declaration

NSProject[] GetProjectsFromContact(Integer contactId)

Parameters

Type	Name	Description
Integer	contactId

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
Integer contactId;
NSProject[] res = agent.GetProjectsFromContact(contactId);

GetProjectsFromPerson(Integer)

Returns all projects where the person is project member.

Introduced or updated in version: 7

Declaration

NSProject[] GetProjectsFromPerson(Integer personId)

Parameters

Type	Name	Description
Integer	personId

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
Integer personId;
NSProject[] res = agent.GetProjectsFromPerson(personId);

GetPublishedProject(Integer)

Gets published project by project ID.

Introduced or updated in version: 7

Declaration

NSProject GetPublishedProject(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
NSProject

Examples

NSProjectAgent agent;
Integer projectId;
NSProject res = agent.GetPublishedProject(projectId);

GetPublishedProjects(Integer[])

Gets published projects by project IDs.

Introduced or updated in version: 7

Declaration

NSProject[] GetPublishedProjects(Integer[] projectIds)

Parameters

Type	Name	Description
Integer[]	projectIds

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
Integer[] projectIds;
NSProject[] res = agent.GetPublishedProjects(projectIds);

GetPublishedProjectsOnPersonId(Integer)

Gets published projects where person is a member

Introduced or updated in version: 7

Declaration

NSProject[] GetPublishedProjectsOnPersonId(Integer personId)

Parameters

Type	Name	Description
Integer	personId

Returns

Type	Description
NSProject[]

Examples

NSProjectAgent agent;
Integer personId;
NSProject[] res = agent.GetPublishedProjectsOnPersonId(personId);

HasGuide(Integer)

Introduced or updated in version: 7.1.1

Declaration

Bool HasGuide(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
Bool	Does this project have a guide associated with its project type?

Examples

NSProjectAgent agent;
Integer projectId;
Bool res = agent.HasGuide(projectId);

HasGuideActivities(Integer)

Introduced or updated in version: 7.1.1

Declaration

Bool HasGuideActivities(Integer projectId)

Parameters

Type	Name	Description
Integer	projectId

Returns

Type	Description
Bool

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Introduced or updated in version: 7

Declaration

Bool IsNumberValid(Integer contactId, String number)

Parameters

Type	Name	Description
Integer	contactId
String	number

Returns

Type	Description
Bool

Remarks

The setting is configured from admin under system options.

Examples

NSProjectAgent agent;
Integer contactId;
String number;
Bool res = agent.IsNumberValid(contactId, number);

Merge(Integer,Integer,Bool)

Merges two projects into one, removing the source project in the process

Introduced or updated in version: 7

Declaration

Void Merge(Integer sourceProjectId, Integer destinationProjectId, Bool replaceEmptyFieldsOnDestination)

Parameters

Type	Name	Description
Integer	sourceProjectId
Integer	destinationProjectId
Bool	replaceEmptyFieldsOnDestination

Returns

Type	Description
Void

OfferAutoNextStatusOnApppointmentCompleted(Integer)

Introduced or updated in version: 7.1.1

Declaration

Bool OfferAutoNextStatusOnApppointmentCompleted(Integer appointmentId)

Parameters

Type	Name	Description
Integer	appointmentId

Returns

Type	Description
Bool

SaveProjectEntity(NSProjectEntity)

Updates the existing NSProjectEntity or creates a new NSProjectEntity if the ID parameter is 0.

Introduced or updated in version: 7

Declaration

NSProjectEntity SaveProjectEntity(NSProjectEntity projectEntity)

Parameters

Type	Name	Description
NSProjectEntity	projectEntity	The entity to save.

Returns

Type	Description
NSProjectEntity	New or updated NSProjectEntity.

Examples

NSProject  agent;
NSProjectEntity thing = agent.CreateDefaultProjectEntity();
thing = agent.SaveProjectEntity(thing);

SaveProjectEventEntity(NSProjectEventEntity)

Updates the existing NSProjectEventEntity or creates a new NSProjectEventEntity if the ID parameter is 0.

Returns.

Introduced or updated in version: 7

Declaration

NSProjectEventEntity SaveProjectEventEntity(NSProjectEventEntity entity)

Parameters

Type	Name	Description
NSProjectEventEntity	entity	The entity to save.

Returns

Type	Description
NSProjectEventEntity	The new or updated NSProjectEventEntity.

Examples

NSProject agent;
NSProjectEventEntity thing = agent.CreateDefaultProjectEventEntity();
thing = agent.SaveProjectEventEntity(thing);

SaveProjectMember(NSProjectMember)

Updates the existing NSProjectMember or creates a new NSProjectMember if the id parameter is 0

Introduced or updated in version: 8.2

Declaration

NSProjectMember SaveProjectMember(NSProjectMember projectMember)

Parameters

Type	Name	Description
NSProjectMember	projectMember	The NSProjectMember to save.

Returns

Type	Description
NSProjectMember

Examples

NSProject  agent;
NSProjectMember thing = agent.CreateDefaultProjectMember();
thing = agent.SaveProjectMember(thing);

SaveProjectMembersFunctionAndComment(Integer[],Integer,String)

Saves role and comment on an array of project members represented by IDs.

Introduced or updated in version: 8.0sr3

Declaration

Void SaveProjectMembersFunctionAndComment(Integer[] projectMemberIds, Integer roleId, String comment)

Parameters

Type	Name	Description
Integer[]	projectMemberIds
Integer	roleId
String	comment

Returns

Type	Description
Void

SetDuplicateRulesStatus(NSDuplicateRule[])

Sets which duplicate rules should be active or not

Introduced or updated in version: 7

Declaration

Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)

Parameters

Type	Name	Description
NSDuplicateRule[]	rules

Returns

Type	Description
Void

SetProjectImage(Integer,NSImage)

Stores the project image that is displayed in the CRM application.

Introduced or updated in version: 7

Declaration

Void SetProjectImage(Integer projectId, NSImage image)

Parameters

Type	Name	Description
Integer	projectId
NSImage	image

Returns

Type	Description
Void

UpdateProjectMember(NSProjectMember)

Updates an NSProjectMember row.

Introduced or updated in version: 7

Declaration

NSProjectMember UpdateProjectMember(NSProjectMember projectMember)

Parameters

Type	Name	Description
NSProjectMember	projectMember

Returns

Type	Description
NSProjectMember

Examples

NSProjectAgent agent;
NSProjectMember projectMember;
NSProjectMember res = agent.UpdateProjectMember(projectMember);

ValidateProjectEntity(NSProjectEntity)

Checks that entity is ready for saving, return error messages by field.

Introduced or updated in version: 7

Declaration

Map ValidateProjectEntity(NSProjectEntity projectEntity)

Parameters

Type	Name	Description
NSProjectEntity	projectEntity

Returns

Type	Description
Map

Examples

NSProjectAgent agent;
NSProjectEntity projectEntity;
Map res = agent.ValidateProjectEntity(NSProjectEntity);