Package step.repository.alm.v16.otaclient

Interface ISettings

  • All Superinterfaces:
    com4j.Com4jObject
    All Known Subinterfaces:
    ISettings2
    public interface ISettings
extends com4j.Com4jObject
    Represents users' settings in various user-defined categories.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void close()
      Closes and updates the category.
      void deleteCategory​(java.lang.String category)
      Deletes the current settings folder.
      void deleteValue​(java.lang.String name)
      Deletes the specified item.
      IList enumItems()
      Returns the list of names of the setting's items.
      java.lang.Object enumItems​(int index)  
      void open​(java.lang.String category)
      Sets the category to be used in subsequent actions by the client.
      void post()
      Posts the category to the server.
      void refresh​(java.lang.String category)
      Reads saved values, overwriting values in memory.
      java.lang.String value​(java.lang.String name)
      The value of the specified item in the active category.
      void value​(java.lang.String name, java.lang.String pVal)
      The value of the specified item in the active category.

      • Methods inherited from interface com4j.Com4jObject

        advise, dispose, equals, getComThread, getIUnknownPointer, getPointer, getPtr, hashCode, is, queryInterface, setName, toString

    • Method Detail

      • open

        void open​(java.lang.String category)

        Sets the category to be used in subsequent actions by the client.

        Parameters:
        category - Mandatory java.lang.String parameter.

      • value

        java.lang.String value​(java.lang.String name)

        The value of the specified item in the active category.

        Getter method for the COM property "Value"

        Parameters:
        name - Mandatory java.lang.String parameter.
        Returns:
        Returns a value of type java.lang.String

      • value

        void value​(java.lang.String name,
           java.lang.String pVal)

        The value of the specified item in the active category.

        Setter method for the COM property "Value"

        Parameters:
        name - Mandatory java.lang.String parameter.
        pVal - Mandatory java.lang.String parameter.

      • close

        void close()

        Closes and updates the category.

      • deleteCategory

        void deleteCategory​(java.lang.String category)

        Deletes the current settings folder.

        Parameters:
        category - Mandatory java.lang.String parameter.

      • deleteValue

        void deleteValue​(java.lang.String name)

        Deletes the specified item.

        Parameters:
        name - Mandatory java.lang.String parameter.

      • enumItems

        IList enumItems()

        Returns the list of names of the setting's items.

        Getter method for the COM property "EnumItems"

        Returns:
        Returns a value of type step.repository.alm.v16.otaclient.IList

      • enumItems

        java.lang.Object enumItems​(int index)

      • post

        void post()

        Posts the category to the server.

      • refresh

        void refresh​(java.lang.String category)

        Reads saved values, overwriting values in memory.

        Parameters:
        category - Mandatory java.lang.String parameter.