curam.core.facade.intf

Interface Representative

All Known Implementing Classes:

Representative, curam.core.facade.impl.Representative, RepresentativeFactory

@AccessLevel(value=EXTERNAL)
public interface Representative

Manipulates information for the Representative entity.

Method Summary

Modifier and Type	Method and Description
curam.core.facade.struct.InformationalMsgDetailsList	modifyRepresentative(curam.core.facade.struct.RepresentativeSummaryDetails representativeSummaryDetails) Method to modify a Representative's details.
curam.core.facade.struct.ReadByAlternateIDDetails	readByAlternateID(curam.core.facade.struct.RepresentativeAlternateIDKey representativeAlternateIDKey) Method to check if there is a Representative registered with a specific alternateID.
curam.core.facade.struct.RepresentativeContextDescriptionDetails	readRepresentativeContextDescription(curam.core.facade.struct.RepresentativeContextKey representativeContextKey) Method to return a context description for a Representative.
curam.core.facade.struct.RepresentativeID	registerRepresentative(curam.core.facade.struct.RepresentativeRegistrationDetails representativeRegistrationDetails) Method to register a Representative to the organization.
curam.core.facade.struct.RepresentativeList	search(curam.core.facade.struct.RepresentativeSearchKey key) Method to search for Representatives matching the search criteria.
curam.core.facade.struct.RepresentativeHomePageDetails	viewRepresentativeHomePage(curam.core.facade.struct.RepresentativeKey representativeKey) Method to view a Representative's Homepage details.

Method Detail

registerRepresentative

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RepresentativeID registerRepresentative(curam.core.facade.struct.RepresentativeRegistrationDetails representativeRegistrationDetails)
                                                                                       throws curam.util.exception.AppException,
                                                                                              curam.util.exception.InformationalException

Method to register a Representative to the organization.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

viewRepresentativeHomePage

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RepresentativeHomePageDetails viewRepresentativeHomePage(curam.core.facade.struct.RepresentativeKey representativeKey)
                                                                                                        throws curam.util.exception.AppException,
                                                                                                               curam.util.exception.InformationalException

Method to view a Representative's Homepage details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

modifyRepresentative

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.InformationalMsgDetailsList modifyRepresentative(curam.core.facade.struct.RepresentativeSummaryDetails representativeSummaryDetails)
                                                                                                throws curam.util.exception.AppException,
                                                                                                       curam.util.exception.InformationalException

Method to modify a Representative's details.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readRepresentativeContextDescription

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RepresentativeContextDescriptionDetails readRepresentativeContextDescription(curam.core.facade.struct.RepresentativeContextKey representativeContextKey)
                                                                                                                            throws curam.util.exception.AppException,
                                                                                                                                   curam.util.exception.InformationalException

Method to return a context description for a Representative.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

readByAlternateID

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadByAlternateIDDetails readByAlternateID(curam.core.facade.struct.RepresentativeAlternateIDKey representativeAlternateIDKey)
                                                                                          throws curam.util.exception.AppException,
                                                                                                 curam.util.exception.InformationalException

Method to check if there is a Representative registered with a specific alternateID.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

search

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.RepresentativeList search(curam.core.facade.struct.RepresentativeSearchKey key)
                                                                         throws curam.util.exception.AppException,
                                                                                curam.util.exception.InformationalException

Method to search for Representatives matching the search criteria. Called from application processing.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException