org.alfresco.mobile.android.api.services.impl

Class VersionServiceImpl

java.lang.Object

org.alfresco.mobile.android.api.services.impl.AlfrescoService

org.alfresco.mobile.android.api.services.impl.VersionServiceImpl

All Implemented Interfaces:

android.os.Parcelable, Service, VersionService

public class VersionServiceImpl
extends AlfrescoService
implements VersionService

Implementation of VersionService.

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
protected org.apache.chemistry.opencmis.client.api.Session	cmisSession
static android.os.Parcelable.Creator<VersionServiceImpl>	CREATOR

Fields inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface org.alfresco.mobile.android.api.services.VersionService

SORT_PROPERTY_CREATED_AT, SORT_PROPERTY_DESCRIPTION, SORT_PROPERTY_MODIFIED_AT, SORT_PROPERTY_NAME, SORT_PROPERTY_TITLE

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VersionServiceImpl(AlfrescoSession repositorySession) Default constructor for service.
VersionServiceImpl(android.os.Parcel o)

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 contentFile, 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 lcontext) 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 class org.alfresco.mobile.android.api.services.impl.AlfrescoService

clear, convertException, convertNode, convertNode, convertStatusCode, delete, describeContents, getHttpInvoker, getSessionHttp, isCloudSession, isListNull, isMapNull, isObjectNull, isOnPremiseSession, isStringNull, post, put, read, saveContentStream, writeToParcel

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Field Detail

cmisSession

protected org.apache.chemistry.opencmis.client.api.Session cmisSession

CREATOR

public static final android.os.Parcelable.Creator<VersionServiceImpl> CREATOR

Constructor Detail

VersionServiceImpl

public VersionServiceImpl(AlfrescoSession repositorySession)

Default constructor for service.
Used by the ServiceRegistry.

Parameters:

repositorySession -

VersionServiceImpl

public VersionServiceImpl(android.os.Parcel o)

Method Detail

getLatestVersion

public Document getLatestVersion(Document document)

Description copied from interface: VersionService

Get the latest version of a document.

Specified by:

getLatestVersion in interface VersionService

Returns:

getVersions

public List<Document> getVersions(Document document)

Get the version history that relates to the referenced document.

Specified by:

getVersions in interface VersionService

Parameters:

document - : document object in version control.

Returns:

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

getVersions

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

Get the version history that relates to the referenced document.

Specified by:

getVersions in interface VersionService

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

public Document checkout(Document document)

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

Specified by:

checkout in interface VersionService

Returns:

cancelCheckout

public void cancelCheckout(Document document)

Description copied from interface: VersionService

Cancels the check out of the document.

Specified by:

cancelCheckout in interface VersionService

checkin

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

Description copied from interface: VersionService

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

Specified by:

checkin in interface VersionService

Returns:

getCheckedOutDocuments

public List<Document> getCheckedOutDocuments()

Description copied from interface: VersionService

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

Specified by:

getCheckedOutDocuments in interface VersionService

Returns:

getCheckedOutDocuments

public PagingResult<Document> getCheckedOutDocuments(ListingContext lcontext)

Description copied from interface: VersionService

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

Specified by:

getCheckedOutDocuments in interface VersionService

Returns: