oracle.bpm.casemgmt
Interface ICaseMetadataService

All Known Subinterfaces:

ICaseService

public interface ICaseMetadataService

Defines all APIs related to metadata service

Nested Class Summary

static class	ICaseMetadataService.SEARCH_TYPE_ENUM
static class	ICaseMetadataService.TRANSLATABLES_ENUM

Method Summary

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]
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.List<oracle.bpm.casemgmt.caseactivity.model.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<oracle.bpm.casemgmt.casemetadata.model.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

Method Detail

getCaseMetadataDisplayValues

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

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

Parameters:

ctx - - a valid bpm context

caseDefinitionId - - case definition id of the form [applicationName/compsiteName!version/caseName]

translatableEnum - - parameter to specify which part(s) of case metadata should be translated

locale - - locale in which the display name is required

Returns:

Throws:

CaseServiceException

getCaseMetadata

CaseMetadata getCaseMetadata(IBPMContext ctx,
                             java.lang.String caseDefinitionId)
                             throws CaseServiceException

This api retrieves the deployed case metadata identified by case definition id of the form [applicationName/compsiteName!version/caseName]

Parameters:

ctx - - a valid bpm context

caseDefinitionId - - of the form [applicationName/compsiteName!version/caseName]

Returns:

Throws:

CaseServiceException

listCaseDefinition

java.util.List<oracle.bpm.casemgmt.casemetadata.model.CaseDefinition> listCaseDefinition(IBPMContext ctx,
                                                                                         ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum,
                                                                                         java.util.List values)
                                                                                         throws CaseServiceException

This api returns a list of case entity definition that matches the search criteria

Parameters:

ctx - - a valid bpm context

searchByEnum - - is one of

SEARCH_TYPE_ENUM.ALL

SEARCH_TYPE_ENUM.NAMESPACE

SEARCH_TYPE_ENUM.NAME

SEARCH_TYPE_ENUM.CATEGORY

SEARCH_TYPE_ENUM.ACTIVITY_DEFINITION_ID

SEARCH_TYPE_ENUM.CASE_DEFINITION_ID

values -

Returns:

Throws:

CaseServiceException

getCaseActivityMetadata

CaseActivity getCaseActivityMetadata(IBPMContext ctx,
                                     java.lang.String activityDefinitionId)
                                     throws CaseServiceException

This api retrieves the deployed case activity metadata identified by definition id of the form [applicationName/compsiteName!version/activityName]

Parameters:

ctx - - a valid bpm context

activityDefinitionId - - of the form [applicationName/compsiteName!version/activityName]

Returns:

Throws:

CaseServiceException

listCaseActivityDefinition

java.util.List<oracle.bpm.casemgmt.caseactivity.model.CaseActivityDefinition> listCaseActivityDefinition(IBPMContext ctx,
                                                                                                         ICaseMetadataService.SEARCH_TYPE_ENUM searchByEnum,
                                                                                                         java.util.List values)
                                                                                                         throws CaseServiceException

This api returns a list of case entity definition that matches the search criteria

Parameters:

ctx - - a valid bpm context

searchByEnum - - is one of

SEARCH_TYPE_ENUM.ALL

SEARCH_TYPE_ENUM.CATEGORY

SEARCH_TYPE_ENUM.ACTIVITY_DEFINITION_ID

values -

Returns:

Throws:

CaseServiceException