org.termweb.api.data.user

Class Client

java.lang.Object

org.termweb.api.data.BaseTermWebObj

org.termweb.api.data.user.Client

All Implemented Interfaces:

Serializable, TermWebObj

public class Client
extends org.termweb.api.data.BaseTermWebObj

Defines a client in the system.

XML-RPC object structure

Parameter	Type	Value
__objtype	String	'Client'
id	String	Client ID
name	String	Client login name
fullName	String	Client display name
active	Boolean	True if the client is active
maxConcurrentUsers	Integer	Number of max concurrent user for this client. 0 if unlimited (limited by TermWeb license)
maxUserAccounts	Integer	Number of max user accounts for this client. 0 if unlimited (limited by TermWeb license)

Example:

{
   "__objtype": "Client",
   "id": "1073709059",
   "name": "admin",
   "fullName": "Administrator client",
   "active": true,
   "maxConcurrentUsers": 0,
   "maxUserAccounts": 0
}

See Also:

Serialized Form

Field Summary

Fields inherited from class org.termweb.api.data.BaseTermWebObj

ERROR_NULL_FIELD, ERROR_REQUIRED_FIELD, NAME

Constructor Summary

Constructors

Constructor and Description
Client() Creates a new client.
Client(TermWebID id) Creates a new client with specified ID.

Method Summary

Methods

Modifier and Type	Method and Description
String	getFullName() Returns the client's full name.
int	getMaxConcurrentUsers() Returns the max number of concurrent users.
int	getMaxUserAccounts() Returns the max number of users.
boolean	isActive() Checks if this client is active.
void	setActive(boolean active) Sets if this client is active.
void	setFullName(String fullName) Sets the client's full name.
void	setMaxConcurrentUsers(int maxConcurrentUsers) Sets the max number of concurrent users.
void	setMaxUserAccounts(int maxUserAccounts) Sets the max number of user accounts.

Methods inherited from class org.termweb.api.data.BaseTermWebObj

equals, getChangedBy, getChangedOn, getCreatedBy, getCreatedOn, getID, getName, hashCode, hasMetadata, isNew, setMetadata, setName, setNew, toString, validate, validateNotEmpty

Methods inherited from class java.lang.Object

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

Constructor Detail

Client

public Client()

Creates a new client.

Client

public Client(TermWebID id)

Creates a new client with specified ID.

Parameters:

id - The ID.

Method Detail

getMaxConcurrentUsers

public int getMaxConcurrentUsers()

Returns the max number of concurrent users.

Returns:

Max concurrent users.

getMaxUserAccounts

public int getMaxUserAccounts()

Returns the max number of users.

Returns:

Max users.

isActive

public boolean isActive()

Checks if this client is active.

Returns:

True if it is active.

setFullName

public void setFullName(String fullName)

Sets the client's full name.

Parameters:

fullName - The full name.

setMaxConcurrentUsers

public void setMaxConcurrentUsers(int maxConcurrentUsers)

Sets the max number of concurrent users.

Parameters:

maxConcurrentUsers - Max concurrent users.

setMaxUserAccounts

public void setMaxUserAccounts(int maxUserAccounts)

Sets the max number of user accounts.

Parameters:

maxUserAccounts - Max user accounts.

setActive

public void setActive(boolean active)

Sets if this client is active.

Parameters:

active - True if it is active.

getFullName

public String getFullName()

Returns the client's full name.

Returns:

The full name.