org.alfresco.mobile.android.api.services

Interface SiteService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

AbstractSiteServiceImpl, CloudSiteServiceImpl, OnPremiseSiteServiceImpl, PublicAPISiteServiceImpl

public interface SiteService
extends Service

Sites are a key concept within Alfresco Share for managing documents, wiki pages, blog posts, discussions, and other collaborative content relating to teams, projects, communities of interest, and other types of collaborative sites.
There are various methods relating to the Sites service, including the ability to:

• List Sites (Favorites, all sites, user are member of)

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_SHORTNAME Allowable sorting property : Name of the site.
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
Site	addFavoriteSite(Site site) Adds the given site to the current users list of favorite sites.
Site	cancelRequestToJoinSite(Site site) Cancels a previous request to join a site made by the current user.
List<Person>	getAllMembers(Site site) Returns a list of site members.
PagingResult<Person>	getAllMembers(Site site, ListingContext listingContext) Returns a paged list of site members.
List<Site>	getAllSites()
PagingResult<Site>	getAllSites(ListingContext listingContext)
Folder	getDocumentLibrary(Site site) Get the documents container folder for the given site.
List<Site>	getFavoriteSites()
PagingResult<Site>	getFavoriteSites(ListingContext listingContext)
List<Site>	getPendingSites() Returns a list of join site requests from the current user that have yet to be actioned.
PagingResult<Site>	getPendingSites(ListingContext listingContext) Returns a list of join site requests from the current user that have yet to be actioned.
Site	getSite(String siteShortName)
List<Site>	getSites()
PagingResult<Site>	getSites(ListingContext listingContext)
boolean	isMember(Site site, Person person) Returns true if the person is a member of the specified site.
Site	joinSite(Site site) Adds the current user as a member of the given site with an optional message explaining why they wish to join the site.
Site	leaveSite(Site site) Removes the current user from the given site.
Site	removeFavoriteSite(Site site) Removes the given site from the current users list of favorite sites.
List<Site>	search(String keyword)
PagingResult<Site>	search(String keyword, ListingContext listingContext)
List<Person>	searchMembers(Site site, String keywords)
PagingResult<Person>	searchMembers(Site site, String keywords, ListingContext listingContext)

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_SHORTNAME

static final String SORT_PROPERTY_SHORTNAME

Allowable sorting property : Name of the site.

See Also:

Constant Field Values

SORT_PROPERTY_TITLE

static final String SORT_PROPERTY_TITLE

Allowable sorting property : Title of the document or folder.

Method Detail

getSite

Site getSite(String siteShortName)

Parameters:

siteShortName - : Unique identifier name of the site.

Returns:

Returns a site with the given short name, if the site doesn’t exist null is returned.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getAllSites

List<Site> getAllSites()

Returns:

Return a list of all the sites in the repository the current user has visibility of.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getAllSites

PagingResult<Site> getAllSites(ListingContext listingContext)

Parameters:

listingContext - : Listing context that define the behavior of paging results ListingContext

Returns:

Return a paged list of all the sites in the repository the current user has visibility of.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getSites

List<Site> getSites()

Returns:

Returns a list of sites the current user has a explicit membership to.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getSites

PagingResult<Site> getSites(ListingContext listingContext)

Parameters:

listingContext - : Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a paged list of sites the current user has a explicit membership to.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getFavoriteSites

List<Site> getFavoriteSites()

Returns:

Returns a list of sites the current user has a explicit membership to and has marked as a favourite.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getFavoriteSites

PagingResult<Site> getFavoriteSites(ListingContext listingContext)

Parameters:

listingContext - : Listing context that define the behaviour of paging results ListingContext

Returns:

Returns a paged list of sites the current user has a explicit membership to and has marked as a favourite.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

getDocumentLibrary

Folder getDocumentLibrary(Site site)

Get the documents container folder for the given site.

Parameters:

site - : Unique identifier name of the site.

Returns:

Returns the root folder container to share document library.

Throws:

AlfrescoServiceException - : if network or internal problems occur during the process.

addFavoriteSite

Site addFavoriteSite(Site site)

Adds the given site to the current users list of favorite sites.
It's possible to favorite a site independently of its visibility.

Parameters:

site - : site object

Throws:

AlfrescoServiceException - : if the request can not be completed successfully an exception is thrown with error code SITE_NOT_FAVORITED

Since:

1.1.0

removeFavoriteSite

Site removeFavoriteSite(Site site)

Removes the given site from the current users list of favorite sites.
It's possible to favorite a site independently of its visibility.

Parameters:

site - : site object

Throws:

AlfrescoServiceException - : if the request can not be completed successfully an exception is thrown with error code SITE_NOT_UNFAVORITED.

Since:

1.1.0

joinSite

Site joinSite(Site site)

Adds the current user as a member of the given site with an optional message explaining why they wish to join the site.

Parameters:

site - : site object

Returns:

If the site is moderated, a JoinSiteRequest object is returned.
If the site is public null is returned.

Throws:

AlfrescoServiceException - :
If the current user is already a member of the site or there is a pending join request for the user an exception is thrown with error code SITE_ALREADY_MEMBER.
If the request fails for any other reason an exception is thrown with error code SITE_NOT_JOINED.

Since:

1.1.0

getPendingSites

List<Site> getPendingSites()

Returns a list of join site requests from the current user that have yet to be actioned. An empty list is returned if there are no outstanding requests.

Returns:

: List of site the user wants to join. Empty list if there's no request.

Throws:

AlfrescoServiceException

Since:

1.1.0

getPendingSites

PagingResult<Site> getPendingSites(ListingContext listingContext)

Returns a list of join site requests from the current user that have yet to be actioned. An empty list is returned if there are no outstanding requests.

Returns:

Returns a paged list of sites the current user has requested to be a member.

Throws:

AlfrescoServiceException

Since:

1.2.0

cancelRequestToJoinSite

Site cancelRequestToJoinSite(Site site)

Cancels a previous request to join a site made by the current user.

Parameters:

site - : site object

Throws:

AlfrescoServiceException - : If the request can not be completed successfully an exception is thrown with error code SITE_CANCEL_JOINED.

Since:

1.1.0

leaveSite

Site leaveSite(Site site)

Removes the current user from the given site.

Parameters:

site - : site object

Throws:

AlfrescoServiceException - : If the request can not be completed successfully an exception is thrown with error code SITE_NOT_LEFT or SITE_LAST_MANAGER if the user is the last manager of the site.

Since:

1.1.0

getAllMembers

List<Person> getAllMembers(Site site)

Returns a list of site members.

Parameters:

site -

Returns:

Since:

1.3.0

getAllMembers

PagingResult<Person> getAllMembers(Site site,
                                 ListingContext listingContext)

Returns a paged list of site members.

Parameters:

site -

listingContext -

Returns:

Since:

1.3.0

isMember

boolean isMember(Site site,
               Person person)

Returns true if the person is a member of the specified site.

Parameters:

site -

person -

Returns:

Since:

1.3.0

searchMembers

List<Person> searchMembers(Site site,
                         String keywords)

Parameters:

site -

Returns:

Since:

1.3.0

searchMembers

PagingResult<Person> searchMembers(Site site,
                                 String keywords,
                                 ListingContext listingContext)

Parameters:

site -

Returns:

Since:

1.3.0

search

PagingResult<Site> search(String keyword,
                        ListingContext listingContext)

Parameters:

keyword -

Returns:

Returns a list of sites which matches the current keywords.

Since:

1.4.1

search

List<Site> search(String keyword)

Parameters:

keyword -

Returns:

Returns a list of sites which matches the current keywords.

Since:

1.4.1