org.wattdepot.common.domainmodel

Interface IDomainModel

All Known Implementing Classes:

CollectorProcessDefinition, Depository, MeasurementPruningDefinition, Sensor, SensorGroup

public interface IDomainModel

IDomainModel defines common methods for all domain model classes.

Author:

Cam Moore

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() The slug is the name of the instance lower-cased, spaces replaced with '-', and special characters removed.
String	getName()
String	getOrganizationId()
void	setId(String id) Sets the instance's slug.
void	setName(String name) Sets the name of the instance.
void	setOrganizationId(String ownerId) Sets the id of the owner of this instance.

Method Detail

getName

String getName()

Returns:

the name of the instance.

getOrganizationId

String getOrganizationId()

Returns:

The id of the owner of this instance.

getId

String getId()

The slug is the name of the instance lower-cased, spaces replaced with '-', and special characters removed.

Returns:

The slug for this instance.

setName

void setName(String name)

Sets the name of the instance. If the slug is not set it sets the slug as well.

Parameters:

name - the name of the instance.

setOrganizationId

void setOrganizationId(String ownerId)

Sets the id of the owner of this instance.

Parameters:

ownerId - the id of the owner.

setId

void setId(String id)
           throws BadSlugException

Sets the instance's slug.

Parameters:

id - the new slug.

Throws:

BadSlugException - if the id is not a valid slug.