Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject Class Reference

Wraps an enterprise project. More...

List of all members.

Public Member Functions
void	LoadProjectCustomFields ()
	Load the project custom fields from Project Server.
void	SetFilter (string filter)
	Set the filter which directs which fields to read from Project Server.
bool	CreateTask (string taskName, DateTime startDate, int duration, bool checkOutProject, bool autoCheckIn, Guid sessionGuid, out Guid taskGuid, out string errorMessage)
	Create a task with a Must Start On constraint.
bool	CreateAssignment (Guid assignmentGuid, Guid taskGuid, Guid resourceGuid, bool autoAddResourceToTeam, bool checkOutProject, bool autoCheckIn, Guid sessionGuid, out string errorMessage)
	Create an assignment.
void	SetTaskCustomFieldValue (Guid sessionGuid, Guid taskGuid, Guid customFieldGuid, Guid lookupTableValueGuid)
	Set a task custom field value to a valid lookup table item GUID.
bool	SetTaskComplete (Guid taskGuid, int durationInSeconds, Guid sessionGuid, bool wait, out string errorMessage)
	Set a task complete.
bool	UpdateTaskWorkToActualWorkWithDuration (Guid taskGuid, double duration, Guid sessionGuid, bool wait, out string errorMessage)
	Update task work actual duration.
Protected Member Functions
internal	EnterpriseProject (ProjectCollection parent, Guid projectGuid, string name, DataStoreEnum store)
	Protected constructor.
Properties
string	Name [get, set]
	Retrieve and privately set the project name.
Guid	ProjectGuid [get, set]
	Retrieve and privately set the project GUID.
ProjectDataSet.ProjectCustomFieldsDataTable	CustomFieldsDataSet [get, set]
	Retrieve the custom field dataset.
ProjectTeamDataSet	ProjectTeamDataSet [get, set]
	Retrieve and privately set the ProjectTeamData.
DataStoreEnum	DataStore [get, set]
	Retrieve and privately set the data store.
ProjectCustomFieldsCollection	ProjectCustomFieldsCollection [get]
	Retrieve the project custom fields collection.
ProjectDataSet.ProjectRow	StatusInformation [get]
	Read status information for the project.
ProjectDataSet	AllInformation [get]
ProjectDataSet	StandardInformation [get]
internal ProjectCollection	Parent [get, set]
	Retrieve and privately set the Project Collection.

---

Detailed Description

Wraps an enterprise project.

Definition at line 26 of file EnterpriseProject.cs.

---

Constructor & Destructor Documentation

internal Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.EnterpriseProject	(	ProjectCollection	parent,
		Guid	projectGuid,
		string	name,
		DataStoreEnum	store
	)			[protected]

Protected constructor.

Parameters:

	parent	ProjectCollection parent
	projectGuid	GUID of the project
	name	Name of the project
	store	Store from which the project was read

Definition at line 46 of file EnterpriseProject.cs.

---

Member Function Documentation

bool Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.CreateAssignment	(	Guid	assignmentGuid,
		Guid	taskGuid,
		Guid	resourceGuid,
		bool	autoAddResourceToTeam,
		bool	checkOutProject,
		bool	autoCheckIn,
		Guid	sessionGuid,
		out string	errorMessage
	)

Create an assignment.

Parameters:

	assignmentGuid	The assignment GUID
	taskGuid	The task GUID
	resourceGuid	The resource GUID
	autoAddResourceToTeam	True to automatically add the resource to the project team
	checkOutProject	True to check out the project, false to assume checked out already
	autoCheckIn	True to automatically check-in the project
	sessionGuid	The session GUID
	taskGuid	The task GUID
	errorMessage	On out, the error message returned by the queue

Returns:

True or false

Definition at line 289 of file EnterpriseProject.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.CreateTask	(	string	taskName,
		DateTime	startDate,
		int	duration,
		bool	checkOutProject,
		bool	autoCheckIn,
		Guid	sessionGuid,
		out Guid	taskGuid,
		out string	errorMessage
	)

Create a task with a Must Start On constraint.

Parameters:

	taskName	The name of the task
	startDate	The start date
	duration	The duration
	checkOutProject	True to check out the project, false to assume checked out already
	autoCheckIn	True to automatically check-in the project
	sessionGuid	The session GUID
	taskGuid	The task GUID
	errorMessage	On out, the error message returned by the queue

Returns:

True or false

Definition at line 207 of file EnterpriseProject.cs.

void Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.LoadProjectCustomFields

(

)

Load the project custom fields from Project Server.

Definition at line 175 of file EnterpriseProject.cs.

void Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.SetFilter

(

string

filter

)

Set the filter which directs which fields to read from Project Server.

Parameters:

filter

The XML filter string

Definition at line 187 of file EnterpriseProject.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.SetTaskComplete	(	Guid	taskGuid,
		int	durationInSeconds,
		Guid	sessionGuid,
		bool	wait,
		out string	errorMessage
	)

Set a task complete.

Parameters:

	taskGuid	The task GUID
	durationInSeconds	Duration in seconds
	sessionGuid	The session GUID
	wait	True to wait for the operation to complete
	errorMessage	If wait = true, the error message returned by the queue if the operation fails

Returns:

True or false

Definition at line 416 of file EnterpriseProject.cs.

void Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.SetTaskCustomFieldValue	(	Guid	sessionGuid,
		Guid	taskGuid,
		Guid	customFieldGuid,
		Guid	lookupTableValueGuid
	)

Set a task custom field value to a valid lookup table item GUID.

Parameters:

	sessionGuid	The session GUID
	taskGuid	The task GUID
	customFieldGuid	The custom field GUID
	lookupTableValueGuid	The GUID of the lookup table item

Definition at line 385 of file EnterpriseProject.cs.

bool Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.UpdateTaskWorkToActualWorkWithDuration	(	Guid	taskGuid,
		double	duration,
		Guid	sessionGuid,
		bool	wait,
		out string	errorMessage
	)

Update task work actual duration.

Parameters:

	taskGuid	The task GUID
	duration	The duration in seconds
	sessionGuid	The session GUID
	wait	True to wait for the operation to complete
	errorMessage	If wait = true, the error message returned by the queue if the operation fails

Returns:

True or false

Definition at line 455 of file EnterpriseProject.cs.

---

Property Documentation

ProjectDataSet.ProjectCustomFieldsDataTable Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.CustomFieldsDataSet [get, set]

Retrieve the custom field dataset.

Definition at line 75 of file EnterpriseProject.cs.

DataStoreEnum Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.DataStore [get, set]

Retrieve and privately set the data store.

Definition at line 103 of file EnterpriseProject.cs.

string Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.Name [get, set]

Retrieve and privately set the project name.

Definition at line 64 of file EnterpriseProject.cs.

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

Retrieve and privately set the Project Collection.

Definition at line 166 of file EnterpriseProject.cs.

ProjectCustomFieldsCollection Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.ProjectCustomFieldsCollection [get]

Retrieve the project custom fields collection.

Definition at line 109 of file EnterpriseProject.cs.

Guid Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.ProjectGuid [get, set]

Retrieve and privately set the project GUID.

Definition at line 69 of file EnterpriseProject.cs.

ProjectTeamDataSet Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.ProjectTeamDataSet [get, set]

Retrieve and privately set the ProjectTeamData.

Definition at line 98 of file EnterpriseProject.cs.

ProjectDataSet.ProjectRow Mcs.Epm.MicrosoftProject.mpFx.EnterpriseProject.StatusInformation [get]

Read status information for the project.

Definition at line 125 of file EnterpriseProject.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/EnterpriseProject.cs