Utility (core)

All Known Implementing Classes:

Utility, curam.core.facade.impl.Utility, UtilityFactory
```
@AccessLevel(value=EXTERNAL)
public interface Utility
```
This process class provides the functionality for the Utility presentation layer.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`curam.core.facade.struct.ModifyUtilityReturnDetails`	`modifyUtilityDetails(curam.core.facade.struct.ModifyUtilityDetails details)` Updates a utility with modified details.
`curam.core.facade.struct.ReadUtilityHomePageDetails`	`readHomePageDetails(curam.core.facade.struct.ReadUtilityHomeKey key)` Called to retrieve the details to be displayed on the specified utility home page.
`curam.core.facade.struct.ReadUtilityDetails`	`readUtilityDetails(curam.core.facade.struct.ReadUtilityDetailsKey key)` Retrieves details of the specified utility.
`curam.core.facade.struct.UtilityRegistrationResult`	`registerWithTextBankAccountSortCode(curam.core.facade.struct.UtilityRegistrationWithTextBankAccountSortCodeDetails details)` Called to register a new utility with the organization.
`curam.core.facade.struct.ParticipantSearchResult`	`search1(curam.core.facade.struct.UtilitySearchKey key)` Deprecated. Since Curam 6.0 SP2, replaced with `searchUtility(UtilitySearchKey)` This method is deprecated as informational messages are not returned. This method is replaced by searchUtility(UtilitySearchKey) which returns the informational message along with utility details as well. See release note: CS-09152/CR00290965.
`curam.core.facade.struct.ParticipantSearchDetails`	`searchUtility(curam.core.facade.struct.UtilitySearchKey key)` Searches for an Utility by specified search criteria.

Method Detail

readHomePageDetails

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

Called to retrieve the details to be displayed on the specified utility home page.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

readUtilityDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ReadUtilityDetails readUtilityDetails(curam.core.facade.struct.ReadUtilityDetailsKey key)
                                                                                     throws curam.util.exception.AppException,
                                                                                            curam.util.exception.InformationalException

Retrieves details of the specified utility.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

modifyUtilityDetails

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ModifyUtilityReturnDetails modifyUtilityDetails(curam.core.facade.struct.ModifyUtilityDetails details)
                                                                                               throws curam.util.exception.AppException,
                                                                                                      curam.util.exception.InformationalException

Updates a utility with modified details.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

search1
```
@Deprecated
 @AccessLevel(value=EXTERNAL)
curam.core.facade.struct.ParticipantSearchResult search1(curam.core.facade.struct.UtilitySearchKey key)
                                                                                            throws curam.util.exception.AppException,
                                                                                                   curam.util.exception.InformationalException
```
Deprecated. Since Curam 6.0 SP2, replaced with searchUtility(UtilitySearchKey) This method is deprecated as informational messages are not returned. This method is replaced by searchUtility(UtilitySearchKey) which returns the informational message along with utility details as well. See release note: CS-09152/CR00290965.

Performs a search for service suppliers using the specified search criteria, or performs a database read if the alternate ID is specified. Will not return more records than specified in the UTILITYSEARCHMAX environment variable.

Throws:

curam.util.exception.AppException

curam.util.exception.InformationalException

registerWithTextBankAccountSortCode

@AccessLevel(value=EXTERNAL)
curam.core.facade.struct.UtilityRegistrationResult registerWithTextBankAccountSortCode(curam.core.facade.struct.UtilityRegistrationWithTextBankAccountSortCodeDetails details)
                                                                                                             throws curam.util.exception.AppException,
                                                                                                                    curam.util.exception.InformationalException

Called to register a new utility with the organization.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

searchUtility

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

Searches for an Utility by specified search criteria.

Throws:: curam.util.exception.AppException; curam.util.exception.InformationalException

Interface Utility