wt.epm
Class ReviseOptions

java.lang.Object
  wt.epm.ReviseOptions

All Implemented Interfaces:

Externalizable, Serializable

public class ReviseOptions

extends Object

implements Externalizable

Holds a set of properties to assign to newly created versions. An instance of this class are passed as an argument to the revise methods defined on the EPMDocumentManager. The original object to be revised may be a part of the options.

Supported API: true

Extendable: false

See Also:

Serialized Form

Nested Class Summary

static class

ReviseOptions.ObjectOptions Holds a set of properties to assign to newly created versions.

Field Summary

ReviseOptions.ObjectOptions	document Holds the folder and life cycle template to assign newly created versions of EPMDocuments.
static long	EXTERNALIZATION_VERSION_UID
Workable	objectToRevise Holds the object to revise -- EPMDocument or WTPart B>Supported API: true
ReviseOptions.ObjectOptions	part Holds the folder and life cycle template to assign newly created versions of WTParts.
boolean	reviseParts If set to false, only document is revised.
(package private) static long	serialVersionUID
TeamTemplate	teamTemplate The team template to assign the newly created versions to.

Constructor Summary

ReviseOptions()
Default constructor for this class.

ReviseOptions(EPMWorkspace workspace)
Constructs an instance of the ReviseOptions class.

ReviseOptions(Workable toRevise)
Constructor given the object to revise.

Method Summary

void	readExternal(ObjectInput input) Reads the non-transient fields of this class from an external source.
void	writeExternal(ObjectOutput output) Writes the non-transient fields of this class to an external source.

Methods inherited from class java.lang.Object

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

Field Detail

objectToRevise

public Workable objectToRevise

Holds the object to revise -- EPMDocument or WTPart

B>Supported API: true

reviseParts

public boolean reviseParts

If set to false, only document is revised. Built part is not If set to true, both document and built part are revised By default, it is set to true by constructor Set to false by constructor given objectToRevise Ignored in reviseAll(Collection reviseOptions)

teamTemplate

public TeamTemplate teamTemplate

The team template to assign the newly created versions to. If null, the newly created version will belong to the same team template as the original version.

Supported API: true

document

public ReviseOptions.ObjectOptions document

Holds the folder and life cycle template to assign newly created versions of EPMDocuments.

Supported API: true

part

public ReviseOptions.ObjectOptions part

Holds the folder and life cycle template to assign newly created versions of WTParts.

Supported API: true

serialVersionUID

static final long serialVersionUID

See Also:

Constant Field Values

EXTERNALIZATION_VERSION_UID

public static final long EXTERNALIZATION_VERSION_UID

See Also:

Constant Field Values

Constructor Detail

ReviseOptions

public ReviseOptions(EPMWorkspace workspace)

Constructs an instance of the ReviseOptions class. Initializes it with the default team template, folders and life cycle templates associated with the given workspace.

Supported API: true

Parameters:

workspace -

ReviseOptions

public ReviseOptions()

Default constructor for this class.

Supported API: true

ReviseOptions

public ReviseOptions(Workable toRevise)

Constructor given the object to revise.

Supported API: true

Method Detail

writeExternal

public void writeExternal(ObjectOutput output)
                   throws IOException

Writes the non-transient fields of this class to an external source.

Supported API: false

Specified by:

writeExternal in interface Externalizable

Parameters:

output -

Throws:

IOException

readExternal

public void readExternal(ObjectInput input)
                  throws IOException,
                         ClassNotFoundException

Reads the non-transient fields of this class from an external source.

Supported API: false

Specified by:

readExternal in interface Externalizable

Parameters:

input -

Throws:

IOException

ClassNotFoundException