VWStepPaletteDefinition (Process API Documentation)

java.lang.Object
- filenet.vw.api.VWStepPaletteDefinition

All Implemented Interfaces:

java.io.Serializable
```
public final class VWStepPaletteDefinition
extends java.lang.Object
implements java.io.Serializable
```
This class encapsulates a step palette

Since:

P8 3.0

See Also:

VWMapNode, VWException, Serialized Form

Constructor Summary

Constructors
Constructor and Description

VWStepPaletteDefinition()
Public constructor for the VWStepPaletteDefinition class.

Constructors
Constructor and Description
`VWStepPaletteDefinition()` Public constructor for the VWStepPaletteDefinition class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.String`	`AsXMLString()` Retrieves an XML formatted representation of this step palette.
`VWCompoundStepDefinition`	`createCompoundStep(java.lang.String theStepName)` Creates a compound step on the step palette.
`VWStepDefinition`	`createStep(java.lang.String theStepName)` Creates a step on the step palette.
`void`	`deleteStep(int theStepId)` Deletes the specified step from this step palette.
`void`	`deleteStep(java.lang.String theStepName)` Deprecated. Replaced by `VWStepPaletteDefinition.deleteStep(int)`
`java.lang.String`	`getDescription()` Gets the value in the description property of this step palette.
`java.lang.String`	`getName()` Gets the value of the name property for this step palette object.
`VWMapNode`	`getStep(int theStepId)` Returns the step with the specified id, if found.
`VWMapNode`	`getStep(java.lang.String theStepName)` Deprecated. Replaced by `VWStepPaletteDefinition.getStep(int)`
`VWMapNode[]`	`getSteps()` Gets the set of steps associated with this step palette.
`VWMapNode[]`	`pasteSteps(java.lang.String xmlStepdefs)` Pastes steps into the step palette definition.
`static VWStepPaletteDefinition`	`read(java.io.InputStream theStream)` Creates the new VWStepPaletteDefinition using values it reads from the input stream.
`static VWStepPaletteDefinition`	`readFromFile(java.lang.String theFileName)` Creates the new VWStepPaletteDefinition using values read from the named file.
`void`	`setDescription(java.lang.String theDescription)` Changes the value of the description property of this step palette.
`void`	`setName(java.lang.String theName)` Changes the value of the name property for this step palette.
`java.lang.String`	`toString()` Gets the String version of this object.
`void`	`toXML(java.lang.StringBuffer theBuffer)` Deprecated. Use `VWStepPaletteDefinition.write(OutputStream)` or `VWStepPaletteDefinition.writeToFile(String)`.
`void`	`write(java.io.OutputStream theStream)` Writes this VWStepPaletteDefinition object to an output stream.
`void`	`writeToFile(java.lang.String theFileName)` Writes this VWStepPaletteDefinition object to a file.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - VWStepPaletteDefinition
```
public VWStepPaletteDefinition()
                        throws VWException
```
    Public constructor for the VWStepPaletteDefinition class.
    
    Throws:
    
    VWException
- Method Detail
  - getName
```
public java.lang.String getName()
```
    Gets the value of the name property for this step palette object.
    
    Returns:
    
    The name of this step palette.
  - setName
```
public void setName(java.lang.String theName)
```
    Changes the value of the name property for this step palette.
    
    Parameters:
    
    theName - The name of this step palette.
  - getDescription
```
public java.lang.String getDescription()
```
    Gets the value in the description property of this step palette.
    
    Returns:
    
    The contents of the description property for this step palette.
  - setDescription
```
public void setDescription(java.lang.String theDescription)
```
    Changes the value of the description property of this step palette.
    
    Parameters:
    
    theDescription - The new description for this step palette.
  - createStep
```
public VWStepDefinition createStep(java.lang.String theStepName)
                            throws VWException
```
    Creates a step on the step palette.
    
    Parameters:
    
    theStepName - The name of the step to create.
    
    Returns:
    
    A VWStepDefinition object.
    
    Throws:
    
    VWException - The method throws an exception if the string specified as the input theStepName parameter is invalid.
    
    See Also:
    
    VWStepDefinition
  - createCompoundStep
```
public VWCompoundStepDefinition createCompoundStep(java.lang.String theStepName)
                                            throws VWException
```
    Creates a compound step on the step palette.
    
    Parameters:
    
    theStepName - The name of the step to create.
    
    Returns:
    
    A VWCompoundStepDefinition object.
    
    Throws:
    
    VWException - Thrown if the string specified as the input theStepName parameter is invalid.
    
    See Also:
    
    VWCompoundStepDefinition
  - pasteSteps
```
public VWMapNode[] pasteSteps(java.lang.String xmlStepdefs)
                       throws VWException
```
    Pastes steps into the step palette definition. The step definitions are contained in an XML-formatted string.
    
    Parameters:
    
    xmlStepdefs - An XML-formatted string containing the step definitions to be pasted into the step palette.
    
    Returns:
    
    an array containing the new steps
    
    Throws:
    
    VWException - hrown if it cannot paste the XML-formatted step definition into the step palette.
    
    See Also:
    
    VWMapNode
  - deleteStep
```
public void deleteStep(java.lang.String theStepName)
                throws VWException
```
    Deprecated. Replaced by VWStepPaletteDefinition.deleteStep(int)
    
    Deletes the specified step from this step palette.
    
    Parameters:
    
    theStepName - The name of the step to be deleted.
    
    Throws:
    
    VWException - Thrown if the step is not found.
    
    See Also:
    
    VWMapNode
  - deleteStep
```
public void deleteStep(int theStepId)
                throws VWException
```
    Deletes the specified step from this step palette.
    
    Parameters:
    
    theStepId - The id of the step to be deleted.
    
    Throws:
    
    VWException - Thrown if the step is not found.
    
    See Also:
    
    VWMapNode
  - getStep
```
public VWMapNode getStep(java.lang.String theStepName)
                  throws VWException
```
    Deprecated. Replaced by VWStepPaletteDefinition.getStep(int)
    
    Returns the named step, if found.
    
    Parameters:
    
    theStepName - the step name.
    
    Returns:
    
    VWMapNode A VWMapNode object for the step specified in the input theStepName parameter.
    
    Throws:
    
    VWException - The method throws an exception if step matching the step name does not exist.
    
    See Also:
    
    VWMapNode
  - getStep
```
public VWMapNode getStep(int theStepId)
                  throws VWException
```
    Returns the step with the specified id, if found.
    
    Parameters:
    
    theStepId - the step id.
    
    Returns:
    
    VWMapNode A VWMapNode object for the step specified in the input theStepId parameter.
    
    Throws:
    
    VWException - The method throws an exception if step matching the step id does not exist.
    
    See Also:
    
    VWMapNode
  - getSteps
```
public VWMapNode[] getSteps()
                     throws VWException
```
    Gets the set of steps associated with this step palette.
    
    Returns:
    
    An array of VWMapNode objects that represent all of the steps associated with this step palette.
    
    Throws:
    
    VWException - Thrown if an error occurs retrieving the steps for this step palette.
    
    See Also:
    
    VWMapNode
  - read
```
public static VWStepPaletteDefinition read(java.io.InputStream theStream)
                                    throws VWException
```
    Creates the new VWStepPaletteDefinition using values it reads from the input stream.
    
    Parameters:
    
    theStream - An input stream from which to read the VWStepPaletteDefinition object definition.
    
    Returns:
    
    A VWStepPaletteDefinition object representing an instance of the data read from the stream specified in the theStream parameter.
    
    Throws:
    
    VWException - Thrown if it cannot create a step palette from an input stream.
    
    See Also:
    
    VWStepPaletteDefinition.write(java.io.OutputStream)
  - readFromFile
```
public static VWStepPaletteDefinition readFromFile(java.lang.String theFileName)
                                            throws VWException
```
    Creates the new VWStepPaletteDefinition using values read from the named file.
    
    Parameters:
    
    theFileName - The name of the file from which to read the VWStepPaletteDefinition object definition.
    
    Returns:
    
    A VWStepPaletteDefinition object representing an instance of the data read from the file specified in the theFileName parameter.
    
    Throws:
    
    VWException
    
    See Also:
    
    VWStepPaletteDefinition.writeToFile(java.lang.String), VWStepPaletteDefinition.read(java.io.InputStream)
  - write
```
public void write(java.io.OutputStream theStream)
           throws VWException
```
    Writes this VWStepPaletteDefinition object to an output stream.
    
    Parameters:
    
    theStream - An object output stream to which to write this step palette.
    
    Throws:
    
    VWException - Thrown if it cannot write this VWStepPaletteDefinition object to an output stream.
    
    See Also:
    
    VWStepPaletteDefinition.read(java.io.InputStream)
  - writeToFile
```
public void writeToFile(java.lang.String theFileName)
                 throws VWException
```
    Writes this VWStepPaletteDefinition object to a file.
    
    Parameters:
    
    theFileName - Name of the file to which to write this step palette.
    
    Throws:
    
    VWException - Thrown if it cannot write this VWStepPaletteDefinition object to a file.
    
    See Also:
    
    VWStepPaletteDefinition.readFromFile(java.lang.String), VWStepPaletteDefinition.write(java.io.OutputStream)
  - toString
```
public java.lang.String toString()
```
    Gets the String version of this object.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    The name for the step palette.
  - AsXMLString
```
public java.lang.String AsXMLString()
                             throws VWException
```
    Retrieves an XML formatted representation of this step palette.
    
    Returns:
    
    A String containing a well-formed XML representation of this step palette.
    
    Throws:
    
    VWException - Thrown if it cannot retrieve an XML formatted representation of this step palette.
    
    See Also:
    
    VWStepPaletteDefinition.toXML(java.lang.StringBuffer)
  - toXML
```
public void toXML(java.lang.StringBuffer theBuffer)
           throws VWException
```
    Deprecated. Use VWStepPaletteDefinition.write(OutputStream) or VWStepPaletteDefinition.writeToFile(String).
    
    Appends an XML String that represents this VWStepPaletteDefinition object to the buffer specified by the input parameter.
    Warning: This XML String is non-extensible, and cannot be modified in any way.
    
    Parameters:
    
    theBuffer - A String buffer that this method will append with XML content.
    
    Throws:
    
    VWException

Methods inherited from class java.lang.Object

VWStepPaletteDefinition

getName

setName

getDescription

setDescription

createStep

createCompoundStep

pasteSteps

deleteStep

deleteStep

getStep

getStep

getSteps

read

readFromFile

write

writeToFile

toString

AsXMLString

toXML