com.neurosys.ecom.service

Interface AreaService<A extends AreaType>

Type Parameters:

A -

All Superinterfaces:

ConfigurationSource<String,A>

public interface AreaService<A extends AreaType>
extends ConfigurationSource<String,A>

Service methods for AreaType

Author:

Arjun Dhar

Field Summary

Fields inherited from interface com.neurosys.configs.ConfigurationSource

NAMESPACE_DELIM

Method Summary

Modifier and Type	Method and Description
A	getArea(String id, String type) For an AreaType.getId() return the AreaType
<O> O	getAreas(String type) Get a Map of all the areas, where the Key is defined by key for Area getKey(AreaType)
List	getChildren(A area) For a parent Area get children. The List of children is implementation dependent.
<K> K	getKey(A area) A consistent definition of what a key is for an Area.
A	getParent(A subArea) For a subArea A, what is the Area containing it.

Methods inherited from interface com.neurosys.configs.ConfigurationSource

get, get, get

Method Detail

getAreas

<O> O getAreas(String type)

Get a Map of all the areas, where the Key is defined by key for Area getKey(AreaType)

Parameters:

type - as String. An optional parameter that specifies area of which type/level to be fetched. Like region, country, state, zip etc.

Returns:

O as a List of A or Map of key as K and value as A

getArea

A getArea(String id,
          String type)

For an AreaType.getId() return the AreaType

Parameters:

id - as String

type - as String. An optional parameter that specifies area of which type/level to be fetched. Like region, country, state, zip etc.

Returns:

AreaType

getParent

A getParent(A subArea)

For a subArea A, what is the Area containing it.

Parameters:

subArea - as A

Returns:

getChildren

List getChildren(A area)

For a parent Area get children.
The List of children is implementation dependent. It could be a homogeneous type list of AreaType or a List of Lists (Tree).

Returns:

getKey

<K> K getKey(A area)

A consistent definition of what a key is for an Area. As a best practice, the key should be same as AreaType.getId()

Parameters:

area - as A

Returns:

K