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:

IResource, IWorkflow, ITaskInstance

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IVersion.IVersionStatus Available version status.

Method Summary

Modifier and Type	Method and Description
IUser	checkedOutBy() Retrieve the user who checked out the version.
void	checkIn() Check in a version.
void	checkOut() Check out a version.
IAttachmentTemplate	getAttachmentTemplate() Gets the associated IAttachmentTemplate object.
ITaskInstance	getCurrentTaskInstance(IContext context) Gets the current task instance.
Collection<? extends IVersion>	getDownLinks() Gets the down links as a collection of IVersion objects.
IUser	getOwnedBy() Gets the owner of the version.
IFolder	getParentFolder() Gets the parent folder.
Collection<? extends IVersion>	getUpLinks() Gets the up links as a collection of IVersion objects.
int	getVersionStatus() Gets the version status
IWorkflow	getWorkflow() Gets the associated workflow.
boolean	isCheckedOut() Check if the version has been checked out.
boolean	moveTo(IFolder destFolder) Move a version to a folder.
void	setName(String name) Sets the name of the version.
void	setOwner(IUser user) Sets the owner of the version.
void	undoCheckOut() Undo check out.

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IResource

addLinkedResource, addLinkedResources, allowEvents, createLinkedResource, deleteLinkedResource, deleteLinkedResources, denyEvents, exists, getCreatedBy, getCreatedDate, getDefinition, getHistory, getLinkedResources, getList, getModifiedBy, getModifiedDate, getName, getText, getValue, refresh, refresh, save, save, setCreatedBy, setCreatedDate, setList, setModifiedBy, setModifiedDate, setValue, setValueNoEvents

Methods inherited from interface com.axemble.vdoc.sdk.interfaces.IElement

getId, getModule, getNativeObject, getPath, save

Methods inherited from interface com.axemble.vdoc.sdk.supports.IDeletionSupport

delete

Methods inherited from interface com.axemble.vdoc.sdk.supports.IProtocolSupport

getProtocolURI, getProtocolURI

Methods inherited from interface com.axemble.vdoc.sdk.supports.IUriSupport

getURI

Method Detail

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:

IVersion.IVersionStatus

moveTo

boolean moveTo(IFolder destFolder)

Move a version to a folder.

Parameters:

destFolder - The IFolder to put the version to.

Returns:

true if succeed, 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.