com.communote.plugins.api.rest.v30.resource.topic.role

Class GetCollectionRoleParameter

java.lang.Object

com.communote.plugins.api.rest.v30.resource.topic.role.GetCollectionRoleParameter

public class GetCollectionRoleParameter
extends Object

This class it the parameter class for the Role resource. It covers all the parameter and attributes of the HTTP GETCOLLECTION method.

Constructor Summary

Constructors

Constructor and Description
GetCollectionRoleParameter() Default Constuctor necessary for json parsing
GetCollectionRoleParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap, String topicId) This constructor parses all incoming parameter of a request into the class structure
GetCollectionRoleParameter(String representation, String topicId)

Method Summary

Modifier and Type	Method and Description
String	getDisplayName() Returns the DisplayName.
Long	getEntityId() Returns the EntityId.
String	getGroupAlias() Returns the GroupAlias.
Boolean	getIsGroup() Returns the IsGroup.
String	getShortDisplayName() Returns the ShortDisplayName.
String	getTopicId() Returns the TopicId.
ETopicIdentifier	getTopicIdentifier() Returns the constant TopicIdentifier.
String	getUserAlias() Returns the UserAlias.
void	handleUnknownProperties(String key, Object value) Log unknown properties to loglevel warn.
void	setDisplayName(String displayName) Sets DisplayName.
void	setEntityId(Long entityId) Sets EntityId.
void	setGroupAlias(String groupAlias) Sets GroupAlias.
void	setIsGroup(Boolean isGroup) Sets IsGroup.
void	setShortDisplayName(String shortDisplayName) Sets ShortDisplayName.
void	setTopicId(String topicId) Sets TopicId.
void	setTopicIdentifier(ETopicIdentifier topicIdentifier) Sets the constant TopicIdentifier.
void	setUserAlias(String userAlias) Sets UserAlias.

Methods inherited from class java.lang.Object

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

Constructor Detail

GetCollectionRoleParameter

public GetCollectionRoleParameter()

Default Constuctor necessary for json parsing

GetCollectionRoleParameter

public GetCollectionRoleParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap,
                                  String topicId)
                           throws RestApiIllegalRequestParameterException

This constructor parses all incoming parameter of a request into the class structure

Throws:

RestApiIllegalRequestParameterException

GetCollectionRoleParameter

public GetCollectionRoleParameter(String representation,
                                  String topicId)
                           throws org.codehaus.jackson.JsonParseException,
                                  org.codehaus.jackson.map.JsonMappingException,
                                  IOException

Throws:

org.codehaus.jackson.JsonParseException

org.codehaus.jackson.map.JsonMappingException

IOException

Method Detail

setTopicId

public void setTopicId(String topicId)

Sets TopicId.

Parameters:

topicId -

getTopicId

public String getTopicId()

Returns the TopicId.

Returns:

the TopicId

setEntityId

public void setEntityId(Long entityId)

Sets EntityId.

Parameters:

entityId -

getEntityId

public Long getEntityId()

Returns the EntityId.

Returns:

the EntityId

setUserAlias

public void setUserAlias(String userAlias)

Sets UserAlias.

Parameters:

userAlias -

getUserAlias

public String getUserAlias()

Returns the UserAlias.

Returns:

the UserAlias

setGroupAlias

public void setGroupAlias(String groupAlias)

Sets GroupAlias.

Parameters:

groupAlias -

getGroupAlias

public String getGroupAlias()

Returns the GroupAlias.

Returns:

the GroupAlias

setIsGroup

public void setIsGroup(Boolean isGroup)

Sets IsGroup.

Parameters:

isGroup -

getIsGroup

public Boolean getIsGroup()

Returns the IsGroup.

Returns:

the IsGroup

setDisplayName

public void setDisplayName(String displayName)

Sets DisplayName.

Parameters:

displayName -

getDisplayName

public String getDisplayName()

Returns the DisplayName.

Returns:

the DisplayName

setShortDisplayName

public void setShortDisplayName(String shortDisplayName)

Sets ShortDisplayName.

Parameters:

shortDisplayName -

getShortDisplayName

public String getShortDisplayName()

Returns the ShortDisplayName.

Returns:

the ShortDisplayName

setTopicIdentifier

public void setTopicIdentifier(ETopicIdentifier topicIdentifier)

Sets the constant TopicIdentifier.

Parameters:

the - constant topicIdentifier

getTopicIdentifier

public ETopicIdentifier getTopicIdentifier()

Returns the constant TopicIdentifier.

Returns:

the constant TopicIdentifier

handleUnknownProperties

public void handleUnknownProperties(String key,
                                    Object value)

Log unknown properties to loglevel warn.