com.axemble.vdoc.sdk.interfaces

Interface IResourceHistory

All Superinterfaces:

Serializable

public interface IResourceHistory
extends Serializable

This class represents the history of a resource.

Since:

1.0, 15/04/2008

Author:

vlygeros

See Also:

IResourceHistory.IEvent, IResourceHistory.ISnapshot, IWorkflowInstance, ILinkedResource

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IResourceHistory.IEvent The document event structure.
static interface	IResourceHistory.ISnapshot The snapshot structure.

Method Summary

Modifier and Type	Method and Description
void	addEvent(IResourceHistory.IEvent event) Allows to add a custom event the the history of the document.
void	addEvent(String name, String source, IUser fulfiller, IUser addressee, String description, String doneBy) Allows to create and add a custom event.
void	addSnapshot(IResourceHistory.ISnapshot snapshot) Allows to add a snapshot to a document.
void	addSnapshot(String description, IUser fulfiller) Allows to create a snapshot and add it to a document.
Collection<? extends IResourceHistory.IEvent>	getEvents() Gets the list of IResourceHistory.IEvent objects.
Collection<? extends IResourceHistory.ISnapshot>	getSnapshots() Gets the list of snapshots.

Method Detail

addEvent

void addEvent(IResourceHistory.IEvent event)

Allows to add a custom event the the history of the document.

Parameters:

event - The IResourceHistory.IEvent object to add.

addEvent

void addEvent(String name,
              String source,
              IUser fulfiller,
              IUser addressee,
              String description,
              String doneBy)

Allows to create and add a custom event.

Parameters:

name - The system name of the performed action.

source - The system name of the current task.

fulfiller - The person who performed the action.

addressee - The person for whom the action was performed.

description - The comment of the fulfiller.

doneBy - The role of the fulfiller.

getEvents

Collection<? extends IResourceHistory.IEvent> getEvents()

Gets the list of IResourceHistory.IEvent objects.

Returns:

A java.util.Collection of IResourceHistory.IEvent objects.

addSnapshot

void addSnapshot(IResourceHistory.ISnapshot snapshot)

Allows to add a snapshot to a document.

Parameters:

snapshot - The IResourceHistory.ISnapshot object to add.

addSnapshot

void addSnapshot(String description,
                 IUser fulfiller)

Allows to create a snapshot and add it to a document.

Parameters:

description - The description of the snapshot.

fulfiller - The person who create the snapshot.

getSnapshots

Collection<? extends IResourceHistory.ISnapshot> getSnapshots()

Gets the list of snapshots.

Returns:

A java.util.Collection of IResourceHistory.ISnapshot objects.