Package com.webmethods.bpm.noodle

Interface IWorkspaceContext

public interface IWorkspaceContext
Interface for an implementation that allows manipulation of the properties that make up a workspace context

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getAsString()
    Gets a string representation of the map of workspace context properties.
    Map<String,Object>
    getProperties()
    Gets all the properties of the workspace context as a map of String/Object pairs.
    Object
    getProperty(String name)
    Gets a property by name from the workspace context.
    List<String>
    getPropertyNames()
    Gets a list of property names from the workspace context.
    boolean
    isDirty()
    Determines if the workspace context has unsaved changes.
    void
    setDirty(boolean val)
    Marks the workspace context state as dirty or clean.
    void
    setProperty(String name, Object val)
    Sets a property by name in the workspace context.

  • Method Details

    • getProperty

      Object getProperty(String name) throws Exception
      Gets a property by name from the workspace context.
      Parameters:
      name - The name of the property to retrieve.
      Returns:
      The property value object.
      Throws:
      Exception

    • setProperty

      void setProperty(String name, Object val) throws Exception
      Sets a property by name in the workspace context.
      Parameters:
      name - The name of property to set.
      val - The value of the property.
      Throws:
      Exception

    • getProperties

      Map<String,Object> getProperties() throws Exception
      Gets all the properties of the workspace context as a map of String/Object pairs. This map is editable and can be commited back to the workspace context via the save() method.
      Returns:
      Returns a map of key/object pairs representing the properties of this workspace context.
      Throws:
      Exception

    • getPropertyNames

      List<String> getPropertyNames() throws Exception
      Gets a list of property names from the workspace context.
      Returns:
      Returns a list of property name strings.
      Throws:
      Exception

    • getAsString

      String getAsString() throws Exception
      Gets a string representation of the map of workspace context properties.
      Returns:
      Returns a string representation of the workspace context properties.
      Throws:
      Exception

    • setDirty

      void setDirty(boolean val)
      Marks the workspace context state as dirty or clean.
      Parameters:
      val - Specifies the context state; true indicates the context is dirty and needs to be saved and false indicates that it no longer contains unsaved changes.

    • isDirty

      boolean isDirty()
      Determines if the workspace context has unsaved changes.
      Returns:
      Returns true if the workspace context has unsaved changes.