com.whitestein.lsps.stdlib.entity

Class Lock

java.lang.Object

com.whitestein.lsps.stdlib.entity.Lock

All Implemented Interfaces:

EntityWithId<java.lang.String>

@Entity
public class Lock
extends java.lang.Object
implements EntityWithId<java.lang.String>

Persistent entity used for locking. The lock is identified by its name. There is possibility to set a message to the lock (arbitrary string). It can be used for application purposes.

Author:

ami, rba

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Lock() Creates new instance.
	Lock(java.lang.String lockName, java.lang.String message, java.util.Date lockDate, boolean locked) Creates new instance.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getId() Returns the primary key.
java.util.Date	getLockDate() Returns the lock timestamp.
java.lang.String	getLockName() Returns name of the lock.
java.lang.String	getMessage() Returns lock message.
boolean	isLocked() Returns true if locked.
void	setLockDate(java.util.Date timestamp) Updates timestamp of the lock to the current
void	setLocked(boolean locked) Sets the lock state.
void	setMessage(java.lang.String message) Sets a message to the lock.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Lock

protected Lock()

Creates new instance.

Lock

public Lock(java.lang.String lockName,
            java.lang.String message,
            java.util.Date lockDate,
            boolean locked)

Creates new instance.

Parameters:

lockName -

message -

lockDate -

locked -

Method Detail

getLockName

public java.lang.String getLockName()

Returns name of the lock.

Returns:

name of the lock

getId

public java.lang.String getId()

Description copied from interface: EntityWithId

Returns the primary key.

Specified by:

getId in interface EntityWithId<java.lang.String>

Returns:

the primary key

getMessage

public java.lang.String getMessage()

Returns lock message.

Returns:

lock message

setMessage

public void setMessage(java.lang.String message)

Sets a message to the lock.

Parameters:

message -

setLockDate

public void setLockDate(java.util.Date timestamp)

Updates timestamp of the lock to the current

Parameters:

timestamp -

Throws:

java.lang.NullPointerException - if timestamp is null

getLockDate

public java.util.Date getLockDate()

Returns the lock timestamp.

Returns:

the lock timestamp

isLocked

public boolean isLocked()

Returns true if locked.

Returns:

true if locked

setLocked

public void setLocked(boolean locked)

Sets the lock state.

Parameters:

locked -