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

- Packages that use CaseFileInstance
  Package | Description
  --- | ---
  org.jbpm.casemgmt.api |
  org.jbpm.casemgmt.api.auth |
  org.jbpm.casemgmt.api.event |
  org.jbpm.casemgmt.api.model.instance |
  org.jbpm.casemgmt.impl |
  org.jbpm.casemgmt.impl.command |
  org.jbpm.casemgmt.impl.event |
  org.jbpm.casemgmt.impl.model.instance |
  org.jbpm.casemgmt.impl.wih |

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

    Methods in org.jbpm.casemgmt.api that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `CaseFileInstance` | CaseService.`getCaseFileInstance(String caseId)` Returns Case file for give case id
    `CaseFileInstance` | CaseService.`newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data)` Builds and returns new CaseFileInstance with given data.
    `CaseFileInstance` | CaseService.`newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment)` Builds and returns new CaseFileInstance with given data and roles assignments.
    `CaseFileInstance` | CaseService.`newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,List<String>> accessRestrictions)` Builds and returns new CaseFileInstance with given data.
    `CaseFileInstance` | CaseService.`newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment, Map<String,List<String>> accessRestrictions)` Builds and returns new CaseFileInstance with given data and roles assignments.

    Methods in org.jbpm.casemgmt.api with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `String` | CaseService.`startCase(String deploymentId, String caseDefinitionId, CaseFileInstance caseFile)` Starts a new case for given definition with given case file.

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.api.auth

    Methods in org.jbpm.casemgmt.api.auth with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthorizationManager.`checkCommentAuthorization(String caseId, CaseFileInstance caseFileInstance, CommentInstance commentInstance)` Check if caller (based on identity provider) is authorized to manipulate given comment
    `void` | AuthorizationManager.`checkDataAuthorization(String caseId, CaseFileInstance caseFileInstance, Collection<String> dataNames)` Check if caller (based on identity provider) is authorized to manipulate given data
    `List<CommentInstance>` | AuthorizationManager.`filterByCommentAuthorization(String caseId, CaseFileInstance caseFileInstance, List<CommentInstance> comments)` Filters provided comments by their restrictions.
    `Map<String,Object>` | AuthorizationManager.`filterByDataAuthorization(String caseId, CaseFileInstance caseFileInstance, Map<String,Object> data)` Filters provided data by data restrictions.

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.api.event

    Methods in org.jbpm.casemgmt.api.event that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `CaseFileInstance` | CaseStartEvent.`getCaseFile()` Returns case file associated with the case
    `CaseFileInstance` | CaseEvent.`getCaseFile()`

    Constructors in org.jbpm.casemgmt.api.event with parameters of type CaseFileInstance
    Constructor and Description
    `CaseCancelEvent(String user, String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `CaseCloseEvent(String user, String caseId, CaseFileInstance caseFile, String comment)`
    `CaseCommentEvent(String user, String caseId, CaseFileInstance caseFile, CommentInstance comment)`
    `CaseDataEvent(String user, String caseId, CaseFileInstance caseFile, String definitionId, Map<String,Object> data)`
    `CaseDestroyEvent(String user, String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `CaseDynamicSubprocessEvent(String user, String caseId, CaseFileInstance caseFile, String processId, Map<String,Object> data, long processInstanceId)`
    `CaseDynamicSubprocessEvent(String user, String caseId, CaseFileInstance caseFile, String processId, Map<String,Object> data, long processInstanceId, long subProcessInstanceId)`
    `CaseDynamicTaskEvent(String user, String caseId, CaseFileInstance caseFile, String nodeType, Map<String,Object> data, long processInstanceId)`
    `CaseEvent(String user, String caseId, CaseFileInstance caseFile)`
    `CaseReopenEvent(String user, String caseId, CaseFileInstance caseFile, String deploymentId, String caseDefinitionId, Map<String,Object> data)`
    `CaseReopenEvent(String user, String caseId, CaseFileInstance caseFile, String deploymentId, String caseDefinitionId, Map<String,Object> data, Long processInstanceId)`
    `CaseRoleAssignmentEvent(String user, String caseId, CaseFileInstance caseFile, String role, org.kie.api.task.model.OrganizationalEntity entity)`
    `CaseStartEvent(String user, String caseId, String deploymentId, String caseDefinitionId, CaseFileInstance caseFile)`
    `CaseStartEvent(String user, String caseId, String deploymentId, String caseDefinitionId, CaseFileInstance caseFile, Long processInstanceId)`

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.api.model.instance

    Methods in org.jbpm.casemgmt.api.model.instance that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `CaseFileInstance` | CaseInstance.`getCaseFile()` Returns case file associated with this case.

    Methods in org.jbpm.casemgmt.api.model.instance with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | CaseInstance.`setCaseFile(CaseFileInstance caseFileInstance)` Sets case file information to this instance

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

    Methods in org.jbpm.casemgmt.impl that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `CaseFileInstance` | CaseServiceImpl.`getCaseFileInstance(String caseId)`
    `protected CaseFileInstance` | CaseServiceImpl.`internalGetCaseFileInstance(String caseId, String deploymentId)`
    `CaseFileInstance` | CaseServiceImpl.`newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data)`
    `CaseFileInstance` | CaseServiceImpl.`newCaseFileInstance(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment)`
    `CaseFileInstance` | CaseServiceImpl.`newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,List<String>> accessRestrictions)`
    `CaseFileInstance` | CaseServiceImpl.`newCaseFileInstanceWithRestrictions(String deploymentId, String caseDefinition, Map<String,Object> data, Map<String,org.kie.api.task.model.OrganizationalEntity> rolesAssignment, Map<String,List<String>> accessRestrictions)`

    Methods in org.jbpm.casemgmt.impl with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | AuthorizationManagerImpl.`checkCommentAuthorization(String caseId, CaseFileInstance caseFileInstance, CommentInstance commentInstance)`
    `void` | AuthorizationManagerImpl.`checkDataAuthorization(String caseId, CaseFileInstance caseFileInstance, Collection<String> dataNames)`
    `List<CommentInstance>` | AuthorizationManagerImpl.`filterByCommentAuthorization(String caseId, CaseFileInstance caseFileInstance, List<CommentInstance> comments)`
    `Map<String,Object>` | AuthorizationManagerImpl.`filterByDataAuthorization(String caseId, CaseFileInstance caseFileInstance, Map<String,Object> data)`
    `protected List<String>` | AuthorizationManagerImpl.`getCallerRoles(CaseFileInstance caseFileInstance, List<String> callerAuthorization)`
    `String` | CaseServiceImpl.`startCase(String deploymentId, String caseDefinitionId, CaseFileInstance caseFile)`

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.impl.command

    Methods in org.jbpm.casemgmt.impl.command that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `protected CaseFileInstance` | CaseCommand.`getCaseFile(org.kie.api.runtime.KieSession ksession, String caseId)`

    Constructors in org.jbpm.casemgmt.impl.command with parameters of type CaseFileInstance
    Constructor and Description
    `StartCaseCommand(org.kie.internal.identity.IdentityProvider identityProvider, String caseId, String deploymentId, String caseDefinitionId, CaseFileInstance caseFile, ProcessService processService)`

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.impl.event

    Methods in org.jbpm.casemgmt.impl.event with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | CaseEventSupport.`fireAfterCaseCancelled(String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `void` | CaseEventSupport.`fireAfterCaseClosed(String caseId, CaseFileInstance caseFile, String comment)`
    `void` | CaseEventSupport.`fireAfterCaseCommentAdded(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireAfterCaseCommentRemoved(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireAfterCaseCommentUpdated(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireAfterCaseDataAdded(String caseId, CaseFileInstance caseFile, String definitionId, Map<String,Object> data)`
    `void` | CaseEventSupport.`fireAfterCaseDataRemoved(String caseId, CaseFileInstance caseFile, String definitionId, Map<String,Object> data)`
    `void` | CaseEventSupport.`fireAfterCaseDestroyed(String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `void` | CaseEventSupport.`fireAfterCaseReopened(String caseId, CaseFileInstance caseFile, String deploymentId, String caseDefinitionId, Map<String,Object> data, long processInstanceId)`
    `void` | CaseEventSupport.`fireAfterCaseRoleAssignmentAdded(String caseId, CaseFileInstance caseFile, String role, org.kie.api.task.model.OrganizationalEntity entity)`
    `void` | CaseEventSupport.`fireAfterCaseRoleAssignmentRemoved(String caseId, CaseFileInstance caseFile, String role, org.kie.api.task.model.OrganizationalEntity entity)`
    `void` | CaseEventSupport.`fireAfterCaseStarted(String caseId, String deploymentId, String caseDefinitionId, CaseFileInstance caseFile, long processInstanceId)`
    `void` | CaseEventSupport.`fireAfterDynamicProcessAdded(String caseId, CaseFileInstance caseFile, long processInstanceId, String processId, Map<String,Object> parameters, long subProcessInstanceId)`
    `void` | CaseEventSupport.`fireAfterDynamicTaskAdded(String caseId, CaseFileInstance caseFile, long processInstanceId, String nodeType, Map<String,Object> parameters)`
    `void` | CaseEventSupport.`fireBeforeCaseCancelled(String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `void` | CaseEventSupport.`fireBeforeCaseClosed(String caseId, CaseFileInstance caseFile, String comment)`
    `void` | CaseEventSupport.`fireBeforeCaseCommentAdded(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireBeforeCaseCommentRemoved(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireBeforeCaseCommentUpdated(String caseId, CaseFileInstance caseFile, CommentInstance commentInstance)`
    `void` | CaseEventSupport.`fireBeforeCaseDataAdded(String caseId, CaseFileInstance caseFile, String definitionId, Map<String,Object> data)`
    `void` | CaseEventSupport.`fireBeforeCaseDataRemoved(String caseId, CaseFileInstance caseFile, String definitionId, Map<String,Object> data)`
    `void` | CaseEventSupport.`fireBeforeCaseDestroyed(String caseId, CaseFileInstance caseFile, List<Long> processInstanceIds)`
    `void` | CaseEventSupport.`fireBeforeCaseReopened(String caseId, CaseFileInstance caseFile, String deploymentId, String caseDefinitionId, Map<String,Object> data)`
    `void` | CaseEventSupport.`fireBeforeCaseRoleAssignmentAdded(String caseId, CaseFileInstance caseFile, String role, org.kie.api.task.model.OrganizationalEntity entity)`
    `void` | CaseEventSupport.`fireBeforeCaseRoleAssignmentRemoved(String caseId, CaseFileInstance caseFile, String role, org.kie.api.task.model.OrganizationalEntity entity)`
    `void` | CaseEventSupport.`fireBeforeCaseStarted(String caseId, String deploymentId, String caseDefinitionId, CaseFileInstance caseFile)`
    `void` | CaseEventSupport.`fireBeforeDynamicProcessAdded(String caseId, CaseFileInstance caseFile, long processInstanceId, String processId, Map<String,Object> parameters)`
    `void` | CaseEventSupport.`fireBeforeDynamicTaskAdded(String caseId, CaseFileInstance caseFile, long processInstanceId, String nodeType, Map<String,Object> parameters)`

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

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

    Methods in org.jbpm.casemgmt.impl.model.instance that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `CaseFileInstance` | CaseInstanceImpl.`getCaseFile()`

    Methods in org.jbpm.casemgmt.impl.model.instance with parameters of type CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `void` | CaseInstanceImpl.`setCaseFile(CaseFileInstance caseFile)`

    Constructors in org.jbpm.casemgmt.impl.model.instance with parameters of type CaseFileInstance
    Constructor and Description
    `CaseInstanceImpl(String caseId, String caseDescription, Collection<CaseStageInstance> caseStages, Collection<CaseMilestoneInstance> caseMilestones, Collection<CaseRoleInstance> caseRoles, CaseFileInstance caseFile)`

  - ### Uses of CaseFileInstance in org.jbpm.casemgmt.impl.wih

    Methods in org.jbpm.casemgmt.impl.wih that return CaseFileInstance
    Modifier and Type | Method and Description
    --- | ---
    `protected CaseFileInstance` | StartProcessSLAViolationListener.`getCaseFile(org.kie.api.runtime.KieSession ksession)`
    `protected CaseFileInstance` | StartCaseWorkItemHandler.`getCaseFile(org.kie.api.runtime.KieSession ksession)`
    `protected CaseFileInstance` | NotifyParentCaseEventListener.`getCaseFile(org.kie.api.runtime.KieSession ksession)`
    `protected CaseFileInstance` | NotifyOwnerSLAViolationListener.`getCaseFile(org.kie.api.runtime.KieSession ksession)`
    `protected CaseFileInstance` | EscalateToAdminSLAViolationListener.`getCaseFile(org.kie.api.runtime.KieSession ksession)`

Copyright © 2001–2021 JBoss by Red Hat. All rights reserved.