Package ch.ivyteam.ivy.application.property

Interface ICustomProperties

  • public interface ICustomProperties

    Custom properties can be used to store custom specific data.

    Examples:

    ivy.wf.getApplication().customProperties().property("hrm.user.showDetails").setValue(true);

    boolean showDetails = ivy.wf.getApplication().customProperties().property("hrm.user.showDetails").getBooleanValue();

    List<ICustomProperty> properties = ivy.wf.getApplication().customProperties().findAllStartingWith("hrm.user.");

    For storing custom specific settings or preferences that can be managed and changed by the user on the Admin UI you may want to use IGlobalVariable.

    See Also:
    IGlobalVariable
    API:
    This is a public API.

    • Method Detail

      • property

        ICustomProperty property​(String name)

        Returns the custom property with the given name.

        This method returns always a custom property even if the custom property does not have a value yet. Use ICustomProperty.hasValue() to check if the custom property already has a value.

        Parameters:
        name -
        Returns:
        custom property with the given name. Never null.
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION

      • getAll

        List<ICustomProperty> getAll()
        Returns all custom properties
        Returns:
        all custom properties
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION

      • findAllStartingWith

        List<ICustomProperty> findAllStartingWith​(String namePrefix)
        Returns all custom properties which names start with the given namePrefix
        Parameters:
        namePrefix -
        Returns:
        all custom properties which names start with the given namePrefix
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ApplicationCustomPropertyRead PERMISSION OR OWNS ApplicationCustomPropertyRead@SYSTEM PERMISSION

      • delete

        void delete​(String name)
        Deletes the custom property with the given name.
        Parameters:
        name -
        See Also:
        ICustomProperty.hasValue()
        API:
        This public API is available in IvyScript and Java. It has the visibility ADVANCED.
        Security:
        SESSION OWNS ApplicationCustomPropertyWrite PERMISSION OR OWNS ApplicationCustomPropertyWrite@SYSTEM PERMISSION