org.kuali.rice.location.api.state

Interface StateService

All Known Implementing Classes:

StateServiceImpl

public interface StateService

Service for interacting with States.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Method Summary

Methods

Modifier and Type	Method and Description
List<State>	findAllStatesInCountry(String countryCode) Finds all the States for postal country code.
List<State>	findAllStatesInCountryByAltCode(String alternateCode) Finds all the States for alternate postal country code.
StateQueryResults	findStates(QueryByCriteria queryByCriteria) This method find States based on a query criteria.
State	getState(String countryCode, String code) Gets a State from a postal country code and postal state code.

Method Detail

getState

@Cacheable(value="http://rice.kuali.org/location/v2_0/StateType",
           key="\'countryCode=\' + #p0 + \'|\' + \'code=\' + #p1")
State getState(String countryCode,
                       String code)
               throws RiceIllegalArgumentException

Gets a State from a postal country code and postal state code.

This method will return null if the state does not exist.

This method will return active or inactive states.

Parameters:

countryCode - country code. cannot be blank.

code - state code. cannot be blank.

Returns:

a State or null

Throws:

RiceIllegalArgumentException - country code or state code is blank

findAllStatesInCountry

@Cacheable(value="http://rice.kuali.org/location/v2_0/StateType",
           key="\'countryCode=\' + #p0")
List<State> findAllStatesInCountry(String countryCode)
                                   throws RiceIllegalArgumentException

Finds all the States for postal country code.

This method will always return an immutable Collection even when no values exist.

This method will only return active states.

Parameters:

countryCode - state code. cannot be blank.

Returns:

an immutable collection of states

Throws:

RiceIllegalArgumentException - country code is blank

findAllStatesInCountryByAltCode

@Cacheable(value="http://rice.kuali.org/location/v2_0/StateType",
           key="\'alternateCode=\' + #p0")
List<State> findAllStatesInCountryByAltCode(String alternateCode)
                                            throws RiceIllegalArgumentException,
                                                   RiceIllegalStateException

Finds all the States for alternate postal country code.

This method will always return an immutable Collection even when no values exist.

This method will only return active states.

Parameters:

alternateCode - cannot be blank.

Returns:

an immutable collection of states

Throws:

RiceIllegalArgumentException - alternate country code is null

RiceIllegalStateException - when no countries are found for alternate country code

findStates

StateQueryResults findStates(QueryByCriteria queryByCriteria)
                             throws RiceIllegalArgumentException

This method find States based on a query criteria. The criteria cannot be null.

Parameters:

queryByCriteria - the criteria. Cannot be null.

Returns:

query results. will never return null.

Throws:

IllegalArgumentException - if the queryByCriteria is null

RiceIllegalArgumentException

Since:

2.0.1