# Index

A B C D E G H I J L M N O P R S U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

## A

adminMustValidateNewMember() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
appHomepage(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
  Prepares the rendering of the home page.
applyWith(CommunityOfUsers) - Method in interface org.silverpeas.components.community.web.CommunityWebResource.WebFunction

## B

beforeRequestProcessing(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController

## C

canValidateNewMember() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
COMMUNITY_MANAGEMENT - Static variable in class org.silverpeas.components.community.web.html.JavascriptPluginInclusion
  Silverpeas plugin dedicated to management of a community.
COMMUNITY_SUBSCRIPTION - Static variable in class org.silverpeas.components.community.web.html.JavascriptPluginInclusion
  Silverpeas plugin dedicated to subscription of a community.
CommunityMembershipEntities - Class in org.silverpeas.components.community.web
  A collection of web entities representing each a membership to a community.
CommunityMembershipEntities() - Constructor for class org.silverpeas.components.community.web.CommunityMembershipEntities
CommunityMembershipEntities(SilverpeasList<CommunityMembershipEntity>) - Constructor for class org.silverpeas.components.community.web.CommunityMembershipEntities
CommunityMembershipEntity - Class in org.silverpeas.components.community.web
  Web representation of a membership as transmitted by the REST web resources.
CommunityMembershipEntity() - Constructor for class org.silverpeas.components.community.web.CommunityMembershipEntity
CommunityMembershipResource - Class in org.silverpeas.components.community.web
  The memberships to a community of users exposed as a resource through the Web.
CommunityMembershipResource() - Constructor for class org.silverpeas.components.community.web.CommunityMembershipResource
CommunityOfUsersEntity - Class in org.silverpeas.components.community.web
  It represents the Web entity of a `CommunityOfUsers` state from which a representation (usually in JSON) can be generated.
CommunityOfUsersEntity() - Constructor for class org.silverpeas.components.community.web.CommunityOfUsersEntity
CommunityOfUsersResource - Class in org.silverpeas.components.community.web
  A REST-based Web resource representing the communities of users.
CommunityOfUsersResource() - Constructor for class org.silverpeas.components.community.web.CommunityOfUsersResource
CommunityWebController - Class in org.silverpeas.components.community.control
  The Web Component Controller of the application.
CommunityWebController(MainSessionController, ComponentContext) - Constructor for class org.silverpeas.components.community.control.CommunityWebController
  Standard Web Controller Constructor.
CommunityWebManager - Class in org.silverpeas.components.community
  WEB manager which allows to centralize code to be used by REST Web Services and Web Component Controller.
CommunityWebManager() - Constructor for class org.silverpeas.components.community.CommunityWebManager
CommunityWebRequestContext - Class in org.silverpeas.components.community.control
  The execution context of an incoming HTTP request in regard to the application.
CommunityWebRequestContext() - Constructor for class org.silverpeas.components.community.control.CommunityWebRequestContext
CommunityWebResource - Class in org.silverpeas.components.community.web
  Base class of all the resources in the community application exposed through the Web.
CommunityWebResource() - Constructor for class org.silverpeas.components.community.web.CommunityWebResource
CommunityWebResource.WebFunction<R> - Interface in org.silverpeas.components.community.web
convertHistoryList(SilverpeasList<U>) - Static method in class org.silverpeas.components.community.control.HistoryItemUIEntity
  Converts the given data list into a `SilverpeasList` of item wrapping the `User`.
convertList(SilverpeasList<U>, Set<String>) - Static method in class org.silverpeas.components.community.control.MemberUIEntity
  Converts the given data list into a `SilverpeasList` of item wrapping the `User`.

## D

displayCharterOnSpaceHomepage() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
displayNbMembersForNonMembers() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext

## E

editSpaceHomePage(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
endMembershipOf(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
endMembershipOf(CommunityOfUsers, User) - Method in class org.silverpeas.components.community.CommunityWebManager
  Makes the given user leaving the given community.

## G

get() - Static method in class org.silverpeas.components.community.CommunityWebManager
  Gets the singleton instance of the provider.
getActualMemberships(String) - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
  Gets all the actual memberships to the community of users.
getAllMemberships(String) - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
  Gets all the memberships to the community of users, whatever the status of them.
getCharterURL() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
getCommunity() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
getCommunity() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntity
  Gets the URI of the community of user to which this membership is related.
getCommunityOfUsers() - Method in class org.silverpeas.components.community.web.CommunityOfUsersResource
  Gets the JSON representation of the community of users managed by the component instance of id `componentInstanceId`.
getComponentId() - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
getComponentId() - Method in class org.silverpeas.components.community.web.CommunityOfUsersResource
getFirstName() - Method in class org.silverpeas.components.community.web.UserEntity
  Gets the first name of this user.
getHistory(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
getHistory(CommunityOfUsers, PaginationPage) - Method in class org.silverpeas.components.community.CommunityWebManager
  Gets history of the given community.
getHomePage() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
  Gets the home page of this community of users for the members.
getId() - Method in class org.silverpeas.components.community.control.MemberUIEntity
getId() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
  Gets the unique identifier of this community of users.
getLastName() - Method in class org.silverpeas.components.community.web.UserEntity
  Gets the last name of this user.
getMembers(CommunityOfUsers, PaginationPage) - Method in class org.silverpeas.components.community.CommunityWebManager
  Gets members of the given community.
getMembership(String) - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
  Gets a given existing membership to the community of users or throw `NotFoundException` if no such membership exists.
getMemberships() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntities
  Gets all the memberships contained in this collection.
getMemberships() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
  Gets the URI at which the memberships to this community can be requested.
getMembersToValidate(CommunityOfUsers, PaginationPage) - Method in class org.silverpeas.components.community.CommunityWebManager
  Gets members pending validation of the given community.
getPendingMemberships(String) - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
  Gets all the memberships to the community of users pending for validation.
getRealSize() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntities
  Gets the total real count of memberships matching the request.
getResourceBasePath() - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
getResourceBasePath() - Method in class org.silverpeas.components.community.web.CommunityWebResource
  Gets the relative base path at which are all exposed the resources in the community application.
getSize() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntities
  Gets the actual count of memberships contained in this collection.
getSpaceId() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
  Gets the unique identifier of the collaborative space for which this community of users is.
getStatus() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntity
  Gets the status of this membership.
getStatusLabel(String) - Method in class org.silverpeas.components.community.control.MemberUIEntity
getURI() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntities
getURI() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntity
getURI() - Method in class org.silverpeas.components.community.web.CommunityOfUsersEntity
getURI() - Method in class org.silverpeas.components.community.web.UserEntity
  Gets the URI at which additional information about this user can be got.
getUser() - Method in class org.silverpeas.components.community.control.MemberUIEntity
  Gets the member user.
getUser() - Method in class org.silverpeas.components.community.web.CommunityMembershipEntity
  Gets the user related by this membership to a community.
getUserMembership(String) - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
  Gets the membership of the specified user or throw `NotFoundException` if no such membership to the community of users exists.
getUserRoleOn(CommunityOfUsers) - Method in class org.silverpeas.components.community.CommunityWebManager
  Gets the roles the current requester has on the given community.
getUserRoles() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
getUserRoles() - Method in class org.silverpeas.components.community.web.CommunityWebResource
  Gets the roles the user requesting currently this web resource plays in the community of users.
getWebManager() - Method in class org.silverpeas.components.community.web.CommunityWebResource
  Gets the Web Manager to use to fulfill the incoming request.

## H

HISTORY_ARRAYPANE_IDENTIFIER - Static variable in class org.silverpeas.components.community.control.CommunityWebController
HistoryItemUIEntity - Class in org.silverpeas.components.community.control
  UI item for a `User` instance.
home(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
  Prepares the rendering of the home page.

## I

init() - Method in class org.silverpeas.components.community.web.html.JavascriptPluginInclusion
initURIBuilder() - Method in class org.silverpeas.components.community.web.CommunityWebResource
initWebResourceUri() - Method in class org.silverpeas.components.community.web.CommunityMembershipResource
isAdmin() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
isMember() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
isMemberOf(CommunityOfUsers) - Method in class org.silverpeas.components.community.CommunityWebManager
  Indicates if the current requester is a member.
isMembershipPending() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext
isMembershipPendingFor(CommunityOfUsers) - Method in class org.silverpeas.components.community.CommunityWebManager
  Indicates if the current requester has membership pending validation.
isSpaceHomePage() - Method in class org.silverpeas.components.community.control.CommunityWebRequestContext

## J

JavascriptPluginInclusion - Class in org.silverpeas.components.community.web.html
JavascriptPluginInclusion() - Constructor for class org.silverpeas.components.community.web.html.JavascriptPluginInclusion
join(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
join(CommunityOfUsers) - Method in class org.silverpeas.components.community.CommunityWebManager
  Makes the current user joining the given community.

## L

leave(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
leave(CommunityOfUsers, int, String, boolean) - Method in class org.silverpeas.components.community.CommunityWebManager
  Makes the current user leaving the given community.
leftOn() - Method in class org.silverpeas.components.community.control.HistoryItemUIEntity
listMembers(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController

## M

MEMBER_LIST_ARRAYPANE_IDENTIFIER - Static variable in class org.silverpeas.components.community.control.CommunityWebController
memberOn() - Method in class org.silverpeas.components.community.control.MemberUIEntity
MemberUIEntity - Class in org.silverpeas.components.community.control
  UI item for a `User` instance.

## N

NO_PAGINATION - Static variable in class org.silverpeas.components.community.CommunityWebManager
NO_PAGINATION - Static variable in class org.silverpeas.components.community.web.CommunityWebResource

## O

onInstantiation(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
  This method is called one times once this web component controller is instantiated for a given user.
org.silverpeas.components.community - package org.silverpeas.components.community
  Silverpeas Web Application Component to manage a community of users for a collaborative space.
org.silverpeas.components.community.control - package org.silverpeas.components.community.control
  Provides the Web controller implementation with which the HTML pages of the application interact.
org.silverpeas.components.community.web - package org.silverpeas.components.community.web
  Provides the REST-based web services with which anyone can communicate with an application instance to get information about a community of users and its members.
org.silverpeas.components.community.web.html - package org.silverpeas.components.community.web.html

## P

process(CommunityWebResource.WebFunction<T>) - Method in class org.silverpeas.components.community.web.CommunityWebResource
  Processes the specified web function behalf the community of users concerned by the incoming request.

## R

refusedOn() - Method in class org.silverpeas.components.community.control.HistoryItemUIEntity
requestedMembershipOn() - Method in class org.silverpeas.components.community.control.MemberUIEntity
RESOURCE_NAME - Static variable in class org.silverpeas.components.community.web.CommunityMembershipResource
RESOURCE_NAME - Static variable in class org.silverpeas.components.community.web.CommunityWebResource

## S

setDisplayCharterOnSpaceHomepage(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
setDisplayCharterOnSpaceHomepage(CommunityOfUsers, boolean) - Method in class org.silverpeas.components.community.CommunityWebManager
  Saves into instance parameter of the given community the value of parameter 'displayCharterOnSpaceHomepage'.
spaceHomepageProxy(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
  Prepares the rendering of the home page.

## U

updateCommunityOfUsers(CommunityOfUsersEntity) - Method in class org.silverpeas.components.community.web.CommunityOfUsersResource
  Updates the community of users with the properties of the specified web entity representing the new state of the community.
UserEntity - Class in org.silverpeas.components.community.web
  The user related by a membership to a community.
UserEntity() - Constructor for class org.silverpeas.components.community.web.UserEntity

## V

validate(CommunityWebRequestContext) - Method in class org.silverpeas.components.community.control.CommunityWebController
validateRequestOf(User, CommunityOfUsers, boolean, String) - Method in class org.silverpeas.components.community.CommunityWebManager
  Validates the membership request of user given in parameters on specified community.

A B C D E G H I J L M N O P R S U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form