## Uses of Class
org.silverpeas.components.community.model.CommunityMembership

- Packages that use CommunityMembership
  Package | Description
  --- | ---
  org.silverpeas.components.community.model | The business objects used to represent a community of users and its members.
  org.silverpeas.components.community.repository | Persistence repository for the community of users and for the members of the communities.

- - ### Uses of CommunityMembership in org.silverpeas.components.community.model

    Methods in org.silverpeas.components.community.model that return CommunityMembership
    Modifier and Type | Method | Description
    --- | --- | ---
    `CommunityMembership` | CommunityOfUsers.`addAsAPendingMember​(org.silverpeas.core.admin.user.model.User user)` | Adds the specified user as a member pending his membership to this community to be committed.
    `CommunityMembership` | CommunityOfUsers.`addAsMember​(org.silverpeas.core.admin.user.model.User user, org.silverpeas.core.admin.user.model.SilverpeasRole role)` | Adds the specified user as a member of this community of users and with the specified role.
    `CommunityMembership` | CommunityOfUsers.`refuseMembership​(org.silverpeas.core.admin.user.model.User user)` | Refuses the membership application of the specified user to this community of users.
    `CommunityMembership` | CommunityOfUsers.`removeMembership​(org.silverpeas.core.admin.user.model.User user)` | Removes the membership of the specified user to this community of users.

    Methods in org.silverpeas.components.community.model that return types with arguments of type CommunityMembership
    Modifier and Type | Method | Description
    --- | --- | ---
    `Optional<CommunityMembership>` | CommunityMembershipsProvider.`get​(String membershipId)` | Gets the membership to the community of users with the specified unique identifier.
    `Optional<CommunityMembership>` | CommunityMembershipsProvider.`get​(org.silverpeas.core.admin.user.model.User user)` | Gets the membership of the specified user to the community of users.
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipsProvider.`getHistory​(org.silverpeas.core.admin.PaginationPage page)` | Gets the history of memberships to the community of users that are within the specified pagination page.
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipsProvider.`getInRange​(org.silverpeas.core.admin.PaginationPage page)` | Gets all the committed memberships to the community of users that are within the specified pagination page.
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipsProvider.`getPending​(org.silverpeas.core.admin.PaginationPage page)` | Gets all pending memberships to the community of users.

  - ### Uses of CommunityMembership in org.silverpeas.components.community.repository

    Methods in org.silverpeas.components.community.repository that return types with arguments of type CommunityMembership
    Modifier and Type | Method | Description
    --- | --- | ---
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipRepository.CommunityMembershipsTable.`getAll​(org.silverpeas.core.admin.PaginationPage page)` | Gets all the memberships registered into this table and included in the specified pagination page.
    `default org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipRepository.`getAll()` |
    `List<CommunityMembership>` | CommunityMembershipRepository.CommunityMembershipsTable.`getAllMembers()` | Gets all the committed or pending memberships to the community of users.
    `Optional<CommunityMembership>` | CommunityMembershipRepository.CommunityMembershipsTable.`getByUser​(org.silverpeas.core.admin.user.model.User user)` | Gets the membership to the community of the specified user.
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipRepository.CommunityMembershipsTable.`getMembers​(org.silverpeas.core.admin.PaginationPage page)` | Gets the committed memberships of the specified community included in the specified pagination page.
    `org.silverpeas.core.util.SilverpeasList<CommunityMembership>` | CommunityMembershipRepository.CommunityMembershipsTable.`getPending​(org.silverpeas.core.admin.PaginationPage page)` | Gets the membership that are pending and included in the specified pagination page.

    Methods in org.silverpeas.components.community.repository with parameters of type CommunityMembership
    Modifier and Type | Method | Description
    --- | --- | ---
    `default void` | CommunityMembershipRepository.`delete​(CommunityMembership... entity)` |

    Method parameters in org.silverpeas.components.community.repository with type arguments of type CommunityMembership
    Modifier and Type | Method | Description
    --- | --- | ---
    `default void` | CommunityMembershipRepository.`delete​(List<CommunityMembership> entities)` |