com.ithit.webdav.server.deltav

Interface DeltaVItem

All Superinterfaces:

HierarchyItem

All Known Subinterfaces:

Version, VersionableItem

public interface DeltaVItem
extends HierarchyItem

Base interface for items that support versioning and item versions (DeltaV items).

This interface defines properties common to all items that support versioning and item versions. It provides the means of getting and setting comments and author name when creating new version. The author of the version is set and get via setCreatorDisplayName(java.lang.String) and comment via setComment(java.lang.String).

Method Summary

Modifier and Type	Method and Description
String	getComment() Retrieves brief comment about a resource that is suitable for presentation to a user.
String	getCreatorDisplayName() Retrieves display name of the user that created this item.
void	setComment(String comment) Sets brief comment about a resource that is suitable for presentation to a user.
void	setCreatorDisplayName(String name) Sets display name of the user that created this item.

Methods inherited from interface com.ithit.webdav.server.HierarchyItem

copyTo, delete, getCreated, getModified, getName, getPath, getProperties, getPropertyNames, moveTo, updateProperties

Method Detail

getComment

String getComment()
           throws ServerException

Retrieves brief comment about a resource that is suitable for presentation to a user.

Returns:

Comment string.

Throws:

ServerException - in case of failure.

setComment

void setComment(String comment)
         throws ServerException,
                LockedException

Sets brief comment about a resource that is suitable for presentation to a user.

This property can be used to indicate why that version was created.

Parameters:

comment - Comment string.

Throws:

ServerException - in case of failure.

LockedException

getCreatorDisplayName

String getCreatorDisplayName()
                      throws ServerException

Retrieves display name of the user that created this item.

Returns:

User name.

Throws:

ServerException - in case of error.

setCreatorDisplayName

void setCreatorDisplayName(String name)
                    throws ServerException,
                           LockedException

Sets display name of the user that created this item.

This should be a description of the creator of the resource that is suitable for presentation to a user. Can be used to indicate who created that version.

Parameters:

name - User name.

Throws:

ServerException - in case of error.

LockedException