curam.core.facade.intf

Interface InformationProvider

All Known Implementing Classes:

InformationProvider, curam.core.facade.impl.InformationProvider, InformationProviderFactory

@AccessLevel(value=EXTERNAL)
public interface InformationProvider

This process class provides the functionality for the Information Provider presentation layer.

Method Summary

Modifier and Type	Method and Description
curam.core.struct.CuramInd	isEducationalInstitute(curam.core.facade.struct.MaintainConcernRoleKey concernRoleKey) Return true if the concern role ID given is for an Information Provider that is an Educational Institute.
curam.core.facade.struct.ModifyInformationProviderReturnDetails	modifyInformationProviderDetails(curam.core.facade.struct.ModifyInformationProviderDetails details) Updates an information provider with modified details.
curam.core.facade.struct.ReadInformationProviderHomePageDetails	readHomePageDetails(curam.core.facade.struct.ReadInformationProviderHomeKey key) Called to retrieve details to be displayed on the information provider home page.
curam.core.facade.struct.ReadInformationProviderDetails	readInformationProviderDetails(curam.core.facade.struct.ReadInformationProviderDetailsKey key) Retrieves details of the specified information provider.
curam.core.facade.struct.InformationProviderRegistrationResult	register(curam.core.facade.struct.InformationProviderRegistrationDetails details) Called to register a new information provider.
curam.core.facade.struct.ParticipantSearchDetails	searchInformationProvider(curam.core.facade.struct.ParticipantSearchKey key) Searches for an Information Provider by specified search criteria.

Method Detail

register

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationProviderRegistrationResult register(curam.core.facade.struct.InformationProviderRegistrationDetails details)
                                                                                              throws curam.util.exception.AppException,
                                                                                                     curam.util.exception.InformationalException

Called to register a new information provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readHomePageDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadInformationProviderHomePageDetails readHomePageDetails(curam.core.facade.struct.ReadInformationProviderHomeKey key)
                                                                                                          throws curam.util.exception.AppException,
                                                                                                                 curam.util.exception.InformationalException

Called to retrieve details to be displayed on the information provider home page.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readInformationProviderDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadInformationProviderDetails readInformationProviderDetails(curam.core.facade.struct.ReadInformationProviderDetailsKey key)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Retrieves details of the specified information provider.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyInformationProviderDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifyInformationProviderReturnDetails modifyInformationProviderDetails(curam.core.facade.struct.ModifyInformationProviderDetails details)
                                                                                                                       throws curam.util.exception.AppException,
                                                                                                                              curam.util.exception.InformationalException

Updates an information provider with modified details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

searchInformationProvider

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantSearchDetails searchInformationProvider(curam.core.facade.struct.ParticipantSearchKey key)
                                                                                                  throws curam.util.exception.AppException,
                                                                                                         curam.util.exception.InformationalException

Searches for an Information Provider by specified search criteria.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

isEducationalInstitute

@AccessLevel(value=EXTERNAL)
curam.core.struct.CuramInd isEducationalInstitute(curam.core.facade.struct.MaintainConcernRoleKey concernRoleKey)
                                                                        throws curam.util.exception.AppException,
                                                                               curam.util.exception.InformationalException

Return true if the concern role ID given is for an Information Provider that is an Educational Institute.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException