Package hec.data.location

Class LocationCategory

java.lang.Object

hec.data.location.LocationCategory

public class LocationCategory
extends Object

Constructor Summary

Constructors

Constructor	Description
LocationCategory(String categoryId)
LocationCategory(String categoryId, String officeId)

Method Summary

Modifier and Type	Method	Description
LocationGroup	addGroup(LocationGroup locationGroup)
LocationGroup	addGroup(String groupId, String officeId, String groupDescription)	Adds or replaces a location group into this categories map.
LocationGroup	addGroup(String groupId, String groupDescription, String catOfficeId, String groupOfficeId)	Adds or replaces a location group into this categories map.
LocationGroup	addGroup(String groupId, String groupDescription, String catOfficeId, String groupOfficeId, String sharedAlias, String sharedRef)
LocationGroup	get(String groupId)	Returns a single location group from this category by id.
String	getDescrpition()	Returns this category's description.
String	getId()	Returns the category id.
String	getOfficeId()
void	setDescription(String description)	Sets the description of this category id.
void	setOfficeId(String officeId)
int	size()	Returns a count of the location groups in this category.
Collection<LocationGroup>	values()	Returns a Collection containing the location groups in this category.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

LocationCategory

public LocationCategory(String categoryId)

LocationCategory

public LocationCategory(String categoryId,
 String officeId)

Method Details

getId

public String getId()

Returns the category id.

getOfficeId

public String getOfficeId()

setOfficeId

public void setOfficeId(String officeId)

setDescription

public void setDescription(String description)

Sets the description of this category id.

getDescrpition

public String getDescrpition()

Returns this category's description.

addGroup

public LocationGroup addGroup(String groupId,
 String groupDescription,
 String catOfficeId,
 String groupOfficeId,
 String sharedAlias,
 String sharedRef)

addGroup

public LocationGroup addGroup(String groupId,
 String groupDescription,
 String catOfficeId,
 String groupOfficeId)

Adds or replaces a location group into this categories map.

Parameters:

groupId - The location group. The group's id is used as the key.

Returns:

The old location group with that id if it existed otherwise null.

addGroup

public LocationGroup addGroup(String groupId,
 String officeId,
 String groupDescription)

Adds or replaces a location group into this categories map.

Parameters:

groupId - The location group. The group's id is used as the key.

Returns:

The old location group with that id if it existed otherwise null.

addGroup

public LocationGroup addGroup(LocationGroup locationGroup)

size

public int size()

Returns a count of the location groups in this category.

values

public Collection<LocationGroup> values()

Returns a Collection containing the location groups in this category.

Returns:

get

public LocationGroup get(String groupId)

Returns a single location group from this category by id. Returns null if the group doesnt exist.