org.kuali.rice.kns.service
Interface StateService

All Known Implementing Classes:

StateServiceImpl

public interface StateService

Method Summary

List<State>	findAllStates() get all states in the system-default country
List<State>	findAllStates(String postalCountryCode) get all states in the given country
List<State>	findAllStatesByAltCountryCode(String alternatePostalCountryCode)
State	getByPrimaryId(String postalStateCode) get a state object based on the given state code and default country code.
State	getByPrimaryId(String postalCountryCode, String postalStateCode) get a state object based on the given state code and country code
State	getByPrimaryIdIfNecessary(String postalStateCode, State existingState) get a state object based on the given state code and default country code.
State	getByPrimaryIdIfNecessary(String postalCountryCode, String postalStateCode, State existingState) get a state object based on the given state code and country code.

Method Detail

getByPrimaryId

State getByPrimaryId(String postalStateCode)

get a state object based on the given state code and default country code. The default country code is set up in the system.

Parameters:

postalStateCode - the given state code

Returns:

a state object based on the given state code and default country code

getByPrimaryId

State getByPrimaryId(String postalCountryCode,
                     String postalStateCode)

get a state object based on the given state code and country code

Parameters:

postalCountryCode - the given country code

postalStateCode - the given state code

Returns:

a state object based on the given state code and country code

getByPrimaryIdIfNecessary

State getByPrimaryIdIfNecessary(String postalStateCode,
                                State existingState)

get a state object based on the given state code and default country code. The default country code is set up in the system. The default country code is set up in the system. If the given postal state code is same as that of the given existing postal code, return the existing postal code; otherwise, retrieve a state object.

Parameters:

postalStateCode - the given state code

Returns:

a state object based on the given state code and default country code

getByPrimaryIdIfNecessary

State getByPrimaryIdIfNecessary(String postalCountryCode,
                                String postalStateCode,
                                State existingState)

get a state object based on the given state code and country code. If the given postal state code and country code are same as those of the given existing postal code, return the existing State; otherwise, retrieve a State object.

Parameters:

postalCountryCode - the given country code

postalStateCode - the given state code

Returns:

a state object based on the given state code and country code

findAllStates

List<State> findAllStates()

get all states in the system-default country

Returns:

all states in the system-default country

findAllStates

List<State> findAllStates(String postalCountryCode)

get all states in the given country

Parameters:

postalCountryCode - the given country code

Returns:

all states in the given country

findAllStatesByAltCountryCode

List<State> findAllStatesByAltCountryCode(String alternatePostalCountryCode)