com.helger.photon.basic.object.client

Class Client

java.lang.Object

com.helger.photon.basic.object.AbstractBaseObject

com.helger.photon.basic.object.AbstractObject

com.helger.photon.basic.object.client.Client

All Implemented Interfaces:

com.helger.commons.id.IHasID<String>, com.helger.commons.name.IHasDisplayName, com.helger.commons.type.IHasType, com.helger.commons.type.ITypedObject<String>, com.helger.datetime.IHasCreationDateTime, com.helger.datetime.IHasDeletionDateTime, com.helger.datetime.IHasLastModificationDateTime, IHasCreationInfo, IHasDeletionInfo, IHasLastModificationInfo, IClient, IObject, IHasUIText

@NotThreadSafe
public final class Client
extends AbstractObject
implements IClient

Default implementation of IClient

Author:

Philip Helger

Field Summary

Fields

Modifier and Type	Field and Description
static com.helger.commons.type.ObjectType	OT

Constructor Summary

Constructors

Constructor and Description
Client(String sID, String sDisplayName) Constructor for new client

Method Summary

Methods

Modifier and Type	Method and Description
String	getAsUIText(Locale aDisplayLocale)
String	getDisplayName()
com.helger.commons.type.ObjectType	getTypeID()
boolean	isGlobalClient()
com.helger.commons.state.EChange	setDisplayName(String sDisplayName)
String	toString()

Methods inherited from class com.helger.photon.basic.object.AbstractObject

equals, hashCode

Methods inherited from class com.helger.photon.basic.object.AbstractBaseObject

getCreationDateTime, getCreationUserID, getDeletionDateTime, getDeletionUserID, getID, getLastModificationDateTime, getLastModificationUserID, isDeleted, isDeleted, isDeleted, setDeletion, setDeletionNow, setLastModification, setLastModificationNow, setUndeletion, setUndeletionNow

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.object.IObject

getCreationDateTime, getCreationUserID, isDeleted, isDeleted, isDeleted

Methods inherited from interface com.helger.commons.id.IHasID

getID

Methods inherited from interface com.helger.photon.basic.datetime.IHasLastModificationInfo

getLastModificationUserID

Methods inherited from interface com.helger.datetime.IHasLastModificationDateTime

getLastModificationDateTime

Methods inherited from interface com.helger.photon.basic.datetime.IHasDeletionInfo

getDeletionUserID

Methods inherited from interface com.helger.datetime.IHasDeletionDateTime

getDeletionDateTime

Field Detail

OT

public static final com.helger.commons.type.ObjectType OT

Constructor Detail

Client

public Client(@Nonnull@Nonempty
      String sID,
      @Nonnull@Nonempty
      String sDisplayName)

Constructor for new client

Parameters:

sID - ID

sDisplayName - display name

Method Detail

getTypeID

@Nonnull
public com.helger.commons.type.ObjectType getTypeID()

Specified by:

getTypeID in interface com.helger.commons.type.IHasType

isGlobalClient

public boolean isGlobalClient()

Specified by:

isGlobalClient in interface IClient

Returns:

true if this is the system global client

getDisplayName

@Nonnull
@Nonempty
public String getDisplayName()

Specified by:

getDisplayName in interface com.helger.commons.name.IHasDisplayName

setDisplayName

@Nonnull
public com.helger.commons.state.EChange setDisplayName(@Nonnull@Nonempty
                                                      String sDisplayName)

getAsUIText

@Nonnull
@Nonempty
public String getAsUIText(Locale aDisplayLocale)

Specified by:

getAsUIText in interface IHasUIText

Parameters:

aDisplayLocale - Display locale. May not be null.

Returns:

The UI text

toString

public String toString()

Overrides:

toString in class AbstractBaseObject