Package ch.ivyteam.ivy.system

Interface IPropertyBase

All Known Subinterfaces:
ICustomProperty, IProperty, ISystemProperty
public interface IPropertyBase
Base interface for all properties
API:
This is a public API.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getBooleanValue()
    Gets the property value as boolean
    int
    getIntValue()
    Gets the property value as int
    long
    getLongValue()
    Gets the property value as long
    String
    getName()
    Gets the property name
    String
    getValue()
    Gets the property value as String
    void
    setValue(boolean value)
    Sets the value of the property
    void
    setValue(int value)
    Sets the value of the property
    void
    setValue(long value)
    Sets the value of the property
    void
    setValue(String value)
    Sets the value of the property

  • Method Details

    • getName

      String getName()
      Gets the property name
      Returns:
      property name
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • getValue

      String getValue()
      Gets the property value as String
      Returns:
      property value.
      Throws:
      PersistencyException - if persistency access fails
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • getIntValue

      int getIntValue()
      Gets the property value as int
      Returns:
      property value as int
      Throws:
      PersistencyException - if persistency access fails
      NumberFormatException - if int value cannot be parsed
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • getLongValue

      long getLongValue()
      Gets the property value as long
      Returns:
      property value as long
      Throws:
      PersistencyException - if persistency access fails
      NumberFormatException - if long value cannot be parsed
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • getBooleanValue

      boolean getBooleanValue()
      Gets the property value as boolean
      Returns:
      property value as boolean
      Throws:
      PersistencyException - if persistency access fails
      See Also:
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • setValue

      void setValue(String value)
      Sets the value of the property
      Parameters:
      value - the new value
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • setValue

      void setValue(int value)
      Sets the value of the property
      Parameters:
      value - the new value
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • setValue

      void setValue(long value)
      Sets the value of the property
      Parameters:
      value - the new value
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.

    • setValue

      void setValue(boolean value)
      Sets the value of the property
      Parameters:
      value - the new value
      Throws:
      PersistencyException - if persistency access fails
      API:
      This public API is available in IvyScript and Java. It has the visibility ADVANCED.