com.netscape.pm.dm
Interface IDeploymentDescriptor

All Superinterfaces:

IChecksum

public interface IDeploymentDescriptor

extends IChecksum

This object provides a way of accessing and mutating run time properties of a particular application. The following code snippet indicates how the deployment descriptor of a particular application can be obtained.

 javax.naming.Context cxt = new javax.naming.InitialContext();
 String jndiName = "java:comp/env/" + IPMClusterManager.JNDI_ROOT;
 IPMClusterManagerHome home = (IPMClusterManagerHome) cxt.lookup( jndiName );
 IPMClusterManager clManager = home.create();
 IPMCluster pmc = clManager.getCluster ( IPMCluster.DEFAULT ) ;
 IDeploymentManager dm = pmc.getDeploymentManager();
 Hashtable apps = dm.getInstalledApplications();
 String appName = "someAppName";
 IDeploymentDescriptor dd = apps.get ( appName ) ;
 // call deployment descriptor methods here..
 

Since:

PAE 4.0

See Also:

com.netscape.pm.model.IDeploymentManager

Fields inherited from interface com.netscape.pm.dm.IChecksum

NOT_COMPUTED

Method Summary

java.lang.String	getName()
boolean	isApplicationStarted() Returns true if the application's status is started, that is the application can be accessed from the Process Express.
boolean	isApplicationStopped() Returns true if the application's status is stopped, that is the application cannot be accessed from the Process Express.
boolean	isModeClosed() Returns true if the application's mode is closed, that is no new process instances can be created from this application but existing process instances can be completed.
boolean	isModeOpen() Returns true if the application's mode is open, that is new process instances can be created from this application.
boolean	isStageDevelopment() Returns true if the application's stage is development
boolean	isStageProduction() Returns true if the application's stage is production.
boolean	isTesting() Returns true if the application's apptesting attribute is true.
void	setApplicationStarted() Changes the
void	setApplicationStopped() Changes the
void	setModeClosed() Changes the
void	setModeOpen() Changes the
void	setStageDevelopment() Sets the
void	setStageProduction() Sets the
void	setTesting(boolean yesNo) Changes the

Methods inherited from interface com.netscape.pm.dm.IChecksum

getChecksum, setChecksum

Method Detail

getName

public java.lang.String getName()

setApplicationStarted

public void setApplicationStarted()

Changes the

status

of the application to

started

. If the application status is started, then work items of the application is accessible from the Process Express.

setApplicationStopped

public void setApplicationStopped()

Changes the

status

of the application to

stopped

. If the application status is stopped, then work items of the application is not accessible from the Process Express. Process instances of the application cannot be created if the application is stopped.

setModeOpen

public void setModeOpen()

Changes the

mode

of the application to

open

. If the application mode is open, then new process instances can be created.

setModeClosed

public void setModeClosed()

Changes the

mode

of the application to

closed

. If the application mode is closed, then new process instances cannot be created - only existing work items can be worked on.

setTesting

public void setTesting(boolean yesNo)

Changes the

apptesting

attribute of the application to

true

or

false

depending on the boolean parameter. If the apptesting attribute is true, then all work items created for that application is automatically assigned to the creator of the process instance. If the apptesting attribute is false, then the work items of the application are assigned to the correct assignees that have been defined in the process definition.

Parameters:

yesNo - If this parameter is true, then the apptesting attribute of the application is set to true, otherwise it is set to false.

setStageDevelopment

public void setStageDevelopment()

Sets the

stage

of the application to

development

. If the application is in development stage, then the application can be completely redesigned using the Process Builder. Once the application stage is set to

production

, then changes from the Process Builder to the application are very restrictive.

setStageProduction

public void setStageProduction()

Sets the

stage

of the application to

production

. If the application is in development stage, then the application can be completely redesigned using the Process Builder. Once the application stage is set to

production

, then changes from the Process Builder to the application are very restrictive.

isModeOpen

public boolean isModeOpen()

Returns true if the application's mode is open, that is new process instances can be created from this application.

Returns:

true if the application mode is open; false if the application mode is closed.

Since:

PAE 4.0

isModeClosed

public boolean isModeClosed()

Returns true if the application's mode is closed, that is no new process instances can be created from this application but existing process instances can be completed.

Returns:

true if the application mode is closed; false if the application mode is open.

Since:

PAE 4.0

isApplicationStarted

public boolean isApplicationStarted()

Returns true if the application's status is started, that is the application can be accessed from the Process Express. If an application has been stopped, no actions can be performed on any work items or process instances that belong to the application.

Returns:

true if the application status is started; false if the application status is stopped.

Since:

PAE 4.0

isApplicationStopped

public boolean isApplicationStopped()

Returns true if the application's status is stopped, that is the application cannot be accessed from the Process Express. If an application has been stopped, no actions can be performed on any work items or process instances that belong to the application.

Returns:

true if the application status is stopped; false if the application status is started.

Since:

PAE 4.0

isStageDevelopment

public boolean isStageDevelopment()

Returns true if the application's stage is development

Returns:

true if the application stage is development; false if the application stage is production.

Since:

PAE 4.0

isStageProduction

public boolean isStageProduction()

Returns true if the application's stage is production.

Returns:

true if the application stage is production; false if the application stage is development.

Since:

PAE 4.0

isTesting

public boolean isTesting()

Returns true if the application's apptesting attribute is true.

Returns:

true if the application apptesting attribute is true; false if the application apptesting attribute is false.

Since:

PAE 4.0