Package ch.ivyteam.ivy.workflow

Interface IAdditionalPropertyable

All Known Subinterfaces:
IBusinessCase, ICase, ITask
@Deprecated(since="7.3", forRemoval=true) public interface IAdditionalPropertyable
Deprecated, for removal: This API element is subject to removal in a future version.
use custom fields instead
Workflow classes implementing this interface are able to handle additional properties.
Since:
17.05.2006
API:
This is a public API.

  • Method Details

    • setAdditionalProperty

      @Deprecated(since="7.3", forRemoval=true) void setAdditionalProperty(String name, String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use customFields().textField(name).set(value) instead

      Sets an additional property.

      Note: If the object (task or case), on which the additional property is set, is not yet persisted in the system database then the object (task or case) will be persisted in the system database by this method.

      Parameters:
      name - the additional property name
      value - the additional property value. If value is null the property is removed.
      API:
      This public API is available in Java.
      Security:
      Case: SESSION OWNS CaseWriteAdditionalProperty PERMISSION OR OWNS CaseWriteAdditionalProperty@SYSTEM PERMISSION
      Task: SESSION OWNS TaskWriteAdditionalProperty PERMISSION OR OWNS TaskWriteAdditionalProperty@SYSTEM PERMISSION

    • getAdditionalProperty

      @Deprecated(since="7.3", forRemoval=true) String getAdditionalProperty(String name)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use customFields().textField(name).getOrNull() instead
      Gets an additional property value
      Parameters:
      name - the additional property name
      Returns:
      the addional property value or null if property does not exists
      API:
      This public API is available in Java.
      Security:
      Case: SESSION OWNS CaseReadAdditionalProperty PERMISSION OR OWNS CaseReadAdditionalProperty@SYSTEM PERMISSION
      Task: SESSION OWNS TaskReadAdditionalProperty PERMISSION OR OWNS TaskReadAdditionalProperty@SYSTEM PERMISSION

    • getAdditionalPropertyNames

      @Deprecated(since="7.3", forRemoval=true) List<String> getAdditionalPropertyNames()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use customFields().all() instead
      Gets all additional property names
      Returns:
      list with all additonal property names
      API:
      This public API is available in Java.
      Security:
      Case: SESSION OWNS CaseReadAllAdditionalPropertyNames PERMISSION OR OWNS CaseReadAllAdditionalPropertyNames@SYSTEM PERMISSION
      Task: SESSION OWNS TaskReadAllAdditionalPropertyNames PERMISSION OR OWNS TaskReadAllAdditionalPropertyNames@SYSTEM PERMISSION