eu.ehri.project.models

Interface UserProfile

All Superinterfaces:

Accessible, Accessor, Actioner, Annotatable, Entity, Identifiable, Named, PermissionGrantTarget, Versioned, com.tinkerpop.frames.VertexFrame

All Known Implementing Classes:

UserProfile.Impl

public interface UserProfile
extends Accessor, Actioner, Versioned, Annotatable

A frame class representing a user within the database.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	UserProfile.Impl

Field Summary

Fields

Modifier and Type	Field and Description
static String	FOLLOWER_COUNT
static String	FOLLOWING_COUNT
static String	WATCHING_COUNT

Method Summary

Modifier and Type	Method and Description
void	addBlocked(UserProfile user) Add a user to this user's block list.
void	addFollowing(UserProfile user) Add a user the those this user follows.
void	addWatching(Watchable item) Add an item to this user's watch list.
Iterable<UserProfile>	coGroupMembers() Fetch users who share groups with this user.
Iterable<Annotation>	getAnnotations() Fetch annotations belonging to this user.
Iterable<UserProfile>	getBlocked() Fetch users on this user's block list.
int	getFollowerCount()
Iterable<UserProfile>	getFollowers() Get users who follow this user.
Iterable<UserProfile>	getFollowing() Get users who this user follows.
int	getFollowingCount()
Iterable<Group>	getGroups() Get the groups to which this user belongs.
Iterable<Link>	getLinks() Fetch links belonging to this user.
Iterable<VirtualUnit>	getVirtualUnits() Fetch virtual units created by this user.
Iterable<Watchable>	getWatching() Fetch items this user is watching.
int	getWatchingCount()
boolean	isBlocking(UserProfile user) Ascertain whether this user is blocking another user.
boolean	isFollower(UserProfile otherUser) Ascertain whether the other user is following this user.
boolean	isFollowing(UserProfile otherUser) Ascertain whether this user is following another user.
boolean	isWatching(Watchable item) Ascertain whether this user is watching an item.
void	removeBlocked(UserProfile user) Remove a user from this user's block list.
void	removeFollowing(UserProfile user) Remove a user from those this user follows.
void	removeWatching(Watchable item) Remove an item from this user's watch list.

Methods inherited from interface eu.ehri.project.models.base.Accessor

addPermissionGrant, getAllParents, getParents, getPermissionGrants, isAdmin, isAnonymous

Methods inherited from interface eu.ehri.project.models.base.Identifiable

getIdentifier

Methods inherited from interface eu.ehri.project.models.base.Actioner

getActions, getLatestAction

Methods inherited from interface eu.ehri.project.models.base.Named

getName

Methods inherited from interface eu.ehri.project.models.base.Versioned

getAllPriorVersions, getPriorVersion

Methods inherited from interface eu.ehri.project.models.base.Accessible

addAccessor, getAccessors, getHistory, getLatestEvent, getPermissionScope, getPermissionScopes, hasAccessRestriction, removeAccessor, setPermissionScope

Methods inherited from interface eu.ehri.project.models.base.PermissionGrantTarget

getPermissionGrants

Methods inherited from interface eu.ehri.project.models.base.Entity

as, getId, getProperty, getProperty, getPropertyKeys, getType

Methods inherited from interface com.tinkerpop.frames.VertexFrame

asVertex

Methods inherited from interface eu.ehri.project.models.base.Annotatable

addAnnotation, addAnnotationPart

Field Detail

FOLLOWER_COUNT

static final String FOLLOWER_COUNT

See Also:

Constant Field Values

FOLLOWING_COUNT

static final String FOLLOWING_COUNT

See Also:

Constant Field Values

WATCHING_COUNT

static final String WATCHING_COUNT

See Also:

Constant Field Values

Method Detail

getFollowerCount

int getFollowerCount()

getFollowingCount

int getFollowingCount()

getWatchingCount

int getWatchingCount()

getGroups

Iterable<Group> getGroups()

Get the groups to which this user belongs.

Returns:

an iterable of group frames

getFollowers

Iterable<UserProfile> getFollowers()

Get users who follow this user.

Returns:

an iterable of user frames

getFollowing

Iterable<UserProfile> getFollowing()

Get users who this user follows.

Returns:

an iterable of user frames

addFollowing

void addFollowing(UserProfile user)

Add a user the those this user follows.

Parameters:

user - a user frame

removeFollowing

void removeFollowing(UserProfile user)

Remove a user from those this user follows.

Parameters:

user - a user frame

isFollowing

boolean isFollowing(UserProfile otherUser)

Ascertain whether this user is following another user.

Parameters:

otherUser - a user frame

Returns:

whether this user is following the other

isFollower

boolean isFollower(UserProfile otherUser)

Ascertain whether the other user is following this user.

Parameters:

otherUser - a user frame

Returns:

whether the other user is following this user

getWatching

Iterable<Watchable> getWatching()

Fetch items this user is watching.

Returns:

an iterable of generic item frames

getLinks

Iterable<Link> getLinks()

Fetch links belonging to this user.

Returns:

an iterable of link frames

getAnnotations

Iterable<Annotation> getAnnotations()

Fetch annotations belonging to this user.

Specified by:

getAnnotations in interface Annotatable

Returns:

an iterable of annotation frames

getVirtualUnits

Iterable<VirtualUnit> getVirtualUnits()

Fetch virtual units created by this user.

Returns:

an iterable of virtual unit frames

addWatching

void addWatching(Watchable item)

Add an item to this user's watch list.

Parameters:

item - a generic item frame

removeWatching

void removeWatching(Watchable item)

Remove an item from this user's watch list.

Parameters:

item - a generic item frame

addBlocked

void addBlocked(UserProfile user)

Add a user to this user's block list.

Parameters:

user - a user frame

removeBlocked

void removeBlocked(UserProfile user)

Remove a user from this user's block list.

Parameters:

user - a user frame

getBlocked

Iterable<UserProfile> getBlocked()

Fetch users on this user's block list.

Returns:

an iterable of user frames

isBlocking

boolean isBlocking(UserProfile user)

Ascertain whether this user is blocking another user.

Parameters:

user - a user frame

Returns:

whther the other user is on this user's block list

coGroupMembers

Iterable<UserProfile> coGroupMembers()

Fetch users who share groups with this user.

Returns:

an iterable of user frames

isWatching

boolean isWatching(Watchable item)

Ascertain whether this user is watching an item.

Parameters:

item - a generic item frame

Returns:

whether the item is in this user's watch list