IVersionableItem Interface
IT Hit WebDAV Classes ReferenceNamespace: ITHit.WebDAV.Server.DeltaV
Assembly: ITHit.WebDAV.Server (in ITHit.WebDAV.Server.dll) Version: 13.3.13068
SyntaxThe IVersionableItem type exposes the following members.
Properties| Name | Description | |
|---|---|---|
  | Created |
Gets the creation date of the item in repository expressed as the coordinated universal time (UTC).
(Inherited from IHierarchyItemBase.) |
| IsAutoCheckedOut |
Gets a value indicating whether the item was check-out automatically by engine without
explicit request from client.
|
| IsCheckedOut |
Gets a value indicating whether the item is in checked-in or checked-out state.
|
| Modified |
Gets the last modification date of the item in repository expressed as the coordinated universal time (UTC).
(Inherited from IHierarchyItemBase.) |
| Name |
Gets the name of the item in repository.
(Inherited from IHierarchyItemBase.) |
| Path |
Unique item path in the repository relative to storage root.
(Inherited from IHierarchyItemBase.) |
| VersionHistory |
Current item version history. Null, if item is not under version control.
|
Methods| Name | Description | |
|---|---|---|
 | CheckInAsync |
Creates new version. Copies all properties and content from this item.
|
| CheckOutAsync |
Allow modifications to the content and properties of this version-controlled item.
|
| CopyToAsync |
Creates a copy of this item with a new name in the destination folder.
(Inherited from IHierarchyItem.) |
| DeleteAsync |
Deletes this item.
(Inherited from IHierarchyItem.) |
| GetAutoVersionAsync |
Retrieves property which determines how checked-in item responds to WebDAV
client attempts to modify its content or properties.
|
| GetCommentAsync |
Retrieves a brief comment about a file that is suitable for presentation to a user.
(Inherited from IDeltaVItem.) |
| GetCreatorDisplayNameAsync |
Retrieves display name of the user that created this item.
(Inherited from IDeltaVItem.) |
| GetPropertiesAsync |
Gets values of all properties or selected properties for this item.
(Inherited from IHierarchyItem.) |
| GetPropertyNamesAsync |
Gets names of all properties for this item.
(Inherited from IHierarchyItem.) |
| MoveToAsync |
Moves this item to the destination folder under a new name.
(Inherited from IHierarchyItem.) |
| PutUnderVersionControlAsync |
Puts or removes current item from version control.
|
| SetAutoVersionAsync |
Sets property which determines how checked-in item responds to
WebDAV client attempts to modify its content or properties.
|
| SetCommentAsync |
Sets a brief comment about a file that is suitable for presentation to a user.
(Inherited from IDeltaVItem.) |
| SetCreatorDisplayNameAsync |
Sets display name of the user that created this item.
(Inherited from IDeltaVItem.) |
| UnCheckOutAsync |
Cancels the checkout and restores the pre-checkout state of the version-controlled item.
|
| UpdatePropertiesAsync |
Adds, modifies and removes properties for this item.
(Inherited from IHierarchyItem.) |
| UpdateToVersionAsync |
Updates content and properties of the item to those identified by version parameter.
|
RemarksBy default items in the repository are not under version control. When item is being put under version control engine calls PutUnderVersionControlAsync(Boolean) method passing true as a parameter. In your PutUnderVersionControlAsync(Boolean) implementation you must create a new version. The content and properties of the new version must be copied from this item. After the call to PutUnderVersionControlAsync(Boolean)VersionHistory property must point to the object implementing IHistory interface that will contain single version. The IsCheckedOut property must return false.
If item is under version control it mast always have at last one version in its versions list.
After the item had been put under version control client can issue checkout command. In your CheckOutAsync(Boolean) implementation you will mark item as checked-out and allow item modifications. When item is in check-out state WebDAV client can issue commands updating item contents and properties.
Finally client issues check-in command or discards changes issuing uncheck-out command. In your CheckInAsync implementation you will create a new version. The content and properties of the new version must be copied from this item. The item must be marked as checked-in. In your UnCheckOutAsync implementation you will discard changes and restore pre-checkout state. Content and properties must be copied from current version to this item. The item must be marked as checked-in.
The typical versioning workflow:
- Engine calls PutUnderVersionControlAsync(Boolean). Create new version, copy content and properties from this item to new version.
- Engine calls CheckOutAsync(Boolean). Mark item as checked-out.
- Engine calls WriteAsync(Stream, String, Int64, Int64) or UpdatePropertiesAsync(IListPropertyValue, IListPropertyName, MultistatusException). Modify item content and properties.
- Engine calls CheckInAsync or UnCheckOutAsync. For CheckInAsync - create new version, copy content and properties from this item to new version. For UnCheckOutAsync - copy content and properties from current version to this item. Mark item as checked-in.
In your UpdateToVersionAsync(IVersion) implementation you will create a new version and copy content and properties from IVersion passed as a parameter to new version. You will also replace content and properties of this item. The new created version becomes current version. The UpdateToVersionAsync(IVersion) method can only be called when item is in check-in state.
When item is being removed from version control engine calls PutUnderVersionControlAsync(Boolean) method passing false as a parameter. In your implementation you will usually delete all versions. VersionHistory property must return null after this call.
See Also