com.adobe.cq.social.members.api

Interface CommunityMemberGroupProfile

public interface CommunityMemberGroupProfile

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	PROFILE_PATH Constant for the path to the group profile.
static java.lang.String	RESOURCE_TYPE

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthorizableID() Returns the ID of the authorizable this user properties belong to.
java.lang.String	getDisplayName() Calculate a display name from this UserProfile instance.
SocialAuthorizable[]	getMembers() Get the members of a group.
java.lang.Integer	getNumberOfMembers()
java.util.Map<java.lang.String,java.lang.String>	getParentGroups()
java.util.Map<java.lang.String,java.lang.String>	getProfileProperties() Get properties from this UserProfile instance.
Resource	getResource(java.lang.String relativePath) Retrieve the resource at the specified path relative to this instance.
UserProperties	getUserProperties()
boolean	isMayEdit() Check if this UserProfile instance can be edited by current session.

Field Detail

RESOURCE_TYPE

static final java.lang.String RESOURCE_TYPE

See Also:

Constant Field Values

PROFILE_PATH

static final java.lang.String PROFILE_PATH

Constant for the path to the group profile.

See Also:

Constant Field Values

Method Detail

getAuthorizableID

java.lang.String getAuthorizableID()

Returns the ID of the authorizable this user properties belong to.

Returns:

the ID of the authorizable this user properties belong to.

getDisplayName

java.lang.String getDisplayName()
                         throws RepositoryException

Calculate a display name from this UserProfile instance.

Returns:

Implementation specific display name as stored in this user properties instance or some implementation specific default.

Throws:

RepositoryException - If an error occurs.

getParentGroups

java.util.Map<java.lang.String,java.lang.String> getParentGroups()

Returns:

Get the parent groups.

getMembers

SocialAuthorizable[] getMembers()

Get the members of a group.

Returns:

the members of a group

getNumberOfMembers

java.lang.Integer getNumberOfMembers()

Returns:

number of members

getResource

Resource getResource(java.lang.String relativePath)
              throws RepositoryException

Retrieve the resource at the specified path relative to this instance.

Parameters:

relativePath - Relative path to the resource to be retrieved.

Returns:

The resource at the specified relative path or null if the the path cannot be resolved to a resource.

Throws:

RepositoryException - If an error occurs.

getProfileProperties

java.util.Map<java.lang.String,java.lang.String> getProfileProperties()

Get properties from this UserProfile instance.

Returns:

properties.

isMayEdit

boolean isMayEdit()

Check if this UserProfile instance can be edited by current session.

Returns:

true if current session can edit the user profile.

getUserProperties

UserProperties getUserProperties()