Interface ICaseMapService
-
public interface ICaseMapService
TheICaseMapService
is the entry point to the case map related public API.- Since:
- 6.7
- API:
- This is a public API.
-
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description static ICaseMapService
current()
Gets the current case map service.ICaseMapFinder
find()
Returns a case map finder, which can be used to find a case map.ICaseMap
findCaseMap()
IStage
findCurrentStage()
Get the current stage of the business caseList<IStartableSideStep>
findStartableSideSteps()
Gets the startable sidesteps for the given business case and user combinationICaseMapService
getCaseMapService(IBusinessCase businessCase)
Get the case map service for the given contextICaseMapService
getCaseMapService(IBusinessCase businessCase, IUserToken userToken)
Get the case map service for the given context
-
-
-
Method Detail
-
current
static ICaseMapService current()
Gets the current case map service.
Will return null if called out of scope. The scope is set if you call this method from an ivy process or any supported ivy environment. It is not set in non supported ivy environments (e.g. if you start your own threads, etc.).
- Returns:
- current case map service or null if out of scope
- API:
- This public API is available in IvyScript and Java. It has the visibility EXPERT.
-
getCaseMapService
ICaseMapService getCaseMapService(IBusinessCase businessCase)
Get the case map service for the given contextExample: Get all stages of a case map:
import ch.ivyteam.ivy.workflow.businesscase.IBusinessCase; import ch.ivyteam.ivy.casemap.runtime.model.IStage; IBusinessCase myBusinessCase = ...; List<IStage> stages = ivy.casemap.getCaseMapService(myBusinessCase).findCaseMap().getStages();
- Parameters:
businessCase
-- Returns:
- case map service of the given business case
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
getCaseMapService
ICaseMapService getCaseMapService(IBusinessCase businessCase, IUserToken userToken)
Get the case map service for the given contextExample: Get all stages of a case map:
import ch.ivyteam.ivy.workflow.businesscase.IBusinessCase; import ch.ivyteam.ivy.casemap.runtime.model.IStage; IBusinessCase myBusinessCase = ...; List<IStage> stages = ivy.casemap.getCaseMapService(myBusinessCase, ivy.session.getSessionUser().getUserToken()).findCaseMap().getStages();
- Parameters:
businessCase
-userToken
-- Returns:
- case map service of the given business case
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
findCaseMap
@Deprecated ICaseMap findCaseMap()
Get the case map of the business caseIf you want to change the context:
Example:
import ch.ivyteam.ivy.casemap.runtime.model.ICaseMap; ICaseMap caseMap = ivy.casemap.findCaseMap();
- Returns:
- case map of the business case,
null
if business case has no case map - API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
find
ICaseMapFinder find()
Returns a case map finder, which can be used to find a case map. Example:import ch.ivyteam.ivy.casemap.runtime.model.ICaseMap; ICaseMap caseMap = ivy.casemap.find().byPath("Case Maps/MyCaseMap");
- Returns:
- case map finder, never
null
- Since:
- 7.2
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
findCurrentStage
IStage findCurrentStage()
Get the current stage of the business caseIf you want to change the context:
Example:
import ch.ivyteam.ivy.casemap.runtime.model.IStage; IStage stage = ivy.casemap.findCurrentStage();
- Returns:
- stage of the business case,
null
if business case has no case map - API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
findStartableSideSteps
List<IStartableSideStep> findStartableSideSteps()
Gets the startable sidesteps for the given business case and user combinationIf you want to change the context:
Example:
import ch.ivyteam.ivy.casemap.runtime.model.IStartableSideStep; List<IStartableSideStep> sideSteps = ivy.casemap.findStartableSideSteps();
- Returns:
- startable sidesteps for the given context
- API:
- This public API is available in IvyScript and Java. It has the visibility ADVANCED.
-
-