Package com.ptc.windchill.sync.wpsync

Class StandardWPSyncService

java.lang.Object

wt.services.StandardManager

com.ptc.windchill.sync.wpsync.StandardWPSyncService

All Implemented Interfaces:

WPSyncService, Serializable, wt.fc._NetFactor, NetFactor, wt.services.Manager

public class StandardWPSyncService
extends StandardManager
implements WPSyncService, Serializable

Standard implementation of the workflow engine service. Contains implementation of the client and server APIs.

Use the newStandardWPSyncService static factory method(s), not the StandardWPSyncService 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: true

Extendable: false

See Also:

• WPSyncService
• invalid reference

  WPSyncServiceSvr

• Serialized Form

Field Summary

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

Method Summary

Modifier and Type	Method	Description
boolean	abortExport(ObjectReference objRef)	Supported API: true.
String	getExportStatus(ObjectReference obj)	This API give you a current status of export process Supported API: true.
boolean	performExport(ObjectReference obj)	Supported API: true.
boolean	performExportProcess(ObjectReference objRef)	Supported API: true.
boolean	performExportProcess(ObjectReference refDeliveryRecord, WTContainerRef refContainer)	Initiates an export for the passed in delivery record.

Methods inherited from class wt.services.StandardManager

emergencyShutdown, emergencyShutdownComplete, emergencyShuttingDown, getClassInfo, getManagerService, getManagerStatus, getName, getStartupType, init, initialize, initialize, isStarted, newStandardManager, newStandardManager, performEmergencyShutdownProcess, performShutdownProcess, 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

Method Details

getExportStatus

public String getExportStatus(ObjectReference obj)
                       throws WTException

This API give you a current status of export process

Supported API: true.

Specified by:

getExportStatus in interface WPSyncService

Parameters:

obj - the obj

Returns:

String

Throws:

WTException - the wT exception

performExportProcess

public boolean performExportProcess(ObjectReference objRef)
                             throws WTException

Supported API: true.

Specified by:

performExportProcess in interface WPSyncService

Parameters:

objRef - the obj ref

Returns:

boolean

Throws:

WTException - the wT exception

performExportProcess

public boolean performExportProcess(ObjectReference refDeliveryRecord,
 WTContainerRef refContainer)
                             throws WTException

Initiates an export for the passed in delivery record. The container parameter can be used to specify the context for which the export was performed. This will be used to record an 'Exported From Context' value for the delivery when zipped for auditing purposes. This is optional, and if not specified, the container of the delivery record will be considered the context of the export.

Supported API: true

Specified by:

performExportProcess in interface WPSyncService

Parameters:

refDeliveryRecord - reference to the delivery record being exported

refContainer - reference to container to record as the context for the export; may be null

Returns:

true if export process initiated successfully; false if not

Throws:

WTException

performExport

public boolean performExport(ObjectReference obj)
                      throws WTException

Supported API: true.

Specified by:

performExport in interface WPSyncService

Parameters:

obj - the obj

Returns:

boolean

Throws:

WTException - the wT exception

abortExport

public boolean abortExport(ObjectReference objRef)
                    throws WTException

Supported API: true.

Specified by:

abortExport in interface WPSyncService

Parameters:

objRef - the obj ref

Returns:

boolean

Throws:

WTException - the wT exception