Class NSProjectAgent

NSProjectAgent()

Collection of all services that work with Project data.

Declaration

NSProjectAgent

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

AddProjectMembers(Integer,NSProjectMember[])

Adds multiple project members to a project

Declaration

Void AddProjectMembers(Integer projectEntityId, NSProjectMember[] projectMembers)

Parameters

Returns

CreateDefaultProjectEntity()

Sets default values into a new NSProjectEntity.

Declaration

NSProjectEntity CreateDefaultProjectEntity()

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

Returns

CreateDefaultProjectEventEntity()

Sets default values into a new NSProjectEventEntity.

Declaration

NSProjectEventEntity CreateDefaultProjectEventEntity()

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

Returns

CreateDefaultProjectMember()

Sets default values into a new NSProjectMember.

Declaration

NSProjectMember CreateDefaultProjectMember()

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

Returns

CreateNewEntry()

Creates a new project based on external duplicate

Declaration

Integer CreateNewEntry(NSDuplicateEntry duplicate)

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

Returns

DeleteProjectEntity(Integer)

Deletes the NSProjectEntity

Declaration

DeleteProjectEntity(Integer projectEntity)

NSProjectAgent agent;
agent.DeleteProjectEntity(123);

Parameters

Returns

DeleteProjectEventEntity(Integer)

Deletes the NSProjectEventEntity

Declaration

DeleteProjectEventEntity(Integer projectEventEntity)

NSProjectAgent agent;
agent.DeleteProjectEventEntity(123);

Parameters

Returns

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.

Declaration

Void DeleteProjectEventEntityFromProjectId(Integer projectId)

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

Parameters

Returns

DeleteProjectMember(Integer)

Deletes the NSProjectMember

Declaration

DeleteProjectMember(Integer projectMember)

NSProjectAgent agent;
agent.DeleteProjectMember(123);

Parameters

Returns

DeleteProjectMemberByIds(Integer[])

Deletes project-member rows.

Declaration

Void DeleteProjectMemberByIds(Integer[] projectMemberIds)

Parameters

Returns

DeleteProjectMembers(Integer,Integer[])

Deletes the given project members from a project

Declaration

Void DeleteProjectMembers(Integer projectEntityId, Integer[] memberIds)

Parameters

Returns

GetDuplicateRules()

Retrieve all available duplicate rules for project

Declaration

NSDuplicateRule[] GetDuplicateRules()

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

Returns

GetDuplicates(String)

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

Declaration

NSDuplicateEntry[] GetDuplicates(String name)

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

Parameters

Returns

GetMyMemberProjects()

Returns projects where an user is project member.

Declaration

NSProject[] GetMyMemberProjects()

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

Returns

GetMyProjectEvents()

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

Declaration

NSProjectEvent[] GetMyProjectEvents()

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

Returns

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.

Declaration

NSProject[] GetMyProjects(Bool includeMemberProjects)

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

Parameters

Returns

GetMyPublishedProjects()

Gets published projects from the logged in user.

Declaration

NSProject[] GetMyPublishedProjects()

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

Returns

GetNextMilestone(Integer)

Declaration

NSAppointment GetNextMilestone(Integer projectId)

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

Parameters

Returns

GetNextProjectStatus(Integer)

Declaration

Integer GetNextProjectStatus(Integer projectId)

Parameters

Returns

GetProject(Integer)

Gets an NSProject object.

Declaration

NSProject GetProject(Integer projectId)

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

Parameters

Returns

GetProjectEntity(Integer)

Gets an NSProjectEntity object.

Declaration

NSProjectEntity GetProjectEntity(Integer projectEntityId)

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

Parameters

Returns

GetProjectEvent(Integer)

Gets an NSProjectEvent object.

Declaration

NSProjectEvent GetProjectEvent(Integer projectEventId)

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

Parameters

Returns

GetProjectEventEntity(Integer)

Gets an NSProjectEventEntity object.

Declaration

NSProjectEventEntity GetProjectEventEntity(Integer projectEventEntityId)

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

Parameters

Returns

GetProjectEventEntityFromProjectId(Integer)

Gets an NSProjectEventEntity based on a projectId.

Declaration

NSProjectEventEntity GetProjectEventEntityFromProjectId(Integer projectId)

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

Parameters

Returns

GetProjectEventList(Integer[])

Gets an array of NSProjectEvent objects.

Declaration

NSProjectEvent[] GetProjectEventList(Integer[]  projectEventIds)

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

Parameters

Returns

GetProjectEventOnPerson(Integer,Integer)

Gets an NSProjectEvent object from a project and a person.

Declaration

NSProjectEvent GetProjectEventOnPerson(Integer projectId, Integer personId)

Parameters

Returns

GetProjectEventsOnPerson(Integer)

Gets all project events that belongs to the person specified.

Declaration

NSProjectEvent[] GetProjectEventsOnPerson(Integer personId)

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

Parameters

Returns

GetProjectImage(Integer)

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

Declaration

NSImage GetProjectImage(Integer projectId)

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

Parameters

Returns

GetProjectList(Integer[])

Gets an array of Project objects.

Declaration

NSProject[] GetProjectList(Integer[] projectIds)

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

Parameters

Returns

GetProjectMember(Integer)

Gets an NSProjectMember object.

Declaration

NSProjectMember GetProjectMember(Integer projectMemberId)

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

Parameters

Returns

GetProjectMembers(Integer)

Returns an array of project members

Declaration

NSProjectMember[] GetProjectMembers(Integer projectId)

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

Parameters

Returns

GetProjectMembersById(Integer[])

Returns an array of project members.

Declaration

NSProjectMember[] GetProjectMembersById(Integer[] projectMemberIds)

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

Parameters

Returns

GetProjectsFromContact(Integer)

Returns all projects where the given contact has project members.

Declaration

NSProject[] GetProjectsFromContact(Integer contactId)

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

Parameters

Returns

GetProjectsFromPerson(Integer)

Returns all projects where the person is project member.

Declaration

NSProject[] GetProjectsFromPerson(Integer personId)

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

Parameters

Returns

GetPublishedProject(Integer)

Gets published project by project ID.

Declaration

NSProject GetPublishedProject(Integer projectId)

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

Parameters

Returns

GetPublishedProjects(Integer[])

Gets published projects by project IDs.

Declaration

NSProject[] GetPublishedProjects(Integer[] projectIds)

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

Parameters

Returns

GetPublishedProjectsOnPersonId(Integer)

Gets published projects where person is a member

Declaration

NSProject[] GetPublishedProjectsOnPersonId(Integer personId)

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

Parameters

Returns

HasGuide(Integer)

Declaration

Bool HasGuide(Integer projectId)

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

Parameters

Returns

HasGuideActivities(Integer)

Declaration

Bool HasGuideActivities(Integer projectId)

Parameters

Returns

IsNumberValid(Integer,String)

Checks if the number is unique or required.

Declaration

Bool IsNumberValid(Integer contactId, String number)

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

Parameters

Returns

Merge(Integer,Integer,Bool)

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

Declaration

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

Parameters

Returns

OfferAutoNextStatusOnApppointmentCompleted(Integer)

Declaration

Bool OfferAutoNextStatusOnApppointmentCompleted(Integer appointmentId)

Parameters

Returns

SaveProjectEntity(NSProjectEntity)

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

Declaration

NSProjectEntity SaveProjectEntity(NSProjectEntity projectEntity)

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

Parameters

Returns

SaveProjectEventEntity(NSProjectEventEntity)

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

Declaration

NSProjectEventEntity SaveProjectEventEntity(NSProjectEventEntity entity)

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

Parameters

Returns

SaveProjectMember(NSProjectMember)

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

Declaration

NSProjectMember SaveProjectMember(NSProjectMember projectMember)

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

Parameters

Returns

SaveProjectMembersFunctionAndComment(Integer[],Integer,String)

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

Declaration

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

Parameters

Returns

SetDuplicateRulesStatus(NSDuplicateRule[])

Sets which duplicate rules should be active or not

Declaration

Void SetDuplicateRulesStatus(NSDuplicateRule[] rules)

Parameters

Returns

SetProjectImage(Integer,NSImage)

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

Declaration

Void SetProjectImage(Integer projectId, NSImage image)

Parameters

Returns

UpdateProjectMember(NSProjectMember)

Updates an NSProjectMember row.

Declaration

NSProjectMember UpdateProjectMember(NSProjectMember projectMember)

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

Parameters

Returns

ValidateProjectEntity(NSProjectEntity)

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

Declaration

Map ValidateProjectEntity(NSProjectEntity projectEntity)

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

Parameters

Returns