Editing Collaboration Project Properties Using IDK Remote APIs

To query or modify Collaboration project metadata from a remote application, use the IProject interface in the IDK.

Each Collaboration project has its own set of objects and properties that are not shared with other projects. The IProject interface provides access to the following project properties:

Property Name	Description	API Access
ID	The object ID for the current project.	Read Only
Name	The name of the current project.	Read/Write
Description	The description for the current project.	Read/Write
Details	The URL to the details page for the current project.	Read Only
Created Date	The date the current project was created (this information might not be available).	Read Only
Last-Modified Date	The date the current project was last updated (this information might not be available).	Read Only
Owner ID	The user ID of the project owner.	Read Only
Access Level	The permissions for the current user (edit, delete, edit security).	Read Only
Start Date	The start date for the current project.	Read/Write
Status	The status of the current project (not started, 25% complete, 50% complete, 75% complete, or completed).	Read/Write

The IProject interface also allows you to modify user access levels. For details, see Managing Collaboration Project Roles Using the IDK Remote API.

To edit settings for an existing project, follow the steps below.

Create a session with the portal. For details, see Initiating a PRC Session to Use IDK Remote APIs.
Retrieve the project ID. For details, see Initiating a PRC Session to Use IDK Remote APIs Querying Existing Collaboration Projects Using IDK Remote APIs.
Edit the properties as shown in the code below.
1. Retrieve an IProjectManager.
2. Change the settings. The simplified sample code below changes the name, description, start date, and current status.
3. Store the settings.

Java

...

//get the project
IProjectManager projectManager = getProjectManager(request, response, out);
IProject project = projectManager.getProject(projectID);

//set the name, description, start date and status
project.setName() = "Updated Name";
project.setDescription() = "Updated description";
project.setStatus(ProjectStatus.TWENTY_FIVE_PERCENT_COMPLETED);

//you must call store to persist changes.
project.store();

...

.NET (C#)

...

//get the project
Plumtree.Remote.PRC.Collaboration.Project.IProjectManager projectManager = GetProjectManager(Request,Response);
IProject project = GetProject(projectID);

//set project metadata
project.Name = "Updated Name";
project.Description = "Updated Description";
project.Status = ProjectStatus.TwentyFivePercentCompleted;

//you must call store to persist changes
project.Store();

...

.NET (VB)

...

'get the project
dim projectManager as Plumtree.Remote.PRC.Collaboration.Project.IProjectManager =
GetProjectManager(Request, Response)
dim project as Plumtree.Remote.PRC.Collaboration.Project.IProject = projectManager.GetProject(-1)

'set project properties
project.Name = "Updated Name"
project.Description = "Updated Description
project.Status = ProjectStatus.TwentyFivePercentCompleted

'you must call store to persist changes
project.Store()

...

Parent topic: About Remote Collaboration Project Operations

AquaLogic User Interaction Development Guide

Editing Collaboration Project Properties Using IDK Remote APIs