de.innovationgate.webgate.api

Class WGUpdateLog

java.lang.Object

de.innovationgate.webgate.api.WGUpdateLog

public class WGUpdateLog
extends java.lang.Object

Object representing a modification of a document that took place, which may be an update or a deletion.

Field Summary

Fields

Modifier and Type	Field and Description
static int	TYPE_DELETE An update log for a document deletion
static int	TYPE_STRUCTMOVE An update log for a struct entry movage.
static int	TYPE_UPDATE An update log for a document creation or update

Constructor Summary

Constructors

Constructor and Description
WGUpdateLog(int type, java.util.Date date, java.lang.String user, java.lang.String dockey, java.lang.String task, WGDatabaseRevision revision) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Date	getDate() Return the date of modification.
java.lang.String	getDocumentKey() Returns the key of the modified document
WGDatabaseRevision	getRevision() Returns the revision of this modification
java.lang.String	getTask() Returns the task that was set on the session doing this modification
int	getType() Returns the type of log as constants TYPE_...
java.lang.String	getUser() Returns the user that executed the modification
void	setDate(java.util.Date date) Sets the date of modification
void	setDocumentKey(java.lang.String string) Sets the document key of the modified document
void	setTask(java.lang.String task) Sets the task of the update log
void	setType(int type) Sets the type of the update log.
void	setUser(java.lang.String string) Sets the user that executed the modification
java.lang.String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE_UPDATE

public static final int TYPE_UPDATE

An update log for a document creation or update

See Also:

Constant Field Values

TYPE_DELETE

public static final int TYPE_DELETE

An update log for a document deletion

See Also:

Constant Field Values

TYPE_STRUCTMOVE

public static final int TYPE_STRUCTMOVE

An update log for a struct entry movage. This log type is issued additionally to the UPDATE log of the struct entry which reflects that the struct data has been changed in the movage operation.

See Also:

Constant Field Values

Constructor Detail

WGUpdateLog

public WGUpdateLog(int type,
           java.util.Date date,
           java.lang.String user,
           java.lang.String dockey,
           java.lang.String task,
           WGDatabaseRevision revision)

Constructor.

Parameters:

date - The date of modification.

user - The user that modified the document.

dockey - The document key of the modified document.

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getDate

public java.util.Date getDate()

Return the date of modification.

getDocumentKey

public java.lang.String getDocumentKey()

Returns the key of the modified document

getUser

public java.lang.String getUser()

Returns the user that executed the modification

setDate

public void setDate(java.util.Date date)

Sets the date of modification

Parameters:

date -

setDocumentKey

public void setDocumentKey(java.lang.String string)

Sets the document key of the modified document

Parameters:

string -

setUser

public void setUser(java.lang.String string)

Sets the user that executed the modification

Parameters:

string -

getType

public int getType()

Returns the type of log as constants TYPE_...

setType

public void setType(int type)

Sets the type of the update log.

getRevision

public WGDatabaseRevision getRevision()

Returns the revision of this modification

getTask

public java.lang.String getTask()

Returns the task that was set on the session doing this modification

setTask

public void setTask(java.lang.String task)

Sets the task of the update log