Package org.exoplatform.social.core.identity

Class ProfileFilterListAccess

java.lang.Object

org.exoplatform.social.core.identity.ProfileFilterListAccess

All Implemented Interfaces:

org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity>

public class ProfileFilterListAccess
extends Object
implements org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity>

ListAccess is used in loading identity with the input profile filter. With this list we can manage the size of returned list by offset and limit.

Since:

1.2.0-GA

Author:

hanhvq (gmail dot com)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ProfileFilterListAccess.Type	The Profile list access Type Enum.

Constructor Summary

Constructors

Constructor	Description
ProfileFilterListAccess(org.exoplatform.social.core.storage.api.IdentityStorage identityStorage, String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, boolean forceLoadProfile)	Constructor.
ProfileFilterListAccess(org.exoplatform.social.core.storage.api.IdentityStorage identityStorage, String providerId, org.exoplatform.social.core.profile.ProfileFilter profileFilter, boolean forceLoadProfile, ProfileFilterListAccess.Type type)	Constructor.

Method Summary

Modifier and Type	Method	Description
String	getProviderId()	Gets provider id.
int	getSize()
org.exoplatform.social.core.identity.model.Identity[]	load(int offset, int limit)
void	setProviderId(String providerId)	Sets provider id.

Methods inherited from class java.lang.Object

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

Constructor Details

ProfileFilterListAccess

public ProfileFilterListAccess(org.exoplatform.social.core.storage.api.IdentityStorage identityStorage,
 String providerId,
 org.exoplatform.social.core.profile.ProfileFilter profileFilter,
 boolean forceLoadProfile)

Constructor.

Parameters:

identityStorage -

providerId - Id of provider.

profileFilter - Filter object as extract's condition.

forceLoadProfile - True then force to load profile.

ProfileFilterListAccess

public ProfileFilterListAccess(org.exoplatform.social.core.storage.api.IdentityStorage identityStorage,
 String providerId,
 org.exoplatform.social.core.profile.ProfileFilter profileFilter,
 boolean forceLoadProfile,
 ProfileFilterListAccess.Type type)

Constructor.

Parameters:

identityStorage - The identity storage

providerId - Id of provider.

profileFilter - Filter object as extract's condition.

forceLoadProfile - True then force to load profile.

type - Type of which list provide for

Method Details

getProviderId

public String getProviderId()

Gets provider id.

Returns:

setProviderId

public void setProviderId(String providerId)

Sets provider id.

Parameters:

providerId -

load

public org.exoplatform.social.core.identity.model.Identity[] load(int offset,
 int limit)
                                                           throws Exception,
IllegalArgumentException

Specified by:

load in interface org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity>

Throws:

Exception

IllegalArgumentException

getSize

public int getSize()
            throws Exception

Specified by:

getSize in interface org.exoplatform.commons.utils.ListAccess<org.exoplatform.social.core.identity.model.Identity>

Throws:

Exception