org.xwiki.wiki.user

Class MemberCandidacy

java.lang.Object

org.xwiki.wiki.user.MemberCandidacy

@Unstable
public class MemberCandidacy
extends Object

Represents the invitation or the request to join a wiki.

Since:

5.3M2

Version:

$Id: 600fa7117f67b9ca11ba394f9653853cab473739 $

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MemberCandidacy.CandidateType Type of the candidacy.
static class	MemberCandidacy.Status Status of the candidacy.

Constructor Summary

Constructors

Constructor and Description
MemberCandidacy() Constructor.
MemberCandidacy(String wikiId, String userId, MemberCandidacy.CandidateType type) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	getAdminComment() Message of the admin that goes along the invitation or about his acceptance/refusal of the request.
String	getAdminId() The admin is the person who has sent the invitation or who review the join request.
String	getAdminPrivateComment() Private message about the candidacy that only the admin can see.
Date	getDateOfClosure()
Date	getDateOfCreation()
int	getId()
MemberCandidacy.Status	getStatus()
MemberCandidacy.CandidateType	getType()
String	getUserComment() Message of the user which motivates his request or message about his acceptance/refusal of the invitation.
String	getUserId() The user is the person who ask or has been invited to join the wiki.
String	getWikiId()
void	setAdminComment(String adminComment)
void	setAdminId(String adminId)
void	setAdminPrivateComment(String adminPrivateComment)
void	setDateOfClosure(Date dateOfClosure)
void	setDateOfCreation(Date dateOfCreation)
void	setId(int id)
void	setStatus(MemberCandidacy.Status status)
void	setType(MemberCandidacy.CandidateType type)
void	setUserComment(String userComment)
void	setUserId(String userId)
void	setWikiId(String wikiId)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MemberCandidacy

public MemberCandidacy()

Constructor.

MemberCandidacy

public MemberCandidacy(String wikiId,
               String userId,
               MemberCandidacy.CandidateType type)

Constructor.

Parameters:

wikiId - Id of the wiki to join

userId - Id of the user who ask to join or the user to invite

type - type of candidacy

Method Detail

setId

public void setId(int id)

Parameters:

id - Id to set

getId

public int getId()

Returns:

the id of the candidacy

getWikiId

public String getWikiId()

Returns:

id of the wiki to join

setWikiId

public void setWikiId(String wikiId)

Parameters:

wikiId - id of the wiki to join

getUserId

public String getUserId()

The user is the person who ask or has been invited to join the wiki.

Returns:

id of the user

setUserId

public void setUserId(String userId)

Parameters:

userId - id of the user

getAdminId

public String getAdminId()

The admin is the person who has sent the invitation or who review the join request.

Returns:

the id of the Admin

setAdminId

public void setAdminId(String adminId)

Parameters:

adminId - if of the admin

getUserComment

public String getUserComment()

Message of the user which motivates his request or message about his acceptance/refusal of the invitation.

Returns:

the user comment

setUserComment

public void setUserComment(String userComment)

Parameters:

userComment - the user comment

getAdminComment

public String getAdminComment()

Message of the admin that goes along the invitation or about his acceptance/refusal of the request.

Returns:

the admin comment

setAdminComment

public void setAdminComment(String adminComment)

Parameters:

adminComment - the admin comment

getAdminPrivateComment

public String getAdminPrivateComment()

Private message about the candidacy that only the admin can see.

Returns:

the private message

setAdminPrivateComment

public void setAdminPrivateComment(String adminPrivateComment)

Parameters:

adminPrivateComment - the private message

setType

public void setType(MemberCandidacy.CandidateType type)

Parameters:

type - the type of candidacy

getType

public MemberCandidacy.CandidateType getType()

Returns:

the type of candidacy

getStatus

public MemberCandidacy.Status getStatus()

Returns:

the status of the request

setStatus

public void setStatus(MemberCandidacy.Status status)

Parameters:

status - the status to set

getDateOfCreation

public Date getDateOfCreation()

Returns:

the date of the creation of this candidacy

setDateOfCreation

public void setDateOfCreation(Date dateOfCreation)

Parameters:

dateOfCreation - the date of the creation of this candidacy

getDateOfClosure

public Date getDateOfClosure()

Returns:

the date this candidacy has been closed.

setDateOfClosure

public void setDateOfClosure(Date dateOfClosure)

Parameters:

dateOfClosure - the date this candidacy has been closed.