com.arcway.cockpit.docgen.provider.interfaces

Interface IHistoryEntry

public interface IHistoryEntry

Each time, a user commits the project, a history entry is created. User, date and comment are logged in ine history entry.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getComment() Returns the commit comment of the change.
java.lang.String	getDate() Returns the date of the commit change.
java.lang.String	getUniqueIdentifier() Returns a unique identifier that uniquely identifies this history entry within the COCKPIT project.
java.lang.String	getUserDistinguishedName() Returns the distinguished name of the commiting user.
java.lang.String	getUserLoginID() Returns the login ID of the commiting user.
java.lang.String	getUserRealname() Returns the real name of the commiting user.
java.lang.String	getVersion() Returns the version number of this entry.

Method Detail

getVersion

java.lang.String getVersion()

Returns the version number of this entry.

This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

version number (!= null)

getUserRealname

java.lang.String getUserRealname()

Returns the real name of the commiting user.

This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

real name (!= null)

getUserLoginID

java.lang.String getUserLoginID()

Returns the login ID of the commiting user. This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

login id (!= null)

getUserDistinguishedName

java.lang.String getUserDistinguishedName()

Returns the distinguished name of the commiting user. This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

distinguished name (!= null)

getDate

java.lang.String getDate()

Returns the date of the commit change.

This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

real name (!= null)

getComment

java.util.List<java.lang.String> getComment()

Returns the commit comment of the change.

One string per line is returned.

This string is already HTML encoded so that it can be inserted into the document without further tranformations.

Returns:

real name (!= null)

getUniqueIdentifier

java.lang.String getUniqueIdentifier()

Returns a unique identifier that uniquely identifies this history entry within the COCKPIT project.

Example from report template:

#set($entry_uid = ${historyEntry.UniqueIdentifier})

Returns:

unique identifier