UserIdentityWrapper (SiteVision API)

All Superinterfaces:

Wrapper<Node>
```
public interface UserIdentityWrapper
extends Wrapper<Node>
```
User identity wrapper interface.
This wrapper provides methods to check and update the social network (i.e. contacts and collaboration groups) of a (wrapped) user identity.

Note that a disabled user identity is prohibited to execute some of the mutating/write operations.

An instance of the SiteVision class implementing this interface can be obtained via UserFactory.getUserIdentityWrapper(javax.jcr.Node). See UserFactory for how to obtain an instance of the UserFactory interface.

Since:

SiteVision 3.6

Author:

Magnus Lövgren

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`addContact(Node aUserIdentity)` Adds a contact for the wrapped user identity.
`boolean`	`followGroup(Node aCollaborationGroup)` The wrapped user identity follows/eavesdrops a collaboration group.
`java.util.Set<Node>`	`getCollaborationGroups()` Gets the collaboration groups of the wrapped user identity.
`java.util.Set<Node>`	`getContacts()` Gets the contacts of the wrapped user identity.
`java.util.Set<Node>`	`getFollowedGroups()` Gets the collaboration groups the wrapped user identity follows/eavesdrops.
`Node`	`getProfileImage()` Gets the profile image of the wrapped user identity.
`Node`	`getProfileImagesFolder()` Gets the profile images folder of the wrapped user identity.
`Node`	`getUserIdentity()` Gets the wrapped user identity.
`boolean`	`isAdminOf(Node aCollaborationGroup)` Checks if wrapped user identity is admin of a collaboration group.
`boolean`	`isContact(Node aUserIdentity)` Checks if the wrapped user identity is contact with a specified user identity.
`boolean`	`isDisabled()` Checks if the wrapped user identity is disabled or not.
`boolean`	`isFollowing(Node aCollaborationGroup)` Checks if wrapped user identity is following/eavesdropping a collaboration group.
`boolean`	`isMemberOf(Node aCollaborationGroup)` Checks if wrapped user identity is member of a collaboration group.
`boolean`	`joinGroup(Node aCollaborationGroup)` The wrapped user identity joins a collaboration group.
`boolean`	`leaveGroup(Node aCollaborationGroup)` The wrapped user identity leaves a collaboration group.
`boolean`	`removeContact(Node aUserIdentity)` Removes a contact of the wrapped user identity.
`boolean`	`setDisabled(boolean aDisabled)` Sets the availability of the wrapped user identity.
`boolean`	`setHidden(boolean aHidden)` Sets the visibility of the wrapped user identity in search results.
`boolean`	`setProfileImage(Node aProfileImage)` Sets the profile image of the wrapped user identity.
`boolean`	`unfollowGroup(Node aCollaborationGroup)` The wrapped user identity stops following/eavesdropping a collaboration group.

Methods inherited from interface senselogic.sitevision.api.base.Wrapper
unwrap

- Method Detail
  - getContacts
```
java.util.Set<Node> getContacts()
```
    Gets the contacts of the wrapped user identity.
    
    Returns:
    
    the contacts of the wrapped user identity. Never null.
  - isContact
```
boolean isContact(Node aUserIdentity)
```
    Checks if the wrapped user identity is contact with a specified user identity.
    
    Parameters:
    
    aUserIdentity - the user identity to check
    
    Returns:
    
    true if aUserIdentity is a contact of the wrapped user identity, false otherwise
  - addContact
```
boolean addContact(Node aUserIdentity)
```
    Adds a contact for the wrapped user identity.
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To be allowed to add a contact for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_USER_IDENTITIES on current page.
    
    Parameters:
    
    aUserIdentity - the user identity (or user) that should be added as contact for the wrapped user identity
    
    Returns:
    
    true if aUserIdentity was added as contact for the wrapped user identity, false otherwise
  - removeContact
```
boolean removeContact(Node aUserIdentity)
```
    Removes a contact of the wrapped user identity.
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To be allowed to remove a contact for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_USER_IDENTITIES on current page.
    
    Parameters:
    
    aUserIdentity - the user identity (or user) that should be added as contact for the wrapped user identity
    
    Returns:
    
    true if aUserIdentity was added as contact for the wrapped user identity, false otherwise
  - getCollaborationGroups
```
java.util.Set<Node> getCollaborationGroups()
```
    Gets the collaboration groups of the wrapped user identity.
    Permission note! The returned set will only contain the collaboration groups that that current user is allowed to read (i.e. PermissionUtil.Permission.READ).
    
    Returns:
    
    the accessible collaboration groups of the wrapped user identity. Never null.
  - isAdminOf
```
boolean isAdminOf(Node aCollaborationGroup)
```
    Checks if wrapped user identity is admin of a collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to check
    
    Returns:
    
    true if the wrapped user identity is admin of aCollaborationGroup, false otherwise
  - isMemberOf
```
boolean isMemberOf(Node aCollaborationGroup)
```
    Checks if wrapped user identity is member of a collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to check
    
    Returns:
    
    true if the wrapped user identity is member of aCollaborationGroup, false otherwise
  - leaveGroup
```
boolean leaveGroup(Node aCollaborationGroup)
```
    The wrapped user identity leaves a collaboration group.
    Only members can leave a collaboration group, i.e. the leave attempt will be ignored if wrapped user identity isn't a member of specified collaboration group. Note that a group admin is also a group member so leaving a collaboration group might in fact also remove an admin, but last admin will never be removed. Collaboration groups that are inactive can not be leaved.
    
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To remove group membership for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP and PermissionUtil.Permission.READ on the collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to leave
    
    Returns:
    
    true if the leave operation succeeded, false otherwise
  - joinGroup
```
boolean joinGroup(Node aCollaborationGroup)
```
    The wrapped user identity joins a collaboration group.
    Only non-members can join a collaboration group, i.e. the join attempt will be ignored if wrapped user identity already are a member of specified collaboration group. Collaboration groups that are inactive can not be joined.
    
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To join a collaboration group for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP and PermissionUtil.Permission.READ on the collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to join
    
    Returns:
    
    true if the join operation succeeded, false otherwise
  - followGroup
```
boolean followGroup(Node aCollaborationGroup)
```
    The wrapped user identity follows/eavesdrops a collaboration group.
    Only non-members can follow a collaboration group, i.e. the follow attempt will be ignored if wrapped user identity already are a member of specified collaboration group. Collaboration groups that are inactive or closed can not be followed.
    
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To follow a collaboration group for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP and PermissionUtil.Permission.READ on the collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to follow
    
    Returns:
    
    true if the follow operation succeeded, false otherwise
    
    Since:
    
    SiteVision 4.1
  - getFollowedGroups
```
java.util.Set<Node> getFollowedGroups()
```
    Gets the collaboration groups the wrapped user identity follows/eavesdrops.
    Permission note! The returned set will only contain active collaboration groups that that current user is allowed to read (i.e. PermissionUtil.Permission.READ).
    
    Returns:
    
    the accessible collaboration groups the wrapped user identity follows. Never null.
    
    Since:
    
    SiteVision 4.1
  - isFollowing
```
boolean isFollowing(Node aCollaborationGroup)
```
    Checks if wrapped user identity is following/eavesdropping a collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to check
    
    Returns:
    
    true if the wrapped user identity is following aCollaborationGroup, false otherwise
    
    Since:
    
    SiteVision 4.1
  - unfollowGroup
```
boolean unfollowGroup(Node aCollaborationGroup)
```
    The wrapped user identity stops following/eavesdropping a collaboration group.
    Only followers can stop following a collaboration group, i.e. the unfollow attempt will be ignored if wrapped user identity isn't a follower of specified collaboration group. Collaboration groups that are inactive can not be unfollowed.
    
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To unfollow a group for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_COLLABORATION_GROUP and PermissionUtil.Permission.READ on the collaboration group.
    
    Parameters:
    
    aCollaborationGroup - the collaboration group (or collaboration group page) to stop following
    
    Returns:
    
    true if the unfollow operation succeeded, false otherwise
    
    Since:
    
    SiteVision 4.1
  - getProfileImage
```
Node getProfileImage()
```
    Gets the profile image of the wrapped user identity.
    Note! This method returns the 'raw' profile image (i.e. a node of type sv:image) that the user has uploaded. For buddy icons, see BuddyIconRenderer.
    
    Returns:
    
    the profile image or null
    
    Since:
    
    SiteVision 4.0
  - getProfileImagesFolder
```
Node getProfileImagesFolder()
```
    Gets the profile images folder of the wrapped user identity.
    
    Returns:
    
    the profile images folder or null
    
    Since:
    
    SiteVision 4.2
  - setProfileImage
```
boolean setProfileImage(Node aProfileImage)
```
    Sets the profile image of the wrapped user identity.
    This method sets the active profile image, i.e. determines which profile image that should be used. To create a new profile image (i.e. new binary data), you would typically use a method in ImageUtil first.
    
    Model note! A profile image must be a node of type sv:image and a child of the profile images folder of the wrapped user identity. The profile images folder is available via getProfileImagesFolder().
    
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To set the profile image for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_USER_IDENTITIES on current page.
    
    Parameters:
    
    aProfileImage - the profile image
    
    Returns:
    
    true if the set operation succeeded, false otherwise
    
    Since:
    
    SiteVision 4.2
  - setHidden
```
boolean setHidden(boolean aHidden)
```
    Sets the visibility of the wrapped user identity in search results.
    Permission note! This mutating operation is not allowed for a wrapped user identity that is disabled. To update the hidden property for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_USER_IDENTITIES on current page.
    
    Parameters:
    
    aHidden - true if the wrapped user identity should be hidden, false otherwise
    
    Returns:
    
    true if the set operation succeeded, false otherwise
    
    Since:
    
    SiteVision 4.2
  - setDisabled
```
boolean setDisabled(boolean aDisabled)
```
    Sets the availability of the wrapped user identity.
    Permission note! To update the disabled property for the wrapped user identity, current user must match the wrapped user identity (i.e. "is yourself") - or have PermissionUtil.Permission.MANAGE_USER_IDENTITIES on current page.
    
    Parameters:
    
    aDisabled - true if the wrapped user identity should be disabled, false otherwise
    
    Returns:
    
    true if the set operation succeeded, false otherwise
    
    Since:
    
    SiteVision 4.3
  - isDisabled
```
boolean isDisabled()
```
    Checks if the wrapped user identity is disabled or not.
    This is a convenience method the check the boolean value of the disabled property of the wrapped user identity. Note that a disabled user identity is not allowed to perform any mutating/write operations except setDisabled(boolean).
    
    Returns:
    
    true if the wrapped user identity is disabled, false if not
    
    Since:
    
    SiteVision 4.3
  - getUserIdentity
```
Node getUserIdentity()
```
    Gets the wrapped user identity.
    Note! This method is equivalent with Wrapper.unwrap() if this wrapper is created with a sv:userIdentity node.
    
    Returns:
    
    the wrapped user identity
    
    Since:
    
    SiteVision 4.3

SiteVision - Portal and Content Management Made Easy
SiteVision is an advanced Java enterprise portal product and a portlet container (JSR 286) that implements Java Content Repository (JSR 283).

Interface UserIdentityWrapper

Method Summary

Methods inherited from interface senselogic.sitevision.api.base.Wrapper

Method Detail

getContacts

isContact

addContact

removeContact

getCollaborationGroups

isAdminOf

isMemberOf

leaveGroup

joinGroup

followGroup

getFollowedGroups

isFollowing

unfollowGroup

getProfileImage

getProfileImagesFolder

setProfileImage

setHidden

setDisabled

isDisabled

getUserIdentity