org.alfresco.mobile.android.api.services

Interface PersonService

All Superinterfaces:

android.os.Parcelable, Service

All Known Implementing Classes:

AbstractPersonService, CloudPersonServiceImpl, OnPremisePersonServiceImpl, PublicAPIPersonServiceImpl

public interface PersonService
extends Service

The PersonService can be used to get informations about people.
The PersonService is responsible for all of the following:

• Obtaining a reference to the Person node for a given user name

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 interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Method Summary

Methods

Modifier and Type	Method and Description
ContentFile	getAvatar(Person person)
Person	getPerson(String personIdentifier)
Person	refresh(Person person) Returns the latest (and complete) set of properties for the provided person.
List<Person>	search(String keyword) Returns a list of persons which respect the keyword.
PagingResult<Person>	search(String keyword, ListingContext listingContext) Returns a paged list of persons which respect the keyword.

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

clear

Methods inherited from interface android.os.Parcelable

describeContents, writeToParcel

Method Detail

getPerson

Person getPerson(String personIdentifier)

Parameters:

personIdentifier - : unique identifier of a person

Returns:

Returns a Person object representing the user with the given username.

Throws:

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

getAvatar

ContentFile getAvatar(Person person)

Parameters:

person -

Returns:

Returns a ContentFile object representing the avatar of the given person, null is returned if the person does not have an avatar.

Throws:

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

search

List<Person> search(String keyword)

Returns a list of persons which respect the keyword.

Parameters:

keyword -

Returns:

Since:

1.3

search

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

Returns a paged list of persons which respect the keyword.

Parameters:

keyword -

listingContext -

Returns:

Since:

1.3

refresh

Person refresh(Person person)

Returns the latest (and complete) set of properties for the provided person.

Parameters:

person -

Returns:

Since:

1.3.0