com.electrotank.electroserver4.extensions.api.value
Class ZoneValue

java.lang.Object
  com.electrotank.electroserver4.extensions.api.value.ZoneValue

public class ZoneValue
extends Object

Object to store information about a particular zone. A zone is a collection of rooms. Every room must exist in a zone. A room cannot exist in more than one zone. A zone is defined by a unique name and has no other properties. A zone is not created by itself. During the room creation, a zone is specified. If that zone does not exist, then it is created.

See Also:

RoomValue, ZoneConfiguration

Constructor Summary

ZoneValue()

Method Summary

int	getZoneId() Gets the unique zoneId for this zone.
String	getZoneName() Gets the name of the zone.
void	setZoneId(int zoneId) Sets the zoneId for this room.
void	setZoneName(String zoneName) Sets the name of the zone.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZoneValue

public ZoneValue()

Method Detail

getZoneId

public int getZoneId()

Gets the unique zoneId for this zone.

Returns:

zoneId

setZoneId

public void setZoneId(int zoneId)

Sets the zoneId for this room.

Parameters:

zoneId - unique identifier for the zone

getZoneName

public String getZoneName()

Gets the name of the zone.

Returns:

zoneName

setZoneName

public void setZoneName(String zoneName)

Sets the name of the zone.

Parameters:

zoneName - name of the zone