org.alfresco.mobile.android.api.services

Interface VersionService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

VersionServiceImpl

public interface VersionService
extends Service

The Versioning service manages versions of individual document.

Author:

Jean Marie Pascal

Nested Class Summary

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
static String	SORT_PROPERTY_CREATED_AT Allowable sorting property : Creation Date
static String	SORT_PROPERTY_DESCRIPTION Allowable sorting property : Description
static String	SORT_PROPERTY_MODIFIED_AT Allowable sorting property : Modification Date
static String	SORT_PROPERTY_NAME Allowable sorting property : Name of the document or folder.
static String	SORT_PROPERTY_TITLE Allowable sorting property : Title of the document or folder.

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckout(Document document) Cancels the check out of the document.
Document	checkin(Document document, boolean majorVersion, ContentFile file, Map<String,Serializable> properties, String comment) Checks in the private working copy document, if successful the new version of the document is returned.
Document	checkout(Document document) Checks out the document, if successful the private working copy is returned.
List<Document>	getCheckedOutDocuments() Returns a list of documents the authenticated user has checked out.
PagingResult<Document>	getCheckedOutDocuments(ListingContext listingContext) Returns a paged list of documents the authenticated user has checked out.
Document	getLatestVersion(Document document) Get the latest version of a document.
List<Document>	getVersions(Document document) Get the version history that relates to the referenced document.
PagingResult<Document>	getVersions(Document document, ListingContext listingContext) Get the version history that relates to the referenced document.

Methods inherited from interface org.alfresco.mobile.android.api.services.Service

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

SORT_PROPERTY_NAME

static final String SORT_PROPERTY_NAME

Allowable sorting property : Name of the document or folder.

SORT_PROPERTY_TITLE

static final String SORT_PROPERTY_TITLE

Allowable sorting property : Title of the document or folder.

SORT_PROPERTY_DESCRIPTION

static final String SORT_PROPERTY_DESCRIPTION

Allowable sorting property : Description

SORT_PROPERTY_CREATED_AT

static final String SORT_PROPERTY_CREATED_AT

Allowable sorting property : Creation Date

SORT_PROPERTY_MODIFIED_AT

static final String SORT_PROPERTY_MODIFIED_AT

Allowable sorting property : Modification Date

Method Detail

getLatestVersion

Document getLatestVersion(Document document)

Get the latest version of a document.

Parameters:

document -

Returns:

getVersions

List<Document> getVersions(Document document)

Get the version history that relates to the referenced document.

Parameters:

document - : document object in version control.

Returns:

Returns a list of documents representing the version history for the given document.

getVersions

PagingResult<Document> getVersions(Document document,
                                 ListingContext listingContext)

Get the version history that relates to the referenced document.

Parameters:

document - : document object in version control.

listingContext - : defines the behaviour of paging results ListingContext

Returns:

Returns a paged list of documents representing the version history for the given document.

checkout

Document checkout(Document document)

Checks out the document, if successful the private working copy is returned.

Parameters:

document -

Returns:

Since:

1.4

cancelCheckout

void cancelCheckout(Document document)

Cancels the check out of the document.

Parameters:

document -

Since:

1.4

checkin

Document checkin(Document document,
               boolean majorVersion,
               ContentFile file,
               Map<String,Serializable> properties,
               String comment)

Checks in the private working copy document, if successful the new version of the document is returned.

Parameters:

document -

majorVersion -

file -

properties -

comment -

Returns:

Since:

1.4

getCheckedOutDocuments

List<Document> getCheckedOutDocuments()

Returns a list of documents the authenticated user has checked out.

Returns:

Since:

1.4

getCheckedOutDocuments

PagingResult<Document> getCheckedOutDocuments(ListingContext listingContext)

Returns a paged list of documents the authenticated user has checked out.

Parameters:

listingContext -

Returns:

Since:

1.4