wt.projmgmt.msproject
Class StandardMsProjectService

java.lang.Object
  wt.services.StandardManager
      wt.projmgmt.msproject.StandardMsProjectService

All Implemented Interfaces:

Manager, MsProjectService, NetFactor, Serializable

public class StandardMsProjectService

extends StandardManager

implements MsProjectService, Serializable

This is the default implementation of the MsProjectService interface.

Use the newStandardMsProjectService static factory method(s), not the StandardMsProjectService constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.

Supported API: false

Extendable: false

See Also:

Serialized Form

Field Summary

private static String	CLASSNAME
private static String	RESOURCE

Fields inherited from class wt.services.StandardManager

Fields inherited from interface wt.services.Manager

MANAGER_SERVICE, STARTUP_AUTOMATIC, STARTUP_MANUAL, STATUS_EMERGENCY_SHUTDOWN, STATUS_EMERGENCY_SHUTTING_DOWN, STATUS_SHUTDOWN, STATUS_SHUTDOWN_ERRORS, STATUS_SHUTDOWN_FAILURE, STATUS_SHUTTING_DOWN, STATUS_STARTED, STATUS_STARTED_ERRORS, STATUS_STARTING_UP, STATUS_STARTUP_FAILURE

Constructor Summary

StandardMsProjectService()

Method Summary

void	exportProjectPlan(WfContainer c, OutputStream ostream, ExportInfo info) Export the specified ProjectPlan of SummaryActivity as XML that conforms to the Microsoft Project XML Schema.
String	getConceptualClassname() Deprecated.
private boolean	hasImportPermission(WfContainer c) Return true if the current user has permission to import a project plan into the specified container.
WfContainer	importProjectPlan(WfContainer c, InputSource source, ImportInfo info) Update the specified ProjectPlan or SummaryActivity using the XML specification supplied by the provided InputSource.
private WfContainer	lock(WfContainer parent) Lock the specified WfContainer and all of its children.
static StandardMsProjectService	newStandardMsProjectService() Default factory for the class.
void	requestImportProjectPlan(WfContainer c, OutputStream ostream, ImportInfo info) Generate a request for the client to import the specified file into the specified ProjectPlan or SummaryActivity.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, performStartupProcess, registerEvents, setManagerService, shutdown, shutdownFailure, shutdownSuccess, shuttingDown, started, startedErrors, startingUp, startup, startupFailure, toString

Methods inherited from class java.lang.Object

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

Field Detail

RESOURCE

private static final String RESOURCE

See Also:

Constant Field Values

CLASSNAME

private static final String CLASSNAME

Constructor Detail

StandardMsProjectService

public StandardMsProjectService()

Method Detail

getConceptualClassname

public String getConceptualClassname()

Deprecated.

Returns the conceptual (modeled) name for the class.

Supported API: false

Specified by:

getConceptualClassname in interface NetFactor

Overrides:

getConceptualClassname in class StandardManager

Returns:

String

newStandardMsProjectService

public static StandardMsProjectService newStandardMsProjectService()
                                                            throws WTException

Default factory for the class.

Supported API: false

Returns:

StandardMsProjectService

Throws:

WTException

importProjectPlan

public WfContainer importProjectPlan(WfContainer c,
                                     InputSource source,
                                     ImportInfo info)
                              throws WTException,
                                     WTPropertyVetoException

Update the specified ProjectPlan or SummaryActivity using the XML specification supplied by the provided InputSource. The XML must conform to the Microsoft Project XML Schema.

Supported API: false

Specified by:

importProjectPlan in interface MsProjectService

Parameters:

c - the target object of the import

source -

info - the info that controls the import process

Returns:

WfContainer

Throws:

WTException

WTPropertyVetoException

exportProjectPlan

public void exportProjectPlan(WfContainer c,
                              OutputStream ostream,
                              ExportInfo info)
                       throws WTException,
                              IOException

Export the specified ProjectPlan of SummaryActivity as XML that conforms to the Microsoft Project XML Schema. The XML is written to the specified OutputStream.

If info.isEdit() returns true, then additional information is included in the XML file that identifies the Windchill objects that the data corresponds to.

Supported API: false

Specified by:

exportProjectPlan in interface MsProjectService

Parameters:

c - the object to export

ostream - the stream to export the XML on

info - the info that controls the export process

Throws:

WTException

IOException

requestImportProjectPlan

public void requestImportProjectPlan(WfContainer c,
                                     OutputStream ostream,
                                     ImportInfo info)
                              throws WTException,
                                     IOException

Generate a request for the client to import the specified file into the specified 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 XML is written to specified OutputStream.

Supported API: false

Specified by:

requestImportProjectPlan in interface MsProjectService

Parameters:

c - the ProjectPlan or SummaryActivity to request an import for

ostream - the stream to export the request on

info - the import info for the request

Throws:

WTException

IOException

hasImportPermission

private final boolean hasImportPermission(WfContainer c)
                                   throws WTException

Return true if the current user has permission to import a project plan into the specified container.

Throws:

WTException

lock

private final WfContainer lock(WfContainer parent)
                        throws WTException

Lock the specified WfContainer and all of its children. Return the locked container.

Throws:

WTException