Package com.axemble.vdoc.sdk.interfaces

Interface IVersion

All Superinterfaces:
IDelegationSupport, IDeletionSupport, IElement, IProtocolSupport, IResource, ISearchSupport, ISecuritySupport, IUriSupport, Serializable
public interface IVersion extends IResource, IDeletionSupport, ISearchSupport, IUriSupport, IDelegationSupport, IProtocolSupport
This class represents a version of a document.
Since:
1.0
Version:
1.0, 10/06/2010
Author:
vlygeros
See Also:

  • Method Details

    • setName

      void setName(String name)
      Sets the name of the version.
      Parameters:
      name - the new name to set.

    • getOwnedBy

      IUser getOwnedBy()
      Gets the owner of the version.
      Returns:
      a IUser object.

    • setOwner

      void setOwner(IUser user)
      Sets the owner of the version.
      Parameters:
      user - a IUser object.

    • getAttachmentTemplate

      IAttachmentTemplate getAttachmentTemplate()
      Gets the associated IAttachmentTemplate object.
      Returns:
      a IAttachmentTemplate object.

    • getWorkflow

      IWorkflow getWorkflow()
      Gets the associated workflow.
      Returns:
      a IWorkflow object.

    • getCurrentTaskInstance

      ITaskInstance getCurrentTaskInstance(IContext context)
      Gets the current task instance.
      Parameters:
      context - The execution context.
      Returns:
      a ITaskInstance object.

    • checkOut

      void checkOut()
      Check out a version.

    • undoCheckOut

      void undoCheckOut()
      Undo check out.

    • checkIn

      void checkIn()
      Check in a version.

    • checkedOutBy

      IUser checkedOutBy()
      Retrieve the user who checked out the version.
      Returns:
      a IUser object.

    • isCheckedOut

      boolean isCheckedOut()
      Check if the version has been checked out.
      Returns:
      true if the version has been checked out, false otherwise.

    • getParentFolder

      IFolder getParentFolder()
      Gets the parent folder.
      Returns:
      a IFolder object.

    • getVersionStatus

      int getVersionStatus()
      Gets the version status
      Returns:
      the version status
      See Also:

    • moveTo

      boolean moveTo(IFolder destFolder)
      Move a version to a folder.
      Parameters:
      destFolder - The IFolder to put the version to.
      Returns:
      true if succeed,
      invalid @link 
      {@link false
      } otherwise.

    • getUpLinks

      Collection<? extends IVersion> getUpLinks()
      Gets the up links as a collection of IVersion objects.
      Returns:
      A Collection of (@link IVersion} objects.

    • getDownLinks

      Collection<? extends IVersion> getDownLinks()
      Gets the down links as a collection of IVersion objects.
      Returns:
      A Collection of (@link IVersion} objects.