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

Class AbstractActivityStreamService

java.lang.Object

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

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

All Implemented Interfaces:

android.os.Parcelable, ActivityStreamService, Service

Direct Known Subclasses:

OnPremiseActivityStreamServiceImpl, PublicAPIActivityStreamServiceImpl

public abstract class AbstractActivityStreamService
extends AlfrescoService
implements ActivityStreamService

Abstract class implementation of ActivityStreamService. Responsible of sharing common methods between child class (OnPremise and Cloud)

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 inherited from class org.alfresco.mobile.android.api.services.impl.AlfrescoService

CONTENT_CACHE, RENDITION_CACHE, session

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
AbstractActivityStreamService(AlfrescoSession repositorySession) Default Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract PagingResult<ActivityEntry>	computeActivities(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url, ListingContext listingContext) Internal method to compute data from server and transform it as high level object.
List<ActivityEntry>	getActivityStream() Allow currently logged in user to get their activity stream.
PagingResult<ActivityEntry>	getActivityStream(ListingContext listingContext) Allow currently logged in user to get their activity stream.
List<ActivityEntry>	getActivityStream(String personIdentifier) Allow to retrieve activities feed for a specific user.
PagingResult<ActivityEntry>	getActivityStream(String personIdentifier, ListingContext listingContext) Allow to retrieve activities feed for a specific user.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getSiteActivitiesUrl(String siteIdentifier, ListingContext listingContext) Internal method to retrieve for a specific site the activity stream url.
List<ActivityEntry>	getSiteActivityStream(String siteName) Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).
PagingResult<ActivityEntry>	getSiteActivityStream(String siteIdentifier, ListingContext listingContext) Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getUserActivitiesUrl(ListingContext listingContext) Internal method to retrieve logged user activity stream url.
protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder	getUserActivitiesUrl(String personIdentifier, ListingContext listingContext) Internal method to retrieve user activity stream url.

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

Constructor Detail

AbstractActivityStreamService

public AbstractActivityStreamService(AlfrescoSession repositorySession)

Default Constructor. Only used inside ServiceRegistry.

Parameters:

repositorySession - : Repository Session.

Method Detail

getActivityStream

public List<ActivityEntry> getActivityStream()

Allow currently logged in user to get their activity stream.

Specified by:

getActivityStream in interface ActivityStreamService

Returns:

Returns a list of activities for the current user. The result list can be empty list if there's no activity.

getUserActivitiesUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getUserActivitiesUrl(ListingContext listingContext)

Internal method to retrieve logged user activity stream url. (depending on repository type)

Parameters:

listingContext - : define characteristics of the result (Optional for Onpremise)

Returns:

UrlBuilder to retrieve user activity stream.

getActivityStream

public PagingResult<ActivityEntry> getActivityStream(ListingContext listingContext)

Allow currently logged in user to get their activity stream.

Specified by:

getActivityStream in interface ActivityStreamService

Parameters:

listingContext - : define characteristics of result

Returns:

Returns a paged list of activities for the current user.

getActivityStream

public List<ActivityEntry> getActivityStream(String personIdentifier)

Allow to retrieve activities feed for a specific user.

Specified by:

getActivityStream in interface ActivityStreamService

Parameters:

personIdentifier - : a specific user

Returns:

Returns a list of activities for the given user. The result list can be empty if there's no activity or personIdentifier doesn't exist.

getUserActivitiesUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getUserActivitiesUrl(String personIdentifier,
                                                                         ListingContext listingContext)

Internal method to retrieve user activity stream url. (depending on repository type)

Parameters:

personIdentifier - : a specific user

listingContext - : define characteristics of the result (Optional for Onpremise)

Returns:

UrlBuilder to retrieve for a specific user its activity stream.

getActivityStream

public PagingResult<ActivityEntry> getActivityStream(String personIdentifier,
                                            ListingContext listingContext)

Allow to retrieve activities feed for a specific user.

Specified by:

getActivityStream in interface ActivityStreamService

Parameters:

personIdentifier - : a specific user

listingContext - : define characteristics of the paging result

Returns:

Returns a paged list of activities for the given user. The result list can be empty if there's no activity or personIdentifier doesn't exist.

getSiteActivityStream

public List<ActivityEntry> getSiteActivityStream(String siteName)

Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).

Specified by:

getSiteActivityStream in interface ActivityStreamService

Parameters:

siteName - : Share site short name

Returns:

Returns a list of activities for the current user and specified site. The result list can be empty if there's no activity or logged in user is not a member.

getSiteActivitiesUrl

protected abstract org.apache.chemistry.opencmis.commons.impl.UrlBuilder getSiteActivitiesUrl(String siteIdentifier,
                                                                         ListingContext listingContext)

Internal method to retrieve for a specific site the activity stream url. (depending on repository type)

Parameters:

siteIdentifier - : shortName of the site

listingContext - : define characteristics of the result (Optional for Onpremise)

Returns:

UrlBuilder to retrieve for a specific site its activity stream.

getSiteActivityStream

public PagingResult<ActivityEntry> getSiteActivityStream(String siteIdentifier,
                                                ListingContext listingContext)

Allow currently logged in user to get feed for a specified site (if private site then user must be a member or an admin user).

Specified by:

getSiteActivityStream in interface ActivityStreamService

Parameters:

siteIdentifier - : Share site short name

listingContext - : define characteristics of result

Returns:

Returns a paged list of activities for the current user and specified site. The result list can be empty if there's no activity or logged in user is not a member.

computeActivities

protected abstract PagingResult<ActivityEntry> computeActivities(org.apache.chemistry.opencmis.commons.impl.UrlBuilder url,
                                            ListingContext listingContext)

Internal method to compute data from server and transform it as high level object.

Parameters:

url - : Alfresco REST API activity url

listingContext - : listing context to apply to the paging result.

Returns:

Paging Result of activity entry.