com.axemble.vdoc.sdk.interfaces

Interface IResourceHistory.IEvent

All Superinterfaces:

Serializable

Enclosing interface:

IResourceHistory

public static interface IResourceHistory.IEvent
extends Serializable

The document event structure.

Method Summary

Modifier and Type	Method and Description
IUser	getAddresse() Deprecated. use getAddressee() method instead.
IUser	getAddressee() Returns the addressee.
Date	getDate() Returns the date of the event.
String	getDescription() Returns the description of the event.
String	getDoneBy() Indicates the fulfiller role.
IUser	getFulfiller() Returns the fulfiller.
String	getLabel() Returns the label of the task.
String	getLabel(String language) Returns the label of the task.
String	getName() Returns the system name of the action.
String	getSource() Returns the label of the task from where the action was performed.
String	getSourceName() Returns the system name of the task from where the action was performed.
boolean	isCustomized() Indicates whether the event is a customized event or a system event.

Method Detail

isCustomized

boolean isCustomized()

Indicates whether the event is a customized event or a system event.

Returns:

true if the event is a custom one, false otherwise.

getName

String getName()

Returns the system name of the action.

Returns:

A java.lang.String value.

getLabel

String getLabel()

Returns the label of the task.

Returns:

A java.lang.String value.

getLabel

String getLabel(String language)

Returns the label of the task.

Parameters:

language - the language in which the label must be translated (for system events)

Returns:

A java.lang.String value.

getSource

String getSource()

Returns the label of the task from where the action was performed.

Returns:

A java.lang.String value.

getSourceName

String getSourceName()

Returns the system name of the task from where the action was performed.

Returns:

A java.lang.String value.

getDate

Date getDate()

Returns the date of the event.

Returns:

A java.util.Date object.

getFulfiller

IUser getFulfiller()

Returns the fulfiller.

Returns:

A @link{IUser} object.

getAddressee

IUser getAddressee()

Returns the addressee.

Returns:

A @link{IUser} object.

getAddresse

@Deprecated
IUser getAddresse()

Deprecated. use getAddressee() method instead.

Returns the addressee.

Returns:

A @link{IUser} object.

getDescription

String getDescription()

Returns the description of the event.

Returns:

A java.util.Date object.

getDoneBy

String getDoneBy()

Indicates the fulfiller role.

Returns:

A java.lang.String value.