com.ptc.netmarkets.msproject
Interface NmMsProjectService

All Known Implementing Classes:

NmMsProjectServiceFwd, StandardNmMsProjectService

public interface NmMsProjectService

This service provides support for the clients that provide assess to the Microsoft Project Integration features of ProjectLink.

Supported API: false

Extendable: false

Method Summary

void	deleteTempFile(File tempFile) Delete a temporary file that was created by the method server.
File	exportProjectPlan(NmCommandBean cb, Hashtable params, ExportInfo info) Export the project plan as XML that conforms to the Microsoft Project XML Schema.
NmChangeModel[]	importProjectPlan(NmCommandBean cb, Hashtable params, ImportInfo info) Update the project plan using the specified XML file.
File	requestImportProjectPlan(NmCommandBean cb, Hashtable params, ImportInfo info) Generate a request for the client to import a file into a ProjectPlan or SummaryActivity.

Method Detail

importProjectPlan

public NmChangeModel[] importProjectPlan(NmCommandBean cb,
                                         Hashtable params,
                                         ImportInfo info)
                                  throws WTException,
                                         WTPropertyVetoException,
                                         IOException

Update the project plan using the specified XML file. The XML file should conform to the Microsoft Project XML Schema.

Since an import will usually cause substantial changes and occurs infrequently, return a NmChangeModel that invalidates all the caches.

Supported API: false

Parameters:

cb -

params -

info -

Returns:

NmChangeModel[]

Throws:

WTException

WTPropertyVetoException

IOException

exportProjectPlan

public File exportProjectPlan(NmCommandBean cb,
                              Hashtable params,
                              ExportInfo info)
                       throws WTException,
                              IOException

Export the project plan as XML that conforms to the Microsoft Project XML Schema.

If info.isEdit() returns true, then additional information is included in the XML file that identifies the Windchill objects that the data corresponds to. This allows the client to save changes back to the server.

The method returns a pointer to the File into which the XML was written.

Supported API: false

Parameters:

cb -

params -

info -

Returns:

File

Throws:

WTException

IOException

requestImportProjectPlan

public File requestImportProjectPlan(NmCommandBean cb,
                                     Hashtable params,
                                     ImportInfo info)
                              throws WTException,
                                     IOException

Generate a request for the client to import a file into a ProjectPlan or SummaryActivity.

The client should use the information in the generated XML to send an importProjectPlan request to the server.

The generated XML conforms to the Existing Project XML Schema. The method returns a pointer to the File into which the XML was written.

Supported API: false

Parameters:

cb -

params -

info -

Returns:

File

Throws:

WTException

IOException

deleteTempFile

public void deleteTempFile(File tempFile)
                    throws WTException

Delete a temporary file that was created by the method server. If the method server and servlet engine are running as different users this method prevents a potential permission denied error.

Supported API: false

Parameters:

tempFile -

Throws:

WTException