Package com.axemble.vdoc.sdk.impl

Class PortalResourceHistory

java.lang.Object

com.axemble.vdoc.sdk.impl.AbstractElement

com.axemble.vdoc.sdk.impl.PortalResourceHistory

All Implemented Interfaces:

IResourceHistory, Serializable

public class PortalResourceHistory
extends AbstractElement
implements IResourceHistory

Author:

vlygeros

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	PortalResourceHistory.Snapshot

Nested classes/interfaces inherited from interface com.axemble.vdoc.sdk.interfaces.IResourceHistory

IResourceHistory.IEvent, IResourceHistory.ISnapshot

Field Summary

Fields

Modifier and Type	Field	Description
protected IResource	resource

Fields inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

module

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	PortalResourceHistory(IModule module, IResource resource)

Method Summary

Modifier and Type	Method	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 addresse, 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	getEvents()	Gets the list of IResourceHistory.IEvent objects.
Collection	getSnapshots()	Gets the list of snapshots.

Methods inherited from class com.axemble.vdoc.sdk.impl.AbstractElement

getModule

Methods inherited from class java.lang.Object

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

Field Details

resource

protected IResource resource

Constructor Details

PortalResourceHistory

protected PortalResourceHistory(IModule module,
 IResource resource)

Method Details

addEvent

public void addEvent(IResourceHistory.IEvent event)

Description copied from interface: IResourceHistory

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

Specified by:

addEvent in interface IResourceHistory

Parameters:

event - The IResourceHistory.IEvent object to add.

addEvent

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

Description copied from interface: IResourceHistory

Allows to create and add a custom event.

Specified by:

addEvent in interface IResourceHistory

Parameters:

name - The system name of the performed action.

source - The system name of the current task.

fulfiller - The person who performed the action.

addresse - The person for whom the action was performed.

description - The comment of the fulfiller.

doneBy - The role of the fulfiller.

getEvents

public Collection getEvents()

Description copied from interface: IResourceHistory

Gets the list of IResourceHistory.IEvent objects.

Specified by:

getEvents in interface IResourceHistory

Returns:

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

addSnapshot

public void addSnapshot(IResourceHistory.ISnapshot snapshot)

Description copied from interface: IResourceHistory

Allows to add a snapshot to a document.

Specified by:

addSnapshot in interface IResourceHistory

Parameters:

snapshot - The IResourceHistory.ISnapshot object to add.

addSnapshot

public void addSnapshot(String description,
 IUser fulfiller)

Description copied from interface: IResourceHistory

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

Specified by:

addSnapshot in interface IResourceHistory

Parameters:

description - The description of the snapshot.

fulfiller - The person who create the snapshot.

getSnapshots

public Collection getSnapshots()

Description copied from interface: IResourceHistory

Gets the list of snapshots.

Specified by:

getSnapshots in interface IResourceHistory

Returns:

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