org.wattdepot.common.domainmodel

Class Organization

java.lang.Object

org.wattdepot.common.domainmodel.Organization

public class Organization
extends Object

Organization - A group of users used to create a namespace for WattDepot entities. Users, sensors, sensor groups, collectors, depositories, and measurements all belong to a single "organization".

Author:

Cam Moore

Field Summary

Fields

Modifier and Type	Field and Description
static Organization	ADMIN_GROUP The admin user group.
static String	ADMIN_GROUP_NAME The name of the admin group.
protected String	id Unique id that is also a slug usable in URLs.
protected String	name The name of the group.
static Organization	PUBLIC_GROUP The public user group.
protected Set<String>	users The ids of the users in this group.

Constructor Summary

Constructors

Constructor and Description
Organization() The default constructor.
Organization(String name)
Organization(String name, Set<String> users)
Organization(String slug, String name, Set<String> users)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(String userId)
boolean	contains(Object o)
boolean	equals(Object obj)
String	getId()
String	getName()
Set<String>	getUsers()
int	hashCode()
boolean	remove(Object o)
void	setId(String id)
void	setName(String name)
void	setUsers(Set<String> users)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ADMIN_GROUP_NAME

public static final String ADMIN_GROUP_NAME

The name of the admin group.

See Also:

Constant Field Values

ADMIN_GROUP

public static final Organization ADMIN_GROUP

The admin user group.

PUBLIC_GROUP

public static final Organization PUBLIC_GROUP

The public user group. All groups can see publicly owned objects.

id

protected String id

Unique id that is also a slug usable in URLs.

name

protected String name

The name of the group.

users

protected Set<String> users

The ids of the users in this group.

Constructor Detail

Organization

public Organization()

The default constructor.

Organization

public Organization(String name)

Parameters:

name - The name of the Organization.

Organization

public Organization(String name,
            Set<String> users)

Parameters:

name - The name of the organization.

users - The Users in the organization.

Organization

public Organization(String slug,
            String name,
            Set<String> users)

Parameters:

slug - The unique slug.

name - The name of the organization.

users - The Users in the organization.

Method Detail

add

public boolean add(String userId)

Parameters:

userId - The id of the User to add.

Returns:

true if successful.

See Also:

List.add(java.lang.Object)

contains

public boolean contains(Object o)

Parameters:

o - The user to test.

Returns:

true if the user is in the group.

See Also:

List.contains(java.lang.Object)

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getId

public String getId()

Returns:

The unique id for the Organization.

getName

public String getName()

Returns:

the name

getUsers

public Set<String> getUsers()

Returns:

the users.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

remove

public boolean remove(Object o)

Parameters:

o - The User to remove.

Returns:

true if successful.

See Also:

List.remove(java.lang.Object)

setId

public void setId(String id)

Parameters:

id - the id to set

setName

public void setName(String name)

Parameters:

name - the name to set

setUsers

public void setUsers(Set<String> users)

Parameters:

users - the users to set

toString

public String toString()

Overrides:

toString in class Object