org.mpxj.primavera.webservices

Class WebServicesReader

java.lang.Object

org.mpxj.primavera.webservices.WebServicesReader

public class WebServicesReader
extends Object

Access schedule data via P6 Web Services.

Constructor Summary

Constructors

Constructor and Description
WebServicesReader(String url, String bearerToken) Constructor.
WebServicesReader(String url, String databaseName, String user, String password) Constructor.

Method Summary

Modifier and Type	Method and Description
void	exportProject(WebServicesProject project, OutputStream stream, WebServicesExportType type, boolean includeBaseline, boolean compressed) Export a project.
void	exportProject(WebServicesProject project, String filename, WebServicesExportType type, boolean includeBaseline, boolean compressed) Export a project.
List<WebServicesProject>	getProjects() Retrieve details of the projects available via the P6 Web Services API.
ProjectFile	readProject(WebServicesProject project) Read a project and return a ProjectFile instance.
ProjectFile	readProject(WebServicesProject project, boolean includeBaseline) Read a project and return a ProjectFile instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

WebServicesReader

public WebServicesReader(String url,
                         String databaseName,
                         String user,
                         String password)

Constructor.

Parameters:

url - P6 Web Services URL

databaseName - database name

user - user name

password - password

WebServicesReader

public WebServicesReader(String url,
                         String bearerToken)

Constructor.

Parameters:

url - P6 Web Services URL

bearerToken - OAuth bearer token

Method Detail

getProjects

public List<WebServicesProject> getProjects()

Retrieve details of the projects available via the P6 Web Services API.

Returns:

list of WebServicesProject instances

exportProject

public void exportProject(WebServicesProject project,
                          String filename,
                          WebServicesExportType type,
                          boolean includeBaseline,
                          boolean compressed)
                   throws IOException

Export a project.

Parameters:

project - WebServicesProject instance identifying the project to export

filename - name of file to which the project data is written

type - export type

includeBaseline - true if the baseline should be included in the export

compressed - true if the project data should be exported as a zip file

Throws:

IOException

exportProject

public void exportProject(WebServicesProject project,
                          OutputStream stream,
                          WebServicesExportType type,
                          boolean includeBaseline,
                          boolean compressed)
                   throws IOException

Export a project.

Parameters:

project - WebServicesProject instance identifying the project to export

stream - OutputStream instance to which project data will be written

type - export type

includeBaseline - true if the baseline should be included in the export

compressed - true if the project data should be exported as a zip file

Throws:

IOException

readProject

public ProjectFile readProject(WebServicesProject project)
                        throws MPXJException

Read a project and return a ProjectFile instance.

Parameters:

project - WebServicesProject instance identifying the project to read

Returns:

ProjectFile instance

Throws:

MPXJException

readProject

public ProjectFile readProject(WebServicesProject project,
                               boolean includeBaseline)
                        throws MPXJException

Read a project and return a ProjectFile instance.

Parameters:

project - WebServicesProject instance identifying the project to read

includeBaseline - true if the current baseline should be included

Returns:

ProjectFile instance

Throws:

MPXJException