curam.evidencebroker.facade.intf

Interface EvidenceBrokerAdmin

All Known Implementing Classes:

EvidenceBrokerAdmin, curam.evidencebroker.facade.impl.EvidenceBrokerAdmin, EvidenceBrokerAdminFactory

@AccessLevel(value=EXTERNAL)
public interface EvidenceBrokerAdmin

This process class provides the functionality for the Evidence Sharing configuration administration presentation layer.

Method Summary

Modifier and Type	Method and Description
curam.evidencebroker.sl.struct.EvidenceBrokerConfigurationDetailsList	getEvidenceSharingConfigDetailsListBySourceAndTarget(curam.evidencebroker.sl.struct.SourceAndTargetKey key) Lists evidence broker configuration details for non-identical sharing type, sharing source and sharing target specified.
curam.evidencebroker.sl.struct.SourceAndTargetNameDetails	getSourceAndTargetCaseCategoryDesc(curam.evidencebroker.sl.struct.SourceAndTargetTypeKey key) Returns source and target case category description for the given source and target case type code.
curam.core.facade.struct.SystemDetailsList	listEvidenceBrokerTargetSystems() This method is intended to be used by administrators for listing target systems of service evidence broker.
curam.core.sl.struct.CaseEvidenceSharingConfigList	listEvidenceSharingConfigSourceAndTarget() Returns evidence broker configuration source and target case type list.
curam.core.sl.struct.SharedEvidenceTypeSourceTargetList	listEvidenceTypesAvailableForSharing(curam.evidencebroker.sl.struct.SourceAndTargetKey key) Lists associated sharable evidence types for given source and target case types.
curam.core.sl.struct.SharedEvidenceTypeDetailsList	listEvidenceTypesForSharing(curam.evidencebroker.sl.struct.SourceAndTargetKey key) Returns sharable evidence common to both source and target case types.
curam.evidencebroker.sl.struct.EvidenceBrokerConfigDetailsList	listIdenticalEvidenceSharingConfig() Returns a list of evidence broker configuration details for identical sharing.
curam.evidencebroker.sl.struct.EvidenceBrokerConfigDetailsList	listNonIdenticalEvidenceSharingConfig() Returns a list of evidence broker configuration details for non-identical sharing.
curam.evidencebroker.sl.struct.EvidenceSharingConfigDetails	readEvidenceSharingConfigDetails(curam.evidencebroker.sl.entity.struct.EvidenceBrokerConfigKey key) Reads evidence broker configuration details.
curam.evidencebroker.sl.struct.EvidenceBrokerConfigSourceAndTargetDetails	selectSourceAndTarget(curam.evidencebroker.sl.struct.SharingPartySourceAndTargetStringDetails key) This method is used to retrieve sharing source and sharing target details from the strings supplied.

Method Detail

selectSourceAndTarget

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.EvidenceBrokerConfigSourceAndTargetDetails selectSourceAndTarget(curam.evidencebroker.sl.struct.SharingPartySourceAndTargetStringDetails key)
                                                                                                                      throws curam.util.exception.AppException,
                                                                                                                             curam.util.exception.InformationalException

This method is used to retrieve sharing source and sharing target details from the strings supplied. The strings supplied represent the 'case types', these stings are validated before the corresponding entity struct is returned.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listIdenticalEvidenceSharingConfig

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.EvidenceBrokerConfigDetailsList listIdenticalEvidenceSharingConfig()
                                                                                                                        throws curam.util.exception.AppException,
                                                                                                                               curam.util.exception.InformationalException

Returns a list of evidence broker configuration details for identical sharing. In identical sharing evidence of the same type is set-up to be shared across different products. The returned list could have wild card record also.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listNonIdenticalEvidenceSharingConfig

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.EvidenceBrokerConfigDetailsList listNonIdenticalEvidenceSharingConfig()
                                                                                                                           throws curam.util.exception.AppException,
                                                                                                                                  curam.util.exception.InformationalException

Returns a list of evidence broker configuration details for non-identical sharing. In non-identical sharing evidence of the different types is set-up to be shared across different products.The returned list could have wild card record also.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidenceSharingConfigSourceAndTarget

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.CaseEvidenceSharingConfigList listEvidenceSharingConfigSourceAndTarget()
                                                                                                                  throws curam.util.exception.AppException,
                                                                                                                         curam.util.exception.InformationalException

Returns evidence broker configuration source and target case type list. The returned list will also have wild card items.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidenceTypesForSharing

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.SharedEvidenceTypeDetailsList listEvidenceTypesForSharing(curam.evidencebroker.sl.struct.SourceAndTargetKey key)
                                                                                                     throws curam.util.exception.AppException,
                                                                                                            curam.util.exception.InformationalException

Returns sharable evidence common to both source and target case types. The returned list could have wild card case type also.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readEvidenceSharingConfigDetails

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.EvidenceSharingConfigDetails readEvidenceSharingConfigDetails(curam.evidencebroker.sl.entity.struct.EvidenceBrokerConfigKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Reads evidence broker configuration details. Returned evidence broker configuration details may have wild card details also.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getSourceAndTargetCaseCategoryDesc

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.SourceAndTargetNameDetails getSourceAndTargetCaseCategoryDesc(curam.evidencebroker.sl.struct.SourceAndTargetTypeKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Returns source and target case category description for the given source and target case type code.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidenceTypesAvailableForSharing

@AccessLevel(value=EXTERNAL)
curam.core.sl.struct.SharedEvidenceTypeSourceTargetList listEvidenceTypesAvailableForSharing(curam.evidencebroker.sl.struct.SourceAndTargetKey key)
                                                                                                                   throws curam.util.exception.AppException,
                                                                                                                          curam.util.exception.InformationalException

Lists associated sharable evidence types for given source and target case types. The source and target case types being passed could be a wild card.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

listEvidenceBrokerTargetSystems

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.SystemDetailsList listEvidenceBrokerTargetSystems()
                                                                                                 throws curam.util.exception.AppException,
                                                                                                        curam.util.exception.InformationalException

This method is intended to be used by administrators for listing target systems of service evidence broker.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

getEvidenceSharingConfigDetailsListBySourceAndTarget

@AccessLevel(value=EXTERNAL)
curam.evidencebroker.sl.struct.EvidenceBrokerConfigurationDetailsList getEvidenceSharingConfigDetailsListBySourceAndTarget(curam.evidencebroker.sl.struct.SourceAndTargetKey key)
                                                                                                                                                 throws curam.util.exception.AppException,
                                                                                                                                                        curam.util.exception.InformationalException

Lists evidence broker configuration details for non-identical sharing type, sharing source and sharing target specified. The returned evidence broker configuration details may have wild card also.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException