public interface DeltaVItem extends HierarchyItem
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)
.
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.
|
copyTo, delete, getCreated, getModified, getName, getPath, getProperties, getPropertyNames, moveTo, updateProperties
String getComment() throws ServerException
ServerException
- in case of failure.void setComment(String comment) throws ServerException, LockedException
This property can be used to indicate why that version was created.
comment
- Comment string.ServerException
- in case of failure.LockedException
String getCreatorDisplayName() throws ServerException
ServerException
- in case of error.void setCreatorDisplayName(String name) throws ServerException, LockedException
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.
name
- User name.ServerException
- in case of error.LockedException
Copyright © ITHit. All Rights Reserved.