UserIndex (onebusaway-users 2.5.13-otsf API)

java.lang.Object
- org.onebusaway.users.model.UserIndex

All Implemented Interfaces:

Serializable
```
@Entity
public class UserIndex
extends Object
implements Serializable
```
A database-serialized linkage between some type-value id index (see UserIndexKey) and a User account. Each UserIndex refers to just one User account but each user account potentially has multiple user indices. Each user index also has an type-specific credentials value that can be used to authenticate a user using the specified user index. See UserIndexTypes for a set of common user index types used in the system. See discussion in the document for the User class.

Author:

bdferris

See Also:

UserIndexKey, User, UserService, UserIndexTypes, Serialized Form

Constructor Summary

Constructors
Constructor Description

UserIndex()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`equals(Object obj)`
`String`	`getCredentials()`
`UserIndexKey`	`getId()`
`User`	`getUser()`
`int`	`hashCode()`	`Object` Interface
`void`	`setCredentials(String credentials)`
`void`	`setId(UserIndexKey id)`
`void`	`setUser(User user)`
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- UserIndex
```
public UserIndex()
```

Method Detail

getId
```
public UserIndexKey getId()
```

setId

public void setId(UserIndexKey id)

getCredentials
```
public String getCredentials()
```

setCredentials

public void setCredentials(String credentials)

getUser
```
public User getUser()
```

setUser
```
public void setUser(User user)
```

hashCode
```
public int hashCode()
```
Object Interface

Overrides:

hashCode in class Object

equals
```
public boolean equals(Object obj)
```
Overrides:

equals in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object