Information about a document's version is stored and retrieved using this interface. Document
versions consist of a version number unique to a document but not unique in the system, the
author of the version, it's creation and last modification date and comments on the version.
Type Template
<...>
<authorID>xs:long</authorID>
<creationDate>xs:dateTime</creationDate>
<documentState>xs:string</documentState>
<minorVersion>xs:boolean</minorVersion>
<modificationDate>xs:dateTime</modificationDate>
<versionCommentCount>xs:int</versionCommentCount>
<versionNumber>xs:int</versionNumber>
<...>Note: Element descriptions are split into information that's
relevant when you're creating an instance of this type and information
relevant when you're receiving an instance of it. Occasionally these
will differ.
Elements
| Element |
Description |
| authorID
|
- Setting
- Set the user that authored the document version. If the document version was created
anonymously, the authorID should be -1.
- Getting
- Returns the user that authored the document version. If the document version was created
anonymously, this method will return -1.
|
| creationDate
|
- Setting
- Sets the creation date of the document version. In most cases, the creation date will default
to when the document version was entered into the system. However, the creation date needs to
be set manually when importing documents. In other words, skin authors should ignore this
method since it is only intended for system maintenance.
- Getting
- Returns the date the document version was created.
|
| documentState
|
- Setting
-
Sets the document state for the version. Setting a state of
"published" (PUBLISHED)
will cause any other version of the document in that state to be altered to have a state of
"archived" (ARCHIVED)
.
Setting a document state of
"published" (PUBLISHED)
may cause a
DocumentAlreadyExistsException
to be thrown if the subject of the document is not
unique among the published documents in the community the document is contained within. This could be throw when
the document is updated with the new values.
- Getting
- Retrieve the document state for the version.
|
| minorVersion
|
- Setting
- Getting
- Returns true if the revision this instance represents is a minor version.
|
| modificationDate
|
- Setting
- Sets the date the document was last modified. In most cases, the last modified date will
default to when the document data was last changed. However, the last modified date needs to
be set manually when importing documents. In other words, skin authors should ignore this
method since it is only intended for system maintenance.
- Getting
- Returns the date the document version was last modified. When a document version is first
created, the date returned by this method is identical to the creation date. The modified
date is updated every time a document version is updated, such as if the document title was
modified.
|
| versionCommentCount
|
- Setting
- Getting
- Returns the number of comments made on the document version.
|
| versionNumber
|
- Setting
- Getting
- Returns the version number of the version of the document. Version numbers may not be unique
identifiers between documents and only should be used for identifying versions within a
particular document.
|