IAMVersionable interface

You are here: COM API reference > Server objects > IAMVersionable interface

IAMVersionable interface

This interface is available on AMDocument objects. It exposes functionality control and describes document revisions.

Members (IAMVersionable)
Name	Description
BeginDraftVersion method	Creates a working copy or Quick Change
CanRevise property	True if a working copy can be created
ContextPath property	Reserved. See “About reserved objects, methods, and properties.”
CurrentWorkPackage property	The work area to which the document is assigned (AMWorkPackage object)
EffectivityEnd property	The date/time this revision was ended
EffectivityStart property	The date/time this revision was started
EndDraftVersion method	Submits a working copy or Quick Change
Freeze method	Reserved. See “About reserved objects, methods, and properties.”
InAnyWorkPackage property	True if the document is assigned to a work area
InCurrentWorkPackage property	True if the document is assigned to the current work area
InSubWorkPackage property	True if the document is assigned to a sub work area of the current work area
IsFrozen property	Reserved. See “About reserved objects, methods, and properties.”
IsUnderRevisionByAnyone property	True if a working copy exists for this document (for any user)
RepositoryContextPath property	Reserved. See “About reserved objects, methods, and properties.”
RestoreVersion method	Reserved. See “About reserved objects, methods, and properties.”
SubmitDateTime property	The date/time the document was submitted
SubmitPerson property	The name of the user who submitted the document
SubmitReleaseContext property	The context in which this document was released or submitted
SubmitReleaseDateTime property	The date/time the document was released or submitted
SubmitReleasePerson property	The name of the user who released or submitted the document
SubmittedFromWLOf property	The name of the person who last had a working copy of the document
UnderRevisionBy property	The name of the user who owns the working copy of this document
UnderRevisionByMe property	True if the current user owns the working copy for this document
VersionCount property	The number of revisions stored for this document
VersionID property	The ID for this revision
VersionName property	Reserved. See “About reserved objects, methods, and properties.”
VersionNr property	The revision number
Versions property	Collection of all revisions
WCCreatedBy property	The user that created the working copy
WorkPackageName property	The name of the work area the document is assigned to
WorkPackagePath property	Reserved. See “About reserved objects, methods, and properties.”

Members (IAMVersionable2)
Name	Description
NextSubmittedVersionNr method	Returns the version number as it will be after the next submit/release action on this document.
EndDraftVersionEx method	Ends the draft version, with the option to abort changes. This method is deprecated; do not use it. Use IAMVersionable4::EndDocumentDraftVersion instead.

Members (IAMVersionable4)
Name	Description
EndDocumentDraftVersion method	Ends the draft version, with the option to abort changes. For flags, see ENDDRAFTVERSION_FLAGS constants.

Remarks

The Versions property returns a collection of all revisions for a document. Items in this collection are read-only document objects that represent revisions in history. Most methods can not be used on these historical objects.

The Meridian server cannot create more than one revision of a document per transaction. The methods BeginDraftVersion and ChangeState will return an error when attempting to create a second revision.