Package org.vrspace.server.obj

Class GroupMember

java.lang.Object
org.vrspace.server.obj.Entity
org.vrspace.server.obj.GroupMember
@Node public class GroupMember extends Entity
Represents a membership of a user in a group
Author:
joe

  • Constructor Details

    • GroupMember

      public GroupMember()

    • GroupMember

      public GroupMember(@NonNull @NonNull UserGroup group, @NonNull @NonNull Client client)

  • Method Details

    • joined

      public boolean joined()

    • invite

      public GroupMember invite(Client sponsor)
      Set pendingInvite to random UUID, update the timestamp.
      Parameters:
      sponsor - the client that sends the invite
      Returns:
      this

    • request

      public GroupMember request()
      Set pendingRequest to random UUID, update the timestamp
      Returns:
      this

    • accept

      public GroupMember accept()
      Accept the invitation to the group.
      Returns:
      this

    • allow

      public GroupMember allow(Client sponsor)
      Allow a member that asked to join into the group
      Parameters:
      sponsor - the client that accepted the membership request
      Returns:
      this

    • getGroup

      @NonNull public @NonNull UserGroup getGroup()

    • getClient

      @NonNull public @NonNull Client getClient()

    • getPendingInvite

      public String getPendingInvite()
      Pending invitation, if any

    • getPendingRequest

      public String getPendingRequest()
      Pending request to join, if any

    • getSponsor

      public Client getSponsor()
      The client that invited/approved (sponsored) the member; may be null, or maybe point to non-existing client. Thus, valid only short term.

    • getLastUpdate

      public Instant getLastUpdate()
      Time stamp of last membership update, be it invite, request, or joining the group

    • getLastRead

      public Instant getLastRead()

    • setGroup

      public void setGroup(@NonNull @NonNull UserGroup group)

    • setClient

      public void setClient(@NonNull @NonNull Client client)

    • setPendingInvite

      public void setPendingInvite(String pendingInvite)
      Pending invitation, if any

    • setPendingRequest

      public void setPendingRequest(String pendingRequest)
      Pending request to join, if any

    • setSponsor

      public void setSponsor(Client sponsor)
      The client that invited/approved (sponsored) the member; may be null, or maybe point to non-existing client. Thus, valid only short term.

    • setLastUpdate

      public void setLastUpdate(Instant lastUpdate)
      Time stamp of last membership update, be it invite, request, or joining the group

    • setLastRead

      public void setLastRead(Instant lastRead)

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Entity

    • canEqual

      protected boolean canEqual(Object other)
      Overrides:
      canEqual in class Entity

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Entity

    • toString

      public String toString()
      Overrides:
      toString in class Entity