com.silverpeas.workflow.engine.instance
Class LockingUser

java.lang.Object
  com.silverpeas.workflow.engine.AbstractReferrableObject
      com.silverpeas.workflow.engine.instance.LockingUser

All Implemented Interfaces:

ReferrableObjectIntf

public class LockingUser
extends AbstractReferrableObject

Constructor Summary

LockingUser()
Default Constructor

Method Summary

String	getId() For persistence in database Get this object id
String	getKey() This method has to be implemented by the referrable object it has to compute the unique key
Date	getLockDate() Get the date when user locked the instance
ProcessInstanceImpl	getProcessInstance() Get the instance to which user is interested
String	getState() Get state name for which user is affected
String	getUserId() Get the user id
void	setId(String id) For persistence in database Set this object id
void	setLockDate(Date lockDate) Set the date when user locked the instance
void	setProcessInstance(ProcessInstanceImpl processInstance) Set the instance to which user is interested
void	setState(String state) Set state name for which user is affected
void	setUserId(String userId) Set the user id
User	toUser() Converts LockingUser to User
static User[]	toUser(LockingUser[] lockingUsers) Get User information from an array of lockingUsers

Methods inherited from class com.silverpeas.workflow.engine.AbstractReferrableObject

equals, hashCode

Methods inherited from class java.lang.Object

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

Constructor Detail

LockingUser

public LockingUser()

Default Constructor

Method Detail

getId

public String getId()

For persistence in database Get this object id

Returns:

this object id

setId

public void setId(String id)

For persistence in database Set this object id

Parameters:

this - object id

getState

public String getState()

Get state name for which user is affected

Returns:

state name

setState

public void setState(String state)

Set state name for which user is affected

Parameters:

state - state name

getUserId

public String getUserId()

Get the user id

Returns:

user id

setUserId

public void setUserId(String userId)

Set the user id

Parameters:

userId - user id

getProcessInstance

public ProcessInstanceImpl getProcessInstance()

Get the instance to which user is interested

Returns:

instance

setProcessInstance

public void setProcessInstance(ProcessInstanceImpl processInstance)

Set the instance to which user is interested

Parameters:

processInstance - instance

getLockDate

public Date getLockDate()

Get the date when user locked the instance

Returns:

lock date

setLockDate

public void setLockDate(Date lockDate)

Set the date when user locked the instance

Parameters:

lockDate - lock date

toUser

public User toUser()
            throws WorkflowException

Converts LockingUser to User

Returns:

an object implementing User interface and containing user details

Throws:

WorkflowException

toUser

public static User[] toUser(LockingUser[] lockingUsers)
                     throws WorkflowException

Get User information from an array of lockingUsers

Parameters:

lockingUsers - an array of LockingUser objects

Returns:

an array of objects implementing User interface and containing user details

Throws:

WorkflowException

getKey

public String getKey()

This method has to be implemented by the referrable object it has to compute the unique key

Specified by:

getKey in interface ReferrableObjectIntf

Specified by:

getKey in class AbstractReferrableObject

Returns:

The unique key.

See Also:

equals, hashCode