Package net.webpdf.wsclient.schema.beans

Class HistoryEntry

java.lang.Object

net.webpdf.wsclient.schema.beans.HistoryEntry

All Implemented Interfaces:

Serializable

public class HistoryEntry
extends Object
implements Serializable

An instance of HistoryEntry is intended to wrap and simplify information about a previous state of a given Document, it shall provide an ID for that history entry, allowing to revert to that state of the linked document.
Such HistoryEntry objects can be received via and are managed by a RestSession´s DocumentManager.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
HistoryEntry()

Method Summary

Modifier and Type	Method	Description
@Nullable String	getDateTime()	Returns the timestamp of the history entry.
@Nullable String	getFileName()	Returns the name of the file, that has been changed.
int	getId()	Returns the ID of the history entry.
@Nullable String	getOperation()	Returns the name of the operation, that has been executed.
boolean	isActive()	Returns true, if the history entry is currently active.
void	setActive(boolean active)	When set to true, the history entry is currently active.
void	setDateTime(@Nullable String dateTime)	Sets the timestamp of the history entry.
void	setFileName(@Nullable String fileName)	Sets the name of the file, that has been changed.
void	setId(int id)	Sets the ID of the history entry.
void	setOperation(@Nullable String operation)	Sets the name of the operation, that has been executed.

Methods inherited from class java.lang.Object

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

Constructor Detail

HistoryEntry

public HistoryEntry()

Method Detail

getId

public int getId()

Returns the ID of the history entry.

Returns:

The ID of the history entry.

setId

public void setId(int id)

Sets the ID of the history entry.

Parameters:

id - The ID, that shall be set.

isActive

public boolean isActive()

Returns true, if the history entry is currently active.

Returns:

True, if the history entry is currently active.

setActive

public void setActive(boolean active)

When set to true, the history entry is currently active.

Parameters:

active - true, if the history entry is currently active.

getFileName

@Nullable
public @Nullable String getFileName()

Returns the name of the file, that has been changed.

Returns:

The name of the file, that has been changed.

setFileName

public void setFileName(@Nullable
                        @Nullable String fileName)

Sets the name of the file, that has been changed.

Parameters:

fileName - The name of the file, that has been changed.

getOperation

@Nullable
public @Nullable String getOperation()

Returns the name of the operation, that has been executed.

Returns:

The name of the operation, that has been executed.

setOperation

public void setOperation(@Nullable
                         @Nullable String operation)

Sets the name of the operation, that has been executed.

Parameters:

operation - The name of the operation, that has been executed.

getDateTime

@Nullable
public @Nullable String getDateTime()

Returns the timestamp of the history entry.

Returns:

The timestamp of the history entry.

setDateTime

public void setDateTime(@Nullable
                        @Nullable String dateTime)

Sets the timestamp of the history entry.

Parameters:

dateTime - The timestamp of the history entry.