Package ch.ivyteam.ivy.workflow

Interface ICase

All Superinterfaces:
IAdditionalPropertyable, INoteable
All Known Subinterfaces:
IBusinessCase
public interface ICase extends INoteable, IAdditionalPropertyable
A workflow case is an instance of a process. It consists of multiple tasks.

The system relevant fields of a case have certain functions within the system. Modifying them means to modify the behavior the case.

The business fields of a case can be used by the process designer to stored business information within a case. He is free in what kind of information he stores in the business fields. We suggest to use the business fields appropriate to their names. The information within the business fields can be referenced within name and description.

The custom fields of a case can be used by the process designer to stored custom information within a case. He is free in what kind of information he stores in the custom fields. The information within the custom fields can be referenced within name and description

Since:
17.05.2006
API:
This is a public API.

  • Method Details

    • getApplication

      IApplication getApplication()
      Gets the application the case belongs to
      Returns:
      application
      API:
      This public API is available in Java.

    • getWorkflowContext

      IWorkflowContext getWorkflowContext()
      Gets the workflow context this case belongs to
      Returns:
      workflow context
      API:
      This public API is available in Java.

    • getProcessModel

      IProcessModel getProcessModel()
      Gets the process model the case belongs to
      Returns:
      process model
      API:
      This public API is available in Java.

    • getProcessModelVersion

      IWorkflowProcessModelVersion getProcessModelVersion()
      Gets the process model version the case was started in
      Returns:
      process model version
      API:
      This public API is available in Java.

    • getBusinessCase

      IBusinessCase getBusinessCase()

      Gets the business case this case belongs to.

      If this case is a

      Returns:
      business case this case belongs to. Never null.
      Since:
      6.5
      See Also:
      API:
      This public API is available in Java.

    • isBusinessCase

      boolean isBusinessCase()
      Returns true if this case is a business case and false if it is a sub case.
      Returns:
      true if this case is a business case
      Since:
      6.5
      See Also:
      API:
      This public API is available in Java.

    • attachToBusinessCase

      void attachToBusinessCase(long businessCaseId)

      Attaches this case to a business case with the given id. If this case is already attached to a business case or already have sub cases then an IllegalStateException is thrown. If the given id does not belong to a business case or belongs to a case of another application then an IllegalArgumentException is thrown.

      Parameters:
      businessCaseId -
      Throws:
      IllegalStateException - if the case is already attached to a business case or has sub cases
      IllegalArgumentException - if the given businessCaseId is not valid
      Since:
      6.5
      See Also:
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseAttachToBusinessCase PERMISSION OR OWNS CaseAttachToBusinessCase@SYSTEM PERMISSION

    • getId

      long getId()
      Returns the case identifier. You should always prefer using uuid().
      Returns:
      case identifier
      See Also:
      API:
      This public API is available in Java.

    • uuid

      String uuid()
      A globally unique identifier for this case. In principle, the UUID should always be preferred over the ID.
      Returns:
      globally unique identifier of this case
      API:
      This public API is available in Java.

    • tasks

      ITasks tasks()
      Provides access to the tasks of this case.
      Returns:
      task provider
      API:
      This public API is available in Java.

    • getTasks

      @Deprecated(since="9.2", forRemoval=true) List<ITask> getTasks()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use tasks().all() Returns all child tasks.
      Returns:
      all tasks
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskReadOwnCaseTasks PERMISSION OR OWNS TaskRead PERMISSION OR OWNS TaskRead@SYSTEM PERMISSION

    • getActiveTasks

      @Deprecated(since="9.2", forRemoval=true) List<ITask> getActiveTasks()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use tasks().allActive() Returns all active child tasks.
      Returns:
      all active tasks
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskReadOwnCaseTasks PERMISSION OR OWNS TaskRead PERMISSION OR OWNS TaskRead@SYSTEM PERMISSION

    • getFirstTask

      ITask getFirstTask()
      Gets the first task of the case. The task that is started at the start process element.
      Returns:
      first task
      API:
      This public API is available in Java.

    • getCreatorUser

      IUser getCreatorUser()
      Gets the user who created this case. Maybe null if user is not known e.g. the case was created by an unknown user or the user was deleted since this case was started. In this case (user was deleted) the name of the user who created the case and was deleted in the meanwhile can be evaluated with the method getCreatorUserName(). This method will return the name of the user who created this case even if the user was deleted.
      Returns:
      creator user or null
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadCreatorUser PERMISSION OR OWNS CaseReadCreatorUser@SYSTEM PERMISSION

    • getCreatorUserName

      String getCreatorUserName()
      Gets the name of the user who created this case. Maybe null if user is not known e.g. the case was created by an unknown user. Note that this method will provide the name of the user even if the user does not exists anymore.
      Returns:
      name of the user who created this case
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadCreatorUserName PERMISSION OR OWNS CaseReadCreatorUserName@SYSTEM PERMISSION

    • setCreatorUser

      default void setCreatorUser(IUser creatorUser)
      Sets the given user as case creator.
      Parameters:
      creatorUser - the user to set as case creator. null indicates the user is unknown (e.g. an anonymous user)
      Since:
      6.7
      API:
      This public API is available in Java.

    • getCreatorTask

      ITask getCreatorTask()
      Gets the task that created this case with a trigger element, maybe null if case was not started through a trigger element.
      Returns:
      creator task
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS TaskRead PERMISSION OR OWNS TaskRead@SYSTEM PERMISSION

    • getProcessStart

      IProcessStart getProcessStart()
      Get the process start the case was started on
      Returns:
      process start
      API:
      This public API is available in Java.

    • getWorkflowEvents

      List<IWorkflowEvent> getWorkflowEvents()
      Gets the workflow events of this case
      Returns:
      list of workflow events
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS WorkflowEventReadAll PERMISSION OR OWNS WorkflowEventReadAll@SYSTEM PERMISSION

    • getStartTimestamp

      Date getStartTimestamp()
      Gets the start timestamp of the case
      Returns:
      start timestamp
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadStartTimestamp PERMISSION OR OWNS CaseReadStartTimestamp@SYSTEM PERMISSION

    • getEndTimestamp

      Date getEndTimestamp()
      Gets the end timestamp of the case. Maybe null if case is not yet finished
      Returns:
      end timestamp. Maybe null
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadEndTimestamp PERMISSION OR OWNS CaseReadEndTimestamp@SYSTEM PERMISSION

    • getModifiedTimestamp

      Date getModifiedTimestamp()
      Get the last timestamp a case has been modified.
      Returns:
      modified timestamp
      API:
      This public API is available in Java.

    • getBusinessRuntime

      BusinessDuration getBusinessRuntime()

      Gets the BusinessDuration between the creation (see getStartTimestamp()) and the completion (see getEndTimestamp()) of this case.

      The business runtime is calculated only when a case ends (state changes to CaseState.DONE).

      To calculate the BusinessDuration the IDefaultBusinessCalendar of the case is used.

      Returns:
      BusinessDuration between creation and completion. Returns null if the case is not yet completed or the case has been completed before the business runtime feature was introduced.
      Since:
      Pilatus
      See Also:
      API:
      This public API is available in Java.

    • getWorkingTime

      Duration getWorkingTime()
      Gets the Duration during that any user has been working on this case.
      The working time is the sum of the working times from all tasks of this case. Whenever a task working time changes, the corresponding case working time is recalculated.
      Returns:
      Working time as Duration.
      Returns null for the following situations:
      • no task has been parked or completed
      • the case has been completed before the working time feature was introduced.
      Since:
      Pilatus
      See Also:
      API:
      This public API is available in Java.

    • owners

      CaseOwners owners()
      Returns the owners of the case.

      The intend of the owner is only for descriptive purpose and has no influence on the behavior of the Workflow Engine. This may can be used for example in Workflow UIs to search and filter in case lists.
      Returns:
      owners
      Since:
      12.0.0
      API:
      This public API is available in Java.

    • notes

      Notes notes()

      Returns the notes of the case.

      Examples:

      Get all notes of the current case:
      List<Note> notes = ivy.case.notes().all()

      Add a new note to the current case:
      ivy.case.notes().add().content("My first note").execute()

      Returns:
      notes
      Since:
      12.0.0
      API:
      This public API is available in Java.

    • setOwner

      @Deprecated(since="12.0.0", forRemoval=true) void setOwner(ISecurityMember owner)
      Deprecated, for removal: This API element is subject to removal in a future version.
      use owners(). A case can have multiple owners. To not break existing applications, this will first remove all owners attached to this case and adds the new owner. By passing null it only will remove all owners. Sets the owner of the case.
      Parameters:
      owner - or null
      See Also:
      API:
      This public API is available in Java.

    • getOwner

      @Deprecated(since="12.0.0", forRemoval=true) ISecurityMember getOwner()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use owners(). A case can have multiple owners. This will return only one owner. Returns the owner of the case. Maybe null if no owner was set with setOwner(ISecurityMember).

      The intend of the owner is only for descriptive purpose and has no influence on the behavior of the Workflow Engine. This may can be used for example in Workflow UIs to search and filter in case lists.
      Returns:
      owner or null
      API:
      This public API is available in Java.

    • getOwnerName

      @Deprecated(since="12.0.0", forRemoval=true) String getOwnerName()
      Deprecated, for removal: This API element is subject to removal in a future version.
      use owners(). A case can have multiple owners. This will return only the name of one owner. Returns the name of the owner. Maybe null if no owner was set with setOwner(ISecurityMember). Does not return null if the ISecurityMember was deleted.
      Returns:
      name of the owner or null
      See Also:
      API:
      This public API is available in Java.

    • setCategoryPath

      void setCategoryPath(String categoryPath)
      Sets the given String as category path of this ICase. Use "/" as path separator.

      null or an empty string could be used to reset the path.

      Parameters:
      categoryPath - the category path of this ICase.
      See Also:
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseWriteCategory PERMISSION OR OWNS CaseWriteCategory@SYSTEM PERMISSION

    • getCategoryPath

      String getCategoryPath()
      Returns the category path of this ICase.

      The method getCategory() returns the corresponding Category to the current category path.

      Returns:
      the current category path, never null
      See Also:
      API:
      This public API is available in Java.

    • getCategory

      Category getCategory()
      Returns the Category of this ICase. The Category provides locale specific information like the name of a category path, as defined in the CMS. See Category for more information.

      The method setCategoryPath(String) allows to set the category of a case.

      Returns:
      the current Category, corresponding to the current category path, never null
      See Also:
      API:
      This public API is available in Java.

    • getState

      CaseState getState()
      Get state of the case
      Returns:
      state of the case
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadState PERMISSION OR OWNS CaseReadState@SYSTEM PERMISSION

    • getBusinessState

      CaseBusinessState getBusinessState()
      Gets the business state of the case
      Returns:
      business state
      Since:
      11.1.0
      API:
      This public API is available in Java.

    • getPriority

      WorkflowPriority getPriority()
      Gets the priority of the case
      Returns:
      priority of the case
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadPriority PERMISSION OR OWNS CaseReadPriority@SYSTEM PERMISSION

    • setPriority

      void setPriority(WorkflowPriority priority)
      Sets the priority of the case
      Parameters:
      priority - the new priority
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseWritePriority PERMISSION OR OWNS CaseWritePriority@SYSTEM PERMISSION

    • isPersistent

      boolean isPersistent()
      Checks if the case is persistent. A case that is persistent will also be available after a system restart. A case is normally created non persistent with the following exception:
      • The case is created with a trigger element
      The first task of a case is also created non persistent. As soon as the first task gets persistent the case will be persistent too.
      Returns:
      true if case is persistent, otherwise false
      See Also:
      API:
      This public API is available in Java.

    • getName

      String getName()
      Get name of the case for the current session's content locale.
      Returns:
      name of the case
      See Also:
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseReadName PERMISSION OR OWNS CaseReadName@SYSTEM PERMISSION

    • setName

      void setName(String nameTemplate)

      Expands the macros in the given case name template and then sets the expanded case name for each locale.

      Note: Only <%=ivy.cms.co(...)%> macros are supported. If you want to include process data then use string concatenation instead of <%=in. ...%> macros.

      If the given case name template do not contain any macros the same case name (the name template) is set for all locales.

      Example:

      
 ivy.case.setName("<%=ivy.cms.co(\"/case/name\")%> " + in.person.name);
      Parameters:
      nameTemplate - the template with macros to expand
      Throws:
      IllegalArgumentException - if the given macro is null
      See Also:
      API:
      This public API is available in Java.
      Security:
      SESSION OWNS CaseWriteName PERMISSION OR OWNS CaseWriteName@SYSTEM PERMISSION

    • names

      ILocalizedStrings names()

      Get the localized names of the case.

      Example:

      String caseName = ivy.wfCase.names().current();
      

      

      Returns:
      

      localized names
      

      Since:
      

      9.4
      

      See Also:
      

      


      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      getDisplayNameTemplate
      

      @Deprecated(since="9.4",
            forRemoval=true)
String getDisplayNameTemplate()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      will always return empty string. Use getName() or names().get(Locale) instead.
      

      

      Gets the display name template of the case.
      

      

      Returns:
      

      empty string
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadDisplayNameTemplate PERMISSION OR OWNS CaseReadDisplayNameTemplate@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getDescription
      

      String getDescription()
      

      Get description of the case for the current session's content locale.
      

      

      Returns:
      

      description of the case
      

      See Also:
      

      


      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadDescription PERMISSION OR OWNS CaseReadDescription@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setDescription
      

      void setDescription(String descriptionTemplate)
      

      Expands the macros in the given case description template and then sets the expanded case description for each locale.
      
 
      Note: Only <%=ivy.cms.co(...)%> macros are supported. If you want to include process data then use string concatenation instead of <%=in. ...%> macros.
      
 
      If the given case description template do not contain any macros the same case description (the name template) is set for all locales.
 
      Example:
      
 
      
 ivy.case.setDescription("<%=ivy.cms.co(\"/case/description\")%> " + in.person.name);
 
      

      

      Parameters:
      

      descriptionTemplate - the template with macros to expand
      

      Throws:
      

      IllegalArgumentException - if the given macro is null
      

      See Also:
      

      


      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteDescription PERMISSION OR OWNS CaseWriteDescription@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      descriptions
      

      ILocalizedStrings descriptions()
      

      Get the localized descriptions of the task.
      
 
      Example:
      
 
      String caseDescription = ivy.wfCase.descriptions().current();
      

      

      Returns:
      

      localized descriptions
      

      Since:
      

      9.4
      

      See Also:
      

      


      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      getDisplayDescriptionTemplate
      

      @Deprecated(since="9.4",
            forRemoval=true)
String getDisplayDescriptionTemplate()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      will always return empty string. Use getDescription() or descriptions().get(Locale) instead.
      

      

      Gets the display description template of the case.
      

      

      Returns:
      

      empty string
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadDisplayDescriptionTemplate PERMISSION OR OWNS CaseReadDisplayDescriptionTemplate@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getProcessCategoryCode
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getProcessCategoryCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process category code and name as additional information.
             
      Getting case process category code with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessCategoryCode").getOrNull();
      

      

      Gets the process category code
      

      

      Returns:
      

      process category code. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadProcessCategoryCode PERMISSION OR OWNS CaseReadProcessCategoryCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getProcessCategoryName
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getProcessCategoryName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process category code and name as additional information.
             
      Getting case process category name with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessCategoryName").getOrNull();
      

      

      Gets the process category name
      

      

      Returns:
      

      process category name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadProcessCategoryName PERMISSION OR OWNS CaseReadProcessCategoryName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setProcessCategory
      

      @Deprecated(since="7.0",
            forRemoval=true)
void setProcessCategory(String processCategoryCode,
 String processCategoryName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process category code and name as additional information.
             
      Setting case process category code and name with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessCategoryCode").set(processCategoryCode);
      
             
      ivy.case.customFields().stringField("ProcessCategoryName").set(processCategoryName);
      

      

      Sets the process category.
      

      

      Parameters:
      

      processCategoryCode - the new process category code. Maybe null
      

      processCategoryName - the new process category name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteProcessCategory PERMISSION OR OWNS CaseWriteProcessCategory@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getProcessCode
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getProcessCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process code and name as additional information.
             
      Getting case process code with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessCode").getOrNull();
      

      

      Gets the process code
      

      

      Returns:
      

      process code. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadProcessCode PERMISSION OR OWNS CaseReadProcessCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getProcessName
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getProcessName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process code and name as additional information.
             
      Getting case process name with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessName").getOrNull();
      

      

      Gets the process name
      

      

      Returns:
      

      process name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadProcessName PERMISSION OR OWNS CaseReadProcessName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setProcess
      

      @Deprecated(since="7.0",
            forRemoval=true)
void setProcess(String processCode,
 String processName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store process code and name as additional information.
             
      Setting process code and name with custom fields:
      
             
      ivy.case.customFields().stringField("ProcessCode").set(processCode);
      
             
      ivy.case.customFields().stringField("ProcessName").set(processName);
      

      

      Sets the process
      

      

      Parameters:
      

      processCode - the new process code. Maybe null
      

      processName - the new process name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteProcess PERMISSION OR OWNS CaseWriteProcess@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getTypeCode
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getTypeCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store type code and name as additional information.
             
      Getting case type code with custom fields:
      
             
      ivy.case.customFields().stringField("TypeCode").getOrNull();
      

      

      Gets the case type code
      

      

      Returns:
      

      case type code. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadTypeCode PERMISSION OR OWNS CaseReadTypeCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getTypeName
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getTypeName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store type code and name as additional information.
             
      Getting case type name with custom fields:
      
             
      ivy.case.customFields().stringField("TypeName").getOrNull();
      

      

      Gets the case type name
      

      

      Returns:
      

      cast type name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadTypeName PERMISSION OR OWNS CaseReadTypeName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setType
      

      @Deprecated(since="7.0",
            forRemoval=true)
void setType(String typeCode,
 String typeName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store case type code and name as additional information.
             
      Setting case type code and name with custom fields:
      
             
      ivy.case.customFields().stringField("TypeCode").set(typeCode);
      
             
      ivy.case.customFields().stringField("TypeName").set(typeName);
      

      

      Sets the case type.
      

      

      Parameters:
      

      typeCode - the new case type code. Maybe null
      

      typeName - the new case type name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteType PERMISSION OR OWNS CaseWriteType@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getSubTypeCode
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getSubTypeCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store sub type code and name as additional information.
             
      Getting case sub type code with custom fields:
      
             
      ivy.case.customFields().stringField("SubTypeCode").getOrNull();
      

      

      Gets the case sub type code
      

      

      Returns:
      

      case sub type code. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadSubTypeCode PERMISSION OR OWNS CaseReadSubTypeCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getSubTypeName
      

      @Deprecated(since="7.0",
            forRemoval=true)
String getSubTypeName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store sub type code and name as additional information.
             
      Getting case sub type name with custom fields:
      
             
      ivy.case.customFields().stringField("SubTypeName").getOrNull();
      

      

      Gets the case sub type name
      

      

      Returns:
      

      cast sub type name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadSubTypeName PERMISSION OR OWNS CaseReadSubTypeName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setSubType
      

      @Deprecated(since="7.0",
            forRemoval=true)
void setSubType(String subTypeCode,
 String subTypeName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use category to categorize the case or customFields() to store case sub type code and name as additional information.
             
      Setting case sub type code and name with custom fields:
      
             
      ivy.case.customFields().stringField("SubTypeCode").set(subTypeCode);
      
             
      ivy.case.customFields().stringField("SubTypeName").set(subTypeName);
      

      

      Sets the case sub type.
      

      

      Parameters:
      

      subTypeCode - the new case sub type code. Maybe null
      

      subTypeName - the new case sub type name. Maybe null
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteSubType PERMISSION OR OWNS CaseWriteSubType@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessStartTimestamp
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getBusinessStartTimestamp()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("BusinessStartTimestamp").getOrNull() instead
      

      

      Gets the business start timestamp. Maybe null.
      

      

      Returns:
      

      business start timestamp. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessStartTimestamp PERMISSION OR OWNS CaseReadBusinessStartTimestamp@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessStartTimestamp
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessStartTimestamp(Date businessStartTimestamp)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("BusinessStarteTimestamp").set(businessStartTimestamp) instead
      

      

      Sets the business start timestamp.
      

      

      Parameters:
      

      businessStartTimestamp - the new business start timestamp. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessStartTimestamp PERMISSION OR OWNS CaseWriteBusinessStartTimestamp@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMilestoneTimestamp
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getBusinessMilestoneTimestamp()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("BusinessMilestoneTimestamp").getOrNull() instead
      

      

      Gets the business milestone timestamp. Maybe null.
      

      

      Returns:
      

      business milestone timestamp. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMilestoneTimestamp PERMISSION OR OWNS CaseReadBusinessMilestoneTimestamp@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMilestoneTimestamp
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMilestoneTimestamp(Date businessMilestoneTimestamp)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("BusinessMilestoneTimestamp").set(businessMilestoneTimestamp) instead
      

      

      Sets the business milestone timestamp.
      

      

      Parameters:
      

      businessMilestoneTimestamp - the new business milestone timestamp. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMilestoneTimestamp PERMISSION OR OWNS CaseWriteBusinessMilestoneTimestamp@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessPriority
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessPriority()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessPriorty").getOrNull() instead
      

      

      Gets the business priority. Maybe null.
      

      

      Returns:
      

      the business priority. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessPriority PERMISSION OR OWNS CaseReadBusinessPriority@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessPriority
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessPriority(String businessPriority)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessPriorty").set(businessPriority) instead
      

      

      Sets the business priority.
      

      

      Parameters:
      

      businessPriority - the new business priority. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessPriority PERMISSION OR OWNS CaseWriteBusinessPriority@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessCreatorUser
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessCreatorUser()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessCreatorUser").getOrNull() instead
      

      

      Gets the business creator user. Maybe null.
      

      

      Returns:
      

      the business creator user. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessCreatorUser PERMISSION OR OWNS CaseReadBusinessCreatorUser@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessCreatorUser
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessCreatorUser(String businessCreatorUser)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessCreatorUser").set(businessCreatorUser) instead
      

      

      Sets the business creator user
      

      

      Parameters:
      

      businessCreatorUser - the new business creator user. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessCreatorUser PERMISSION OR OWNS CaseWriteBusinessCreatorUser@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMainContactType
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessMainContactType()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactType").getOrNull() instead
      

      

      Gets the business main contact type. Maybe null.
      

      

      Returns:
      

      the business main contact type. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMainContactType PERMISSION OR OWNS CaseReadBusinessMainContactType@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMainContactType
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMainContactType(String businessMainContactType)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactType").set(businessMainContactType) instead
      

      

      Sets the business main contact type.
      

      

      Parameters:
      

      businessMainContactType - the new business main contact type. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMainContactType PERMISSION OR OWNS CaseWriteBusinessMainContactType@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMainContactId
      

      @Deprecated(since="7.3",
            forRemoval=true)
Integer getBusinessMainContactId()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("BusinessMainContactId").getOrNull() instead
      

      

      Gets the business main contact identifier. Maybe null.
      

      

      Returns:
      

      the business main contact identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMainContactId PERMISSION OR OWNS CaseReadBusinessMainContactId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMainContactId
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMainContactId(Integer businessMainContactId)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("BusinessMainContactId").set(businessMainContactId) instead
      

      

      Sets the business main contact identifier .
      

      

      Parameters:
      

      businessMainContactId - the new business main contact identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMainContactId PERMISSION OR OWNS CaseWriteBusinessMainContactId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMainContactName
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessMainContactName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactName").getOrNull() instead
      

      

      Gets the business main contact name. Maybe null.
      

      

      Returns:
      

      the business main contact name. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMainContactName PERMISSION OR OWNS CaseReadBusinessMainContactName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMainContactName
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMainContactName(String businessMainContactName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactName").set(businessMainContactName) instead
      

      

      Sets the business main contact name.
      

      

      Parameters:
      

      businessMainContactName - the new business main contact name. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMainContactName PERMISSION OR OWNS CaseWriteBusinessMainContactName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMainContactDocumentDatabaseCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessMainContactDocumentDatabaseCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactDocumentDbCode").getOrNull() instead
      

      

      Gets the business main contact document database code. Maybe null.
      

      

      Returns:
      

      the business main contact document database code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMainContactDocumentDatabaseCode PERMISSION OR OWNS CaseReadBusinessMainContactDocumentDatabaseCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMainContactDocumentDatabaseCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMainContactDocumentDatabaseCode(String businessMainContactDocumentDatabaseCode)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactDocumentDbCode").set(businessMainContactDocumentDatabaseCode)
             instead
      

      

      Sets the business main contact document database code.
      

      

      Parameters:
      

      businessMainContactDocumentDatabaseCode - the new business main contact document database code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMainContactDocumentDatabaseCode PERMISSION OR OWNS CaseWriteBusinessMainContactDocumentDatabaseCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessMainContactFolderId
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessMainContactFolderId()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactFolderId").getOrNull() instead
      

      

      Gets the business main contact folder identifier. Maybe null.
      

      

      Returns:
      

      the business main contact folder identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessMainContactFolderId PERMISSION OR OWNS CaseReadBusinessMainContactFolderId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessMainContactFolderId
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessMainContactFolderId(String businessMainContactFolderId)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessMainContactFolderId").set(businessMainContactFolderId) instead
      

      

      Sets the business main contact folder identifier.
      

      

      Parameters:
      

      businessMainContactFolderId - the new business main contact folder identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessMainContactFolderId PERMISSION OR OWNS CaseWriteBusinessMainContactFolderId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessCorrespondentId
      

      @Deprecated(since="7.3",
            forRemoval=true)
Integer getBusinessCorrespondentId()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("BusinessCorrespondentId").getOrNull() instead
      

      

      Gets the business correspondent identifier. Maybe null.
      

      

      Returns:
      

      the business correspondent identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessCorrespondentId PERMISSION OR OWNS CaseReadBusinessCorrespondentId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessCorrespondentId
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessCorrespondentId(Integer businessCorrespondentId)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("BusinessCorrespondentId").set(businessCorrespondentId) instead
      

      

      Sets the business correspondent identifier.
      

      

      Parameters:
      

      businessCorrespondentId - the new business correspondent identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessCorrespondentId PERMISSION OR OWNS CaseWriteBusinessCorrespondentId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessObjectCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessObjectCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectCode").getOrNull() instead
      

      

      Gets the business object code. Maybe null.
      

      

      Returns:
      

      the business object code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessObjectCode PERMISSION OR OWNS CaseReadBusinessObjectCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessObjectCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessObjectCode(String businessObjectCode)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectCode").set(businessObjectCode) instead
      

      

      Sets the business object code.
      

      

      Parameters:
      

      businessObjectCode - the new business object code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessObjectCode PERMISSION OR OWNS CaseWriteBusinessObjectCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessObjectName
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessObjectName()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectCode").getOrNull() instead
      

      

      Gets the business object name. Maybe null.
      

      

      Returns:
      

      the business object name. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessObjectName PERMISSION OR OWNS CaseReadBusinessObjectName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessObjectName
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessObjectName(String businessObjectName)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectName").set(businessObjectName) instead
      

      

      Sets the business object name.
      

      

      Parameters:
      

      businessObjectName - the business object name. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessObjectName PERMISSION OR OWNS CaseWriteBusinessObjectName@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessObjectDocumentDatabaseCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessObjectDocumentDatabaseCode()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectDocumentDbCode").getOrNull() instead
      

      

      Gets the business object document database code. Maybe null.
      

      

      Returns:
      

      the business object document database code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessObjectDocumentDatabaseCode PERMISSION OR OWNS CaseReadBusinessObjectDocumentDatabaseCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessObjectDocumentDatabaseCode
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessObjectDocumentDatabaseCode(String businessObjectDocumentDatabaseCode)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectDocumentDbCode").set(businessObjectDocumentDatabaseCode) instead
      

      

      Sets the business object document database code.
      

      

      Parameters:
      

      businessObjectDocumentDatabaseCode - the new business object document database code. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessObjectDocumentDatabaseCode PERMISSION OR OWNS CaseWriteBusinessObjectDocumentDatabaseCode@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessObjectFolderId
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getBusinessObjectFolderId()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectFolderId").getOrNull() instead
      

      

      Gets the business object folder identifier. Maybe null.
      

      

      Returns:
      

      the business object folder identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadBusinessObjectFolderId PERMISSION OR OWNS CaseReadBusinessObjectFolderId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setBusinessObjectFolderId
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setBusinessObjectFolderId(String businessObjectFolderId)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("BusinessObjectFolderId").set(businessObjectFolderId) instead
      

      

      Sets the business object folder identifier.
      

      

      Parameters:
      

      businessObjectFolderId - the new business object folder identifier. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteBusinessObjectFolderId PERMISSION OR OWNS CaseWriteBusinessObjectFolderId@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      customFields
      

      ICustomFields customFields()
      

      You can use custom fields to store additional, customer specific information on a case.
 You can use custom fields to search for or filter cases.
      
 
      Examples:
      
 
      Setting a custom field:
      
 
      ivy.case.customFields().stringField("branchOffice").set("Zug");
      
 
      Getting a custom field:
      
 
      String branchOffice = ivy.case.customFields().stringField("branchOffice").getOrDefault("Luzern")
      
 
      Getting all custom fields:
      
 
      import ch.ivyteam.ivy.workflow.custom.field.ICustomField;
 List<ICustomField> customFields = ivy.case.customFields().all();
      

      

      Returns:
      

      custom fields
      

      Since:
      

      7.3
      

      See Also:
      

      


      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      getCustomVarCharField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getCustomVarCharField1()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField1").getOrNull() instead
      

      

      Gets the custom varchar field 1. Maybe null.
      

      

      Returns:
      

      the custom varchar field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomVarCharField1 PERMISSION OR OWNS CaseReadCustomVarCharField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomVarCharField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomVarCharField1(String customVarCharField1)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField1").set(customVarCharField1) instead
      

      

      Sets the custom varchar field 1.
      

      

      Parameters:
      

      customVarCharField1 - the custom varchar field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomVarCharField1 PERMISSION OR OWNS CaseWriteCustomVarCharField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomVarCharField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getCustomVarCharField2()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField2").getOrNull() instead
      

      

      Gets the custom varchar field 2. Maybe null.
      

      

      Returns:
      

      the custom varchar field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomVarCharField2 PERMISSION OR OWNS CaseReadCustomVarCharField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomVarCharField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomVarCharField2(String customVarCharField2)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField2").set(customVarCharField2) instead
      

      

      Sets the custom varchar field 2.
      

      

      Parameters:
      

      customVarCharField2 - the custom varchar field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomVarCharField2 PERMISSION OR OWNS CaseWriteCustomVarCharField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomVarCharField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getCustomVarCharField3()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField3").getOrNull() instead
      

      

      Gets the custom varchar field 3. Maybe null.
      

      

      Returns:
      

      the custom varchar field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomVarCharField3 PERMISSION OR OWNS CaseReadCustomVarCharField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomVarCharField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomVarCharField3(String customVarCharField3)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField3").set(customVarCharField3) instead
      

      

      Sets the custom varchar field 3.
      

      

      Parameters:
      

      customVarCharField3 - the custom varchar field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomVarCharField3 PERMISSION OR OWNS CaseWriteCustomVarCharField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomVarCharField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getCustomVarCharField4()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField4").getOrNull() instead
      

      

      Gets the custom varchar field 4. Maybe null.
      

      

      Returns:
      

      the custom varchar field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomVarCharField4 PERMISSION OR OWNS CaseReadCustomVarCharField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomVarCharField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomVarCharField4(String customVarCharField4)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField4").set(customVarCharField4) instead
      

      

      Sets the custom varchar field 4.
      

      

      Parameters:
      

      customVarCharField4 - the custom varchar field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomVarCharField4 PERMISSION OR OWNS CaseWriteCustomVarCharField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomVarCharField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
String getCustomVarCharField5()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField5").getOrNull() instead
      

      

      Gets the custom varchar field 5. Maybe null.
      

      

      Returns:
      

      the custom varchar field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomVarCharField5 PERMISSION OR OWNS CaseReadCustomVarCharField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomVarCharField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomVarCharField5(String customVarCharField5)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().stringField("CustomVarCharField5").set(customVarCharField5) instead
      

      

      Sets the custom varchar field 5.
      

      

      Parameters:
      

      customVarCharField5 - the custom varchar field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomVarCharField5 PERMISSION OR OWNS CaseWriteCustomVarCharField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomDecimalField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
Number getCustomDecimalField1()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField1").getOrNull() instead
      

      

      Gets the custom decimal field 1. Maybe null.
      

      

      Returns:
      

      the custom decimal field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomDecimalField1 PERMISSION OR OWNS CaseReadCustomDecimalField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomDecimalField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomDecimalField1(Number customDecimalField1)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField1").set(customDecimalField1) instead
      

      

      Sets the custom decimal field 1.
      

      

      Parameters:
      

      customDecimalField1 - the custom decimal field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomDecimalField1 PERMISSION OR OWNS CaseWriteCustomDecimalField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomDecimalField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
Number getCustomDecimalField2()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField2").getOrNull() instead
      

      

      Gets the custom decimal field 2. Maybe null.
      

      

      Returns:
      

      the custom decimal field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomDecimalField2 PERMISSION OR OWNS CaseReadCustomDecimalField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomDecimalField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomDecimalField2(Number customDecimalField2)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField2").set(customDecimalField2) instead
      

      

      Sets the custom decimal field 2.
      

      

      Parameters:
      

      customDecimalField2 - the custom decimal field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomDecimalField2 PERMISSION OR OWNS CaseWriteCustomDecimalField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomDecimalField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
Number getCustomDecimalField3()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField3").getOrNull() instead
      

      

      Gets the custom decimal field 3. Maybe null.
      

      

      Returns:
      

      the custom decimal field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomDecimalField3 PERMISSION OR OWNS CaseReadCustomDecimalField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomDecimalField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomDecimalField3(Number customDecimalField3)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField3").set(customDecimalField3) instead
      

      

      Sets the custom decimal field 3.
      

      

      Parameters:
      

      customDecimalField3 - the custom decimal field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomDecimalField3 PERMISSION OR OWNS CaseWriteCustomDecimalField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomDecimalField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
Number getCustomDecimalField4()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField4").getOrNull() instead
      

      

      Gets the custom decimal field 4. Maybe null.
      

      

      Returns:
      

      the custom decimal field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomDecimalField4 PERMISSION OR OWNS CaseReadCustomDecimalField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomDecimalField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomDecimalField4(Number customDecimalField4)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField4").set(customDecimalField4) instead
      

      

      Sets the custom decimal field 4.
      

      

      Parameters:
      

      customDecimalField4 - the custom decimal field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomDecimalField4 PERMISSION OR OWNS CaseWriteCustomDecimalField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomDecimalField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
Number getCustomDecimalField5()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField5").getOrNull() instead
      

      

      Gets the custom decimal field 5. Maybe null.
      

      

      Returns:
      

      the custom decimal field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomDecimalField5 PERMISSION OR OWNS CaseReadCustomDecimalField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomDecimalField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomDecimalField5(Number customDecimalField5)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().numberField("CustomDecimalField5").set(customDecimalField5) instead
      

      

      Sets the custom decimal field 5.
      

      

      Parameters:
      

      customDecimalField5 - the custom decimal field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomDecimalField5 PERMISSION OR OWNS CaseWriteCustomDecimalField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomTimestampField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getCustomTimestampField1()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField1").getOrNull() instead
      

      

      Gets the custom timestamp field 1. Maybe null.
      

      

      Returns:
      

      the custom timestamp field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomTimestampField1 PERMISSION OR OWNS CaseReadCustomTimestampField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomTimestampField1
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomTimestampField1(Date customTimestampField1)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField1").set(customTimestampField1) instead
      

      

      Sets the custom timestamp field 1.
      

      

      Parameters:
      

      customTimestampField1 - the custom timestamp field 1. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomTimestampField1 PERMISSION OR OWNS CaseWriteCustomTimestampField1@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomTimestampField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getCustomTimestampField2()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField2").getOrNull() instead
      

      

      Gets the custom timestamp field 2. Maybe null.
      

      

      Returns:
      

      the custom timestamp field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomTimestampField2 PERMISSION OR OWNS CaseReadCustomTimestampField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomTimestampField2
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomTimestampField2(Date customTimestampField2)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField2").set(customTimestampField2) instead
      

      

      Sets the custom timestamp field 2.
      

      

      Parameters:
      

      customTimestampField2 - the custom timestamp field 2. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomTimestampField2 PERMISSION OR OWNS CaseWriteCustomTimestampField2@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomTimestampField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getCustomTimestampField3()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField3").getOrNull() instead
      

      

      Gets the custom timestamp field 3. Maybe null.
      

      

      Returns:
      

      the custom timestamp field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomTimestampField3 PERMISSION OR OWNS CaseReadCustomTimestampField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomTimestampField3
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomTimestampField3(Date customTimestampField3)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField3").set(customTimestampField3) instead
      

      

      Sets the custom timestamp field 3.
      

      

      Parameters:
      

      customTimestampField3 - the custom timestamp field 3. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomTimestampField3 PERMISSION OR OWNS CaseWriteCustomTimestampField3@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomTimestampField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getCustomTimestampField4()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField4").getOrNull() instead
      

      

      Gets the custom timestamp field 4. Maybe null.
      

      

      Returns:
      

      the custom timestamp field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomTimestampField4 PERMISSION OR OWNS CaseReadCustomTimestampField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomTimestampField4
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomTimestampField4(Date customTimestampField4)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField4").set(customTimestampField4) instead
      

      

      Sets the custom timestamp field 4.
      

      

      Parameters:
      

      customTimestampField4 - the custom timestamp field 4. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomTimestampField4 PERMISSION OR OWNS CaseWriteCustomTimestampField4@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getCustomTimestampField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
Date getCustomTimestampField5()
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField5").getOrNull() instead
      

      

      Gets the custom timestamp field 5. Maybe null.
      

      

      Returns:
      

      the custom timestamp field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseReadCustomTimestampField5 PERMISSION OR OWNS CaseReadCustomTimestampField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      setCustomTimestampField5
      

      @Deprecated(since="7.3",
            forRemoval=true)
void setCustomTimestampField5(Date customTimestampField5)
      

      Deprecated, for removal: This API element is subject to removal in a future version.

      use customFields().timestampField("CustomTimestampField5").set(customTimestampField5) instead
      

      

      Sets the custom timestamp field 5.
      

      

      Parameters:
      

      customTimestampField5 - the custom timestamp field 5. Maybe null.
      


      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseWriteCustomTimestampField5 PERMISSION OR OWNS CaseWriteCustomTimestampField5@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      destroy
      

      void destroy()
      

      Destroys this case and all tasks that belongs to the case
      

      

      API:
      

      This public API is available in Java.
      


      Security:
      

      SESSION OWNS CaseDestroy PERMISSION OR OWNS CaseDestroy@SYSTEM PERMISSION
      

      

      

      • 

    • 

      

      getBusinessCalendar
      

      IDefaultBusinessCalendar getBusinessCalendar()
      

      The IBusinessCalendar used for this case. Never null
      

      

      Returns:
      

      never null
      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      setBusinessCalendar
      

      void setBusinessCalendar(IBusinessCalendar calendar)
      

      Defines the IBusinessCalendar for this ICase.
 This influences the IDefaultBusinessCalendar determination when calling ivy.cal.
      

      

      Parameters:
      

      calendar - may be null.
      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      documents
      

      IDocumentService documents()
      

      Returns a service for managing documents that are attached to the case.
 
      Examples:
      
 
      Add a document to a case:
      
 
 IDocument document = ivy.case.documents().add(new Path("images/myImage.png")).write().withContentFrom(in.file);
 
 
      
 
      
 Get all documents attached to a case:
      
 
 List<IDocument> documents = ivy.case.documents().getAll();
 
 
      

      

      Returns:
      

      case document service
      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      current
      

      static ICase current()
      

      Gets the current case.
      
 
      Will return null if called out of scope. E.g. if no case is available in the current context
      

      

      Returns:
      

      current case or null if out of scope
      

      Since:
      

      9.1
      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    • 

      

      getDetailLink
      

      WebLink getDetailLink()
      

      Gets the detail link of this case.
      

      

      Returns:
      

      WebLink
      


      API:
      

      This public API is available in Java.
      

      

      

      • 

    

    

    •