|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectfilenet.vw.api.VWStepPaletteDefinition
public final class VWStepPaletteDefinition
This class encapsulates a step palette
VWMapNode
,
VWException
,
Serialized FormConstructor Summary | |
---|---|
VWStepPaletteDefinition()
Public constructor for the VWStepPaletteDefinition class. |
Method Summary | |
---|---|
static java.lang.String |
_get_FILE_AUTHOR()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_DATE()
For FileNet internal use only, do not call. |
static java.lang.String |
_get_FILE_REVISION()
For FileNet internal use only, do not call. |
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 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 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)
Appends an XML String that represents this VWStepPaletteDefinition object to the buffer specified by the input parameter. |
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 |
---|
public VWStepPaletteDefinition() throws VWException
VWException
Method Detail |
---|
public static java.lang.String _get_FILE_DATE()
public static java.lang.String _get_FILE_AUTHOR()
public static java.lang.String _get_FILE_REVISION()
public java.lang.String getName()
public void setName(java.lang.String theName)
theName
- The name of this step palette.public java.lang.String getDescription()
public void setDescription(java.lang.String theDescription)
theDescription
- The new description for this step palette.public VWStepDefinition createStep(java.lang.String theStepName) throws VWException
theStepName
- The name of the step to create.
VWException
- The method throws an exception if the string specified as the input theStepName parameter is invalid.VWStepDefinition
public VWCompoundStepDefinition createCompoundStep(java.lang.String theStepName) throws VWException
theStepName
- The name of the step to create.
VWException
- Thrown if the string specified as the input
theStepName parameter is invalid.VWCompoundStepDefinition
public VWMapNode[] pasteSteps(java.lang.String xmlStepdefs) throws VWException
xmlStepdefs
- An XML-formatted string containing the
step definitions to be pasted into the step palette.
VWException
- hrown if it cannot paste the
XML-formatted step definition into the step palette.VWMapNode
public void deleteStep(java.lang.String theStepName) throws VWException
deleteStep(int)
theStepName
- The name of the step to be deleted.
VWException
- Thrown if the step is not found.VWMapNode
public void deleteStep(int theStepId) throws VWException
theStepId
- The id of the step to be deleted.
VWException
- Thrown if the step is not found.VWMapNode
public VWMapNode getStep(java.lang.String theStepName) throws VWException
getStep(int)
theStepName
- the step name.
VWException
- The method throws an exception if step matching the step name does not exist.VWMapNode
public VWMapNode getStep(int theStepId) throws VWException
theStepId
- the step id.
VWException
- The method throws an exception if step matching the step id does not exist.VWMapNode
public VWMapNode[] getSteps() throws VWException
VWException
- Thrown if an error occurs retrieving the steps for this step palette.VWMapNode
public static VWStepPaletteDefinition read(java.io.InputStream theStream) throws VWException
theStream
- An input stream from which to read the VWStepPaletteDefinition object definition.
VWException
- Thrown if it cannot create a step palette from an input stream.write(java.io.OutputStream)
public static VWStepPaletteDefinition readFromFile(java.lang.String theFileName) throws VWException
theFileName
- The name of the file from which to read the VWStepPaletteDefinition object definition.
VWException
writeToFile(java.lang.String)
,
read(java.io.InputStream)
public void write(java.io.OutputStream theStream) throws VWException
theStream
- An object output stream to which to write this step palette.
VWException
- Thrown if it cannot write this VWStepPaletteDefinition object to an output stream.read(java.io.InputStream)
public void writeToFile(java.lang.String theFileName) throws VWException
theFileName
- Name of the file to which to write this step palette.
VWException
- Thrown if it cannot write this VWStepPaletteDefinition object to a file.readFromFile(java.lang.String)
,
write(java.io.OutputStream)
public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String AsXMLString() throws VWException
VWException
- Thrown if it cannot retrieve an XML formatted representation of this step palette.toXML(java.lang.StringBuffer)
public void toXML(java.lang.StringBuffer theBuffer) throws VWException
Warning: This XML String is non-extensible, and cannot be modified in any way.
theBuffer
- A String buffer that this method will append with XML content.
VWException
VWXMLUtil
|
Process API | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |