## Uses of Interface
org.jbpm.casemgmt.api.model.instance.CaseInstance

- Packages that use CaseInstance
  Package | Description
  --- | ---
  org.jbpm.casemgmt.api |
  org.jbpm.casemgmt.impl |
  org.jbpm.casemgmt.impl.model.instance |

- - ### Uses of CaseInstance in org.jbpm.casemgmt.api

    Methods in org.jbpm.casemgmt.api that return CaseInstance
    Modifier and Type | Method | Description
    --- | --- | ---
    `CaseInstance` | CaseService.`getCaseInstance​(String caseId)` | Returns case instance (only if it's active) identified by given case id - does not load case file, roles, milestones nor stages.
    `CaseInstance` | CaseService.`getCaseInstance​(String caseId, boolean withData, boolean withRoles, boolean withMilestones, boolean withStages)` | Returns case instance (only if it's active) identified by given case id with options on what should be fetched
    `CaseInstance` | CaseRuntimeDataService.`getCaseInstanceById​(String caseId)` | Returns case instance for given case id if the caller of this class is authorized to see the case instance

    Methods in org.jbpm.casemgmt.api that return types with arguments of type CaseInstance
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getAllDescendantSubCaseInstancesByParentCaseId​(String parentCaseId, List<CaseStatus> statuses)` | Returns all subtree cases given an parent id case.
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstances​(boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstances​(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstances​(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstances​(org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesAnyRole​(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns case instances that given user (via identity provider) is involved in in any role.
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesAnyRole​(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns case instances that given user (via identity provider) is involved in in any role.
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDataItem​(String dataItemName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses and has case file data item with given name
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDataItem​(String dataItemName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses and has case file data item with given name
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDataItemAndValue​(String dataItemName, String dataItemValue, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses and has case file data item with given name and value
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDataItemAndValue​(String dataItemName, String dataItemValue, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available active case instances that match given statuses and has case file data item with given name and value
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDefinition​(String caseDefinitionId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available case instances;
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDefinition​(String caseDefinitionId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available case instances;
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDeployment​(String deploymentId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available case instances;
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByDeployment​(String deploymentId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all available case instances;
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByRole​(String roleName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns cases instances that given user (via identity provider) has access to with given role.
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesByRole​(String roleName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns cases instances that given user (via identity provider) has access to with given role.
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesOwnedBy​(String owner, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all case instances owned by given user
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getCaseInstancesOwnedBy​(String owner, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all case instances owned by given user
    `Collection<CaseInstance>` | CaseRuntimeDataService.`getSubCaseInstancesByParentCaseId​(String parentCaseId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` | Returns all first level children cases given an parent id case.

  - ### Uses of CaseInstance in org.jbpm.casemgmt.impl

    Methods in org.jbpm.casemgmt.impl that return CaseInstance
    Modifier and Type | Method | Description
    --- | --- | ---
    `CaseInstance` | CaseServiceImpl.`getCaseInstance​(String caseId)` |
    `CaseInstance` | CaseServiceImpl.`getCaseInstance​(String caseId, boolean withData, boolean withRoles, boolean withMilestones, boolean withStages)` |
    `CaseInstance` | CaseRuntimeDataServiceImpl.`getCaseInstanceById​(String caseId)` |

    Methods in org.jbpm.casemgmt.impl that return types with arguments of type CaseInstance
    Modifier and Type | Method | Description
    --- | --- | ---
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getAllDescendantSubCaseInstancesByParentCaseId​(String parentCaseId, List<CaseStatus> statuses)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstances​(boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstances​(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstances​(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstances​(org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesAnyRole​(List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesAnyRole​(List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDataItem​(String dataItemName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDataItem​(String dataItemName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDataItemAndValue​(String dataItemName, String dataItemValue, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDataItemAndValue​(String dataItemName, String dataItemValue, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDefinition​(String definitionId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDefinition​(String definitionId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDeployment​(String deploymentId, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByDeployment​(String deploymentId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByRole​(String roleName, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesByRole​(String roleName, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesOwnedBy​(String owner, List<CaseStatus> statuses, boolean withData, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getCaseInstancesOwnedBy​(String owner, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |
    `Collection<CaseInstance>` | CaseRuntimeDataServiceImpl.`getSubCaseInstancesByParentCaseId​(String parentCaseId, List<CaseStatus> statuses, org.kie.api.runtime.query.QueryContext queryContext)` |

  - ### Uses of CaseInstance in org.jbpm.casemgmt.impl.model.instance

    Classes in org.jbpm.casemgmt.impl.model.instance that implement CaseInstance
    Modifier and Type | Class | Description
    --- | --- | ---
    `class` | `CaseInstanceImpl` |