Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection Class Reference

Provides data and functionality for working with enterprise projects. More...

List of all members.

Public Member Functions

bool TryGetProjectGuidByName (string name, ref Guid projectGuid)

ProjectDataSet ReadProject (Guid guid, DataStoreEnum store, bool asynch)

ProjectDataSet ReadProject (Guid projectGuid, DataStoreEnum store, bool asynch, string sessionDescription, out Guid sessionGuid)

Read a project from Project Server.

Guid Create (ProjectDataSet project, bool validateOnly, bool wait)

Create a project in Project Server.

bool Delete (Guid projectGuid, bool deleteWSS, bool deleteBoth, bool wait, out string errorString)

Deletes a specific project from Project Server.

ProjectTeamDataSet ReadTeam (Guid projectGuid, bool asynch)

Read the specified project's team from Project Server.

bool ContainsKey (Guid projectGuid)

Determines whether a specific project GUID exists in the projects collection.

bool CheckIn (Guid projectGuid, Guid sessionGuid, bool force, bool wait, out string errorString)

Checks in the specified project.

bool IsProjectCheckedOutByCurrentUser (Guid projectGuid, DataStoreEnum store)

Determines whether the specified project is checked out to the current user.

void Refresh ()

void CheckOut (Guid projectGuid, Guid sessionGuid, string sessionDescription)

bool Publish (Guid guid, bool fullPublish, string wssUrl, bool wait, out string errorMessage)

IEnumerator< Guid > GetEnumerator ()

Properties

EnterpriseProject this [int index] [get]

Given an integer index, return the project name.

CustomFieldDataSet CustomFieldsDataSet [get]

internal ProjectServer Parent [get, set]

Retrieve the parent object.

Events

EventHandler
< ProjectReadCompleteArgs > OnProjectReadComplete

EventHandler< ProjectTeamReadArgs > OnProjectTeamReadComplete

Detailed Description

Provides data and functionality for working with enterprise projects.

Definition at line 27 of file ProjectCollection.cs.

Member Function Documentation

bool Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.CheckIn	(	Guid	projectGuid,
		Guid	sessionGuid,
		bool	force,
		bool	wait,
		out string	errorString
	)

Checks in the specified project.

Parameters:

	projectGuid	The GUID of the project to checkin
	sessionGuid	The session GUID under which the project was originally checked out
	force	Indicates whether the project checkin should be forced
	wait	Indicates whether the call should wait on the queued job.
	errorString	Out parameter containing error message if queued job fails

/

Returns:: True for succcess, false for failure

Definition at line 369 of file ProjectCollection.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.ContainsKey ( Guid projectGuid )

Determines whether a specific project GUID exists in the projects collection.

Parameters:

projectGuid

The project GUID to search for

Returns:: True if GUID is found, false if not.

Definition at line 350 of file ProjectCollection.cs.

Guid Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.Create	(	ProjectDataSet	project,
		bool	validateOnly,
		bool	wait
	)

Create a project in Project Server.

Parameters:

	project	Project
	validateOnly	Indicates whether the operation should validate only or perform the creation
	wait	Indicates whether the call should wait on the queued job.

Returns:: Queue job GUID

Definition at line 224 of file ProjectCollection.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.Delete	(	Guid	projectGuid,
		bool	deleteWSS,
		bool	deleteBoth,
		bool	wait,
		out string	errorString
	)

Deletes a specific project from Project Server.

Parameters:

	projectGuid	The GUID of the project to delete
	deleteWSS	Indicates whether the associated SharePoint content will be deleted
	deleteBoth	Indicates whether both the drafts and published versions of the project will be deleted
	wait	Indicates whether the call should wait on the queued job.
	errorString	Out parameter containing an error string if the queued job failed

Returns:: True for succcess, false for failure

Definition at line 269 of file ProjectCollection.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.IsProjectCheckedOutByCurrentUser	(	Guid	projectGuid,
		DataStoreEnum	store
	)

Determines whether the specified project is checked out to the current user.

Parameters:

	projectGuid	The GUID of the project to check
	store	The data store to check.

Returns:: True if the project is checked out to the current user, false if not

Definition at line 395 of file ProjectCollection.cs.

ProjectDataSet Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.ReadProject	(	Guid	projectGuid,
		DataStoreEnum	store,
		bool	asynch,
		string	sessionDescription,
		out Guid	sessionGuid
	)

Read a project from Project Server.

Parameters:

	projectGuid	The project's GUID
	store	The data store from which to read the project.
	asynch	True to execute asynchronously, false otherwise
	sessionDescription	The session description.
	sessionGuid	Out parameter containing the session GUID

Returns:: Project Data Set

Definition at line 204 of file ProjectCollection.cs.

ProjectTeamDataSet Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.ReadTeam	(	Guid	projectGuid,
		bool	asynch
	)

Read the specified project's team from Project Server.

Parameters:

	projectGuid	The GUID of the project to read
	asynch	True to read asynchronously, false if not

Returns:: If asynch = true, null; otherwise the resultant ProjectTeamDataSet

Definition at line 298 of file ProjectCollection.cs.

Property Documentation

CustomFieldDataSet Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.CustomFieldsDataSet [get]

Return the raw PSI custom field dataset

Definition at line 115 of file ProjectCollection.cs.

internal ProjectServer Mcs.Epm.MicrosoftProject.mpFx.ProjectCollection.Parent [get, set, protected]

Retrieve the parent object.

Definition at line 462 of file ProjectCollection.cs.

EnterpriseProject Mcs::Epm::MicrosoftProject::mpFx.ProjectCollection::this [get]

Given an integer index, return the project name.

Given a project GUID, return the project name.

Parameters:

index

Index

Returns:: Project Name

Parameters:

projectGuid

Project GUID

Returns:: Project Name

Definition at line 70 of file ProjectCollection.cs.

The documentation for this class was generated from the following file:

C:/Data/Projects/MCS EPM Global Practice/Frameworks/Public/mpfX/1.0/Libraries/Mcs.Epm.MicrosoftProject.mpFx/ProjectCollection.cs


Public Member Functions
bool	TryGetProjectGuidByName (string name, ref Guid projectGuid)
ProjectDataSet	ReadProject (Guid guid, DataStoreEnum store, bool asynch)
ProjectDataSet	ReadProject (Guid projectGuid, DataStoreEnum store, bool asynch, string sessionDescription, out Guid sessionGuid)
	Read a project from Project Server.
Guid	Create (ProjectDataSet project, bool validateOnly, bool wait)
	Create a project in Project Server.
bool	Delete (Guid projectGuid, bool deleteWSS, bool deleteBoth, bool wait, out string errorString)
	Deletes a specific project from Project Server.
ProjectTeamDataSet	ReadTeam (Guid projectGuid, bool asynch)
	Read the specified project's team from Project Server.
bool	ContainsKey (Guid projectGuid)
	Determines whether a specific project GUID exists in the projects collection.
bool	CheckIn (Guid projectGuid, Guid sessionGuid, bool force, bool wait, out string errorString)
	Checks in the specified project.
bool	IsProjectCheckedOutByCurrentUser (Guid projectGuid, DataStoreEnum store)
	Determines whether the specified project is checked out to the current user.
void	Refresh ()
void	CheckOut (Guid projectGuid, Guid sessionGuid, string sessionDescription)
bool	Publish (Guid guid, bool fullPublish, string wssUrl, bool wait, out string errorMessage)
IEnumerator< Guid >	GetEnumerator ()
Properties
EnterpriseProject	this [int index] `[get]`
	Given an integer index, return the project name.
CustomFieldDataSet	CustomFieldsDataSet `[get]`
internal ProjectServer	Parent `[get, set]`
	Retrieve the parent object.
Events
EventHandler < ProjectReadCompleteArgs >	OnProjectReadComplete
EventHandler< ProjectTeamReadArgs >	OnProjectTeamReadComplete