public interface ICaseMetadataService
Modifier and Type | Interface and Description |
---|---|
static class |
ICaseMetadataService.FORM_TYPE |
static class |
ICaseMetadataService.SEARCH_TYPE_ENUM |
static class |
ICaseMetadataService.TRANSLATABLES_ENUM |
Modifier and Type | Method and Description |
---|---|
int |
deleteCaseForm(IBPMContext ctx, java.lang.String caseNamespace, java.lang.String caseArtificatName, java.lang.String compositeVersion, java.lang.String partitionName, ICaseMetadataService.FORM_TYPE formType) |
CaseActivity |
getCaseActivityMetadata(IBPMContext ctx, java.lang.String activityDefinitionId)
This api retrieves the deployed case activity metadata identified by definition id of the form [applicationName/compsiteName!version/activityName]
|
java.util.List<TCaseDisplayInfo> |
getCaseDisplayForm(IBPMContext ctx, java.lang.String caseDefinitionNamespace, java.lang.String caseArtifactName, java.lang.String compositeVersion, java.lang.String partitionName, java.lang.String applicationName, java.lang.String formName, ICaseMetadataService.FORM_TYPE formType) |
CaseMetadata |
getCaseMetadata(IBPMContext ctx, java.lang.String caseDefinitionId)
This api retrieves the deployed case metadata identified by case definition id of the form [applicationName/compsiteName!version/caseName]
|
java.util.Map<java.lang.String,java.lang.String> |
getCaseMetadataDisplayValues(IBPMContext ctx, java.lang.String caseDefinitionId, ICaseMetadataService.TRANSLATABLES_ENUM translatableEnum, java.util.Locale locale)
This method returns a mapping between the name and display name of case metadata translatable elements like case name, milestone name, stakeholder name, category, permission tag name and outcomes, in the specified locale
|
java.util.Map<java.lang.String,FlexFieldColumn> |
getCaseMetadataFlexFieldMapping(IBPMContext ctx, java.lang.String caseDefinitionId)
This method returns a mapping between the flex field name and column info in the database
|
java.util.List<CaseActivityDefinition> |
listCaseActivityDefinition(IBPMContext ctx, ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum, java.util.List values)
This api returns a list of case entity definition that matches the search criteria
|
java.util.List<CaseDefinition> |
listCaseDefinition(IBPMContext ctx, ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum, java.util.List values)
This api returns a list of case entity definition that matches the search criteria
|
void |
registerCaseDisplayForm(IBPMContext ctx, java.lang.String caseDefinitionNamespace, java.lang.String caseArtifactName, java.lang.String compositeVersion, java.lang.String partitionName, java.util.List<TCaseDisplayInfo> caseDisplayInfoList, ICaseMetadataService.FORM_TYPE formType) |
int |
unregisterCaseForm(IBPMContext ctx, TCaseDisplayInfo displayInfo) |
java.util.Map<java.lang.String,FlexFieldColumn> getCaseMetadataFlexFieldMapping(IBPMContext ctx, java.lang.String caseDefinitionId) throws CaseServiceException
ctx
- - a valid bpm contextcaseDefinitionId
- - case definition id of the form [applicationName/compsiteName!version/caseName]CaseServiceException
java.util.Map<java.lang.String,java.lang.String> getCaseMetadataDisplayValues(IBPMContext ctx, java.lang.String caseDefinitionId, ICaseMetadataService.TRANSLATABLES_ENUM translatableEnum, java.util.Locale locale) throws CaseServiceException
ctx
- - a valid bpm contextcaseDefinitionId
- - case definition id of the form [applicationName/compsiteName!version/caseName]translatableEnum
- - parameter to specify which part(s) of case metadata should be translatedlocale
- - locale in which the display name is requiredCaseServiceException
CaseMetadata getCaseMetadata(IBPMContext ctx, java.lang.String caseDefinitionId) throws CaseServiceException
ctx
- - a valid bpm contextcaseDefinitionId
- - of the form [applicationName/compsiteName!version/caseName]CaseServiceException
java.util.List<CaseDefinition> listCaseDefinition(IBPMContext ctx, ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum, java.util.List values) throws CaseServiceException
ctx
- - a valid bpm contextsearchByEnum
- - is one of
values
-CaseServiceException
CaseActivity getCaseActivityMetadata(IBPMContext ctx, java.lang.String activityDefinitionId) throws CaseServiceException
ctx
- - a valid bpm contextactivityDefinitionId
- - of the form [applicationName/compsiteName!version/activityName]CaseServiceException
java.util.List<CaseActivityDefinition> listCaseActivityDefinition(IBPMContext ctx, ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum, java.util.List values) throws CaseServiceException
ctx
- - a valid bpm contextsearchByEnum
- - is one of
values
-CaseServiceException
void registerCaseDisplayForm(IBPMContext ctx, java.lang.String caseDefinitionNamespace, java.lang.String caseArtifactName, java.lang.String compositeVersion, java.lang.String partitionName, java.util.List<TCaseDisplayInfo> caseDisplayInfoList, ICaseMetadataService.FORM_TYPE formType) throws CaseServiceException
CaseServiceException
java.util.List<TCaseDisplayInfo> getCaseDisplayForm(IBPMContext ctx, java.lang.String caseDefinitionNamespace, java.lang.String caseArtifactName, java.lang.String compositeVersion, java.lang.String partitionName, java.lang.String applicationName, java.lang.String formName, ICaseMetadataService.FORM_TYPE formType) throws CaseServiceException
CaseServiceException
int deleteCaseForm(IBPMContext ctx, java.lang.String caseNamespace, java.lang.String caseArtificatName, java.lang.String compositeVersion, java.lang.String partitionName, ICaseMetadataService.FORM_TYPE formType) throws CaseServiceException
CaseServiceException
int unregisterCaseForm(IBPMContext ctx, TCaseDisplayInfo displayInfo) throws CaseServiceException
CaseServiceException