Package com.webmethods.bpm.noodle

Interface IUserTab

public interface IUserTab

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getCanDelete()
    Determines if the current user can delete the tab.
    boolean
    getCanEdit()
    Determines if the current user can edit the tab's properties.
    boolean
    getCanRename()
    Determines if the current user can rename the tab.
    boolean
    getCanSave()
    Determines if the current user can save edits to the tab.
    boolean
    getCanSaveAs()
    Determines if the current user can copy the tab.
    boolean
    getCanShare()
    Determines if the current user can modify the sharing properties the tab.
    String
    getContentThingID()
    Gets the ThingID of the content displayed by the tab.
    String
    getContentURL()
    Sets the URL to the content displayed in the tab.
    boolean
    getDirty()
    Determines if the tab has unsaved changes.
    String
    getDisplayName()
    Gets the tab's display name.
    String
    getID()
    Gets the tab's unique ID.
    int
    getIndex()
    Gets the display index of the tab within the tab set.
    String
    getTabIconURL()
    Gets the URL of the icon to display for the tab.
    int
    getType()
    Gets the tab type, see Tab Types.
    boolean
    isHidden()
     
    void
    save()
    Saves any changes made to the tab's properties.
    void
    setContentURL(String URL)
    Sets the URL of the content displayed by the tab.
    void
    setDisplayName(String displayName)
    Sets the tab's display name.
    void
    setHidden(boolean hidden)
     
    void
    setIndex(int index)
    Sets the display index of the tab within the tab set.
    void
    setTabIconURL(String iconURL)
    Sets the URL for the icon to display for the tab.
    void
    setType(int tabType)
    Gets the tab type for the tab.

  • Method Details

    • getType

      int getType()
      Gets the tab type, see Tab Types.
      Returns:
      the integer tab type constant.

    • setType

      void setType(int tabType)
      Gets the tab type for the tab.
      Parameters:
      tabType - the tab type, see Tab Types.

    • getID

      String getID()
      Gets the tab's unique ID.
      Returns:
      Returns the tab ID.

    • getDisplayName

      String getDisplayName()
      Gets the tab's display name.
      Returns:
      Returns the tab's display name.

    • setDisplayName

      void setDisplayName(String displayName) throws Exception
      Sets the tab's display name.
      Parameters:
      displayName - The new display name string.
      Throws:
      Exception

    • getTabIconURL

      String getTabIconURL()
      Gets the URL of the icon to display for the tab.
      Returns:
      The icon URL as a string.

    • setTabIconURL

      void setTabIconURL(String iconURL)
      Sets the URL for the icon to display for the tab.
      Parameters:
      iconURL - The new icon URL as a string.

    • getContentURL

      String getContentURL()
      Sets the URL to the content displayed in the tab.
      Returns:
      Returns the content URL as a string.

    • setContentURL

      void setContentURL(String URL)
      Sets the URL of the content displayed by the tab.
      Parameters:
      The - URL the content URL as a string.

    • getContentThingID

      String getContentThingID()
      Gets the ThingID of the content displayed by the tab.
      Returns:
      Returns the content ThingID as string.

    • isHidden

      boolean isHidden()

    • setHidden

      void setHidden(boolean hidden)

    • getIndex

      int getIndex()
      Gets the display index of the tab within the tab set.
      Returns:
      Returns the index.

    • setIndex

      void setIndex(int index)
      Sets the display index of the tab within the tab set.
      Parameters:
      index - The new display index.

    • getDirty

      boolean getDirty()
      Determines if the tab has unsaved changes.
      Returns:
      Returns true if the tab has unsaved changes

    • getCanSave

      boolean getCanSave()
      Determines if the current user can save edits to the tab.
      Returns:
      true if the current user has rights to save edits to the tab.

    • getCanSaveAs

      boolean getCanSaveAs()
      Determines if the current user can copy the tab.
      Returns:
      Returns true if the current user has rights to copy the tab.

    • getCanRename

      boolean getCanRename()
      Determines if the current user can rename the tab.
      Returns:
      Returns true if the current user has rights to rename the tab

    • getCanEdit

      boolean getCanEdit()
      Determines if the current user can edit the tab's properties.
      Returns:
      Returns true if the current user has rights to edit the properties of the tab

    • getCanDelete

      boolean getCanDelete()
      Determines if the current user can delete the tab.
      Returns:
      Returns true if the current user has rights to delete the tab

    • getCanShare

      boolean getCanShare()
      Determines if the current user can modify the sharing properties the tab.
      Returns:
      Returns true if the current user can modify the sharing properties of the tab

    • save

      void save() throws Exception
      Saves any changes made to the tab's properties.
      Throws:
      Exception