flexagon.fd.core.plugin

Class PluginObjectResults

java.lang.Object

flexagon.fd.core.plugin.PluginObjectResults

public class PluginObjectResults
extends java.lang.Object

A model to assist in creating partial deploy plugins and updating the status of files as you go. It will set all the files to NOT_ATTEMPTED at the start, and then allow you pass in a project or package object and a status to edit it later.

Constructor Summary

Constructors

Constructor and Description
PluginObjectResults(WorkflowExecutionContext context) Creates a new PluginObjectResults with a current timestamp for start time and with all the objects in it set to NOT_ATTEMPTED.
PluginObjectResults(WorkflowExecutionContext context, DeployStatusEnum pInitialStatus) Creates a new PluginObjectResults with a current timestamp for start time and with all the objects in it set to the value of pInitialStatus.

Method Summary

Modifier and Type	Method and Description
void	addPackageObject(PackageObject pPo, DeployStatusEnum pInitialStatus)
java.util.Map<java.lang.Long,DeployObjectResult>	getDeployResultsMap()
void	setStartTimeForPackageObject(PackageObject pPo) Sets the starttime for a package object.
void	setStartTimeForProjectObject(ProjectObject pPo) Updates the starttime for a project object.
void	updateStatusForPackageObject(PackageObject pPo, DeployStatusEnum pStatus) Updates the status, and sets the endtime.
void	updateStatusForProjectObject(ProjectObject pPo, DeployStatusEnum pStatus) Updates the status, and sets the endtime.
void	writeXml() Please call this from a finally block wrapping your execute method's contents.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginObjectResults

public PluginObjectResults(WorkflowExecutionContext context)

Creates a new PluginObjectResults with a current timestamp for start time and with all the objects in it set to NOT_ATTEMPTED. It contains a map that allows you to rereference the deployresults and edit the status of the objects as needed.

Parameters:

context -

PluginObjectResults

public PluginObjectResults(WorkflowExecutionContext context,
                           DeployStatusEnum pInitialStatus)

Creates a new PluginObjectResults with a current timestamp for start time and with all the objects in it set to the value of pInitialStatus. It contains a map that allows you to rereference the deployresults and edit the status of the objects as needed.

Parameters:

context -

pInitialStatus -

Method Detail

getDeployResultsMap

public java.util.Map<java.lang.Long,DeployObjectResult> getDeployResultsMap()

addPackageObject

public void addPackageObject(PackageObject pPo,
                             DeployStatusEnum pInitialStatus)

updateStatusForPackageObject

public void updateStatusForPackageObject(PackageObject pPo,
                                         DeployStatusEnum pStatus)
                                  throws FlexCheckedException

Updates the status, and sets the endtime.

Parameters:

pPo -

pStatus -

Throws:

FlexCheckedException

updateStatusForProjectObject

public void updateStatusForProjectObject(ProjectObject pPo,
                                         DeployStatusEnum pStatus)
                                  throws FlexCheckedException

Updates the status, and sets the endtime.

Parameters:

pPo -

pStatus -

Throws:

FlexCheckedException

setStartTimeForPackageObject

public void setStartTimeForPackageObject(PackageObject pPo)
                                  throws FlexCheckedException

Sets the starttime for a package object.

Parameters:

pPo -

Throws:

FlexCheckedException

setStartTimeForProjectObject

public void setStartTimeForProjectObject(ProjectObject pPo)
                                  throws FlexCheckedException

Updates the starttime for a project object.

Parameters:

pPo -

Throws:

FlexCheckedException

writeXml

public void writeXml()
              throws FlexCheckedException

Please call this from a finally block wrapping your execute method's contents. See the FlexPartialDeploy class for for an example.

Throws:

FlexCheckedException