GetCollectionTopicParameter (Communote 3.5 API)

java.lang.Object
- com.communote.plugins.api.rest.v30.resource.topic.GetCollectionTopicParameter

```
public class GetCollectionTopicParameter
extends Object
```
This class it the parameter class for the Topic resource. It covers all the parameter and attributes of the HTTP GETCOLLECTION method.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAlias()` Returns the Alias.
`String`	`getBannerImageId()` Returns the BannerImageId.
`String`	`getBannerImageVersion()` Returns the BannerImageVersion.
`Integer`	`getCheckAtLeastMoreResults()` Returns the CheckAtLeastMoreResults.
`ChildTopicResource[]`	`getChildren()` Returns the Children.
`Date`	`getCrawlLastModificationDate()` Returns the CrawlLastModificationDate.
`Boolean`	`getCreateSystemNotes()` Returns the CreateSystemNotes.
`String`	`getDescription()` Returns the Description.
`String`	`getF_externalObjectId()` Returns the F_externalObjectId.
`String`	`getF_externalObjectSystemId()` Returns the F_externalObjectSystemId.
`Boolean`	`getF_showFollowedItems()` Returns the F_showFollowedItems.
`String`	`getF_tagPrefix()` Returns the F_tagPrefix.
`String[]`	`getF_tags()` Returns the F_tags.
`String`	`getF_titleSearchString()` Returns the F_titleSearchString.
`String[]`	`getF_topicAliases()` Returns the F_topicAliases.
`Long[]`	`getF_topicIds()` Returns the F_topicIds.
`Long[]`	`getF_topicIdsToExclude()` Returns the F_topicIdsToExclude.
`Boolean`	`getIsFollow()` Returns the IsFollow.
`Date`	`getLastBannerImageModificationDate()` Returns the LastBannerImageModificationDate.
`Date`	`getLastModificationDate()` Returns the LastModificationDate.
`Date`	`getLastProfileImageModificationDate()` Returns the LastProfileImageModificationDate.
`Integer`	`getMaxCount()` Returns the MaxCount.
`Integer`	`getOffset()` Returns the Offset.
`String`	`getProfileImageId()` Returns the ProfileImageId.
`String`	`getProfileImageVersion()` Returns the ProfileImageVersion.
`TagResource[]`	`getTags()` Returns the Tags.
`String`	`getTitle()` Returns the Title.
`String`	`getTopicEmail()` Returns the TopicEmail.
`String`	`getTopicId()` Returns the TopicId.
`ETopicListType`	`getTopicListType()` Returns the constant TopicListType.
`String`	`getUserRole()` Returns the UserRole.
`void`	`handleUnknownProperties(String key, Object value)` Log unknown properties to loglevel warn.
`void`	`setAlias(String alias)` Sets Alias.
`void`	`setBannerImageId(String bannerImageId)` Sets BannerImageId.
`void`	`setBannerImageVersion(String bannerImageVersion)` Sets BannerImageVersion.
`void`	`setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults)` Sets CheckAtLeastMoreResults.
`void`	`setChildren(ChildTopicResource[] children)` Sets Children.
`void`	`setCrawlLastModificationDate(Date crawlLastModificationDate)` Sets CrawlLastModificationDate.
`void`	`setCreateSystemNotes(Boolean createSystemNotes)` Sets CreateSystemNotes.
`void`	`setDescription(String description)` Sets Description.
`void`	`setF_externalObjectId(String f_externalObjectId)` Sets F_externalObjectId.
`void`	`setF_externalObjectSystemId(String f_externalObjectSystemId)` Sets F_externalObjectSystemId.
`void`	`setF_showFollowedItems(Boolean f_showFollowedItems)` Sets F_showFollowedItems.
`void`	`setF_tagPrefix(String f_tagPrefix)` Sets F_tagPrefix.
`void`	`setF_tags(String[] f_tags)` Sets F_tags.
`void`	`setF_titleSearchString(String f_titleSearchString)` Sets F_titleSearchString.
`void`	`setF_topicAliases(String[] f_topicAliases)` Sets F_topicAliases.
`void`	`setF_topicIds(Long[] f_topicIds)` Sets F_topicIds.
`void`	`setF_topicIdsToExclude(Long[] f_topicIdsToExclude)` Sets F_topicIdsToExclude.
`void`	`setIsFollow(Boolean isFollow)` Sets IsFollow.
`void`	`setLastBannerImageModificationDate(Date lastBannerImageModificationDate)` Sets LastBannerImageModificationDate.
`void`	`setLastModificationDate(Date lastModificationDate)` Sets LastModificationDate.
`void`	`setLastProfileImageModificationDate(Date lastProfileImageModificationDate)` Sets LastProfileImageModificationDate.
`void`	`setMaxCount(Integer maxCount)` Sets MaxCount.
`void`	`setOffset(Integer offset)` Sets Offset.
`void`	`setProfileImageId(String profileImageId)` Sets ProfileImageId.
`void`	`setProfileImageVersion(String profileImageVersion)` Sets ProfileImageVersion.
`void`	`setTags(TagResource[] tags)` Sets Tags.
`void`	`setTitle(String title)` Sets Title.
`void`	`setTopicEmail(String topicEmail)` Sets TopicEmail.
`void`	`setTopicId(String topicId)` Sets TopicId.
`void`	`setTopicListType(ETopicListType topicListType)` Sets the constant TopicListType.
`void`	`setUserRole(String userRole)` Sets UserRole.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - GetCollectionTopicParameter
```
public GetCollectionTopicParameter()
```
    Default Constuctor necessary for json parsing
  - GetCollectionTopicParameter
```
public GetCollectionTopicParameter(javax.ws.rs.core.MultivaluedMap<String,String> valueMap)
                            throws RestApiIllegalRequestParameterException
```
    This constructor parses all incoming parameter of a request into the class structure
    
    Throws:
    
    RestApiIllegalRequestParameterException
  - GetCollectionTopicParameter
```
public GetCollectionTopicParameter(String representation)
                            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
  - setChildren
```
public void setChildren(ChildTopicResource[] children)
```
    Sets Children.
    
    Parameters:
    
    children -
  - getChildren
```
public ChildTopicResource[] getChildren()
```
    Returns the Children.
    
    Returns:
    
    the Children
  - setLastModificationDate
```
public void setLastModificationDate(Date lastModificationDate)
```
    Sets LastModificationDate.
    
    Parameters:
    
    lastModificationDate -
  - getLastModificationDate
```
public Date getLastModificationDate()
```
    Returns the LastModificationDate.
    
    Returns:
    
    the LastModificationDate
  - setTopicEmail
```
public void setTopicEmail(String topicEmail)
```
    Sets TopicEmail.
    
    Parameters:
    
    topicEmail -
  - getTopicEmail
```
public String getTopicEmail()
```
    Returns the TopicEmail.
    
    Returns:
    
    the TopicEmail
  - setCreateSystemNotes
```
public void setCreateSystemNotes(Boolean createSystemNotes)
```
    Sets CreateSystemNotes.
    
    Parameters:
    
    createSystemNotes -
  - getCreateSystemNotes
```
public Boolean getCreateSystemNotes()
```
    Returns the CreateSystemNotes.
    
    Returns:
    
    the CreateSystemNotes
  - setDescription
```
public void setDescription(String description)
```
    Sets Description.
    
    Parameters:
    
    description -
  - getDescription
```
public String getDescription()
```
    Returns the Description.
    
    Returns:
    
    the Description
  - setTags
```
public void setTags(TagResource[] tags)
```
    Sets Tags.
    
    Parameters:
    
    tags -
  - getTags
```
public TagResource[] getTags()
```
    Returns the Tags.
    
    Returns:
    
    the Tags
  - setAlias
```
public void setAlias(String alias)
```
    Sets Alias.
    
    Parameters:
    
    alias -
  - getAlias
```
public String getAlias()
```
    Returns the Alias.
    
    Returns:
    
    the Alias
  - setTitle
```
public void setTitle(String title)
```
    Sets Title.
    
    Parameters:
    
    title -
  - getTitle
```
public String getTitle()
```
    Returns the Title.
    
    Returns:
    
    the Title
  - setUserRole
```
public void setUserRole(String userRole)
```
    Sets UserRole.
    
    Parameters:
    
    userRole -
  - getUserRole
```
public String getUserRole()
```
    Returns the UserRole.
    
    Returns:
    
    the UserRole
  - setIsFollow
```
public void setIsFollow(Boolean isFollow)
```
    Sets IsFollow.
    
    Parameters:
    
    isFollow -
  - getIsFollow
```
public Boolean getIsFollow()
```
    Returns the IsFollow.
    
    Returns:
    
    the IsFollow
  - setProfileImageId
```
public void setProfileImageId(String profileImageId)
```
    Sets ProfileImageId.
    
    Parameters:
    
    profileImageId -
  - getProfileImageId
```
public String getProfileImageId()
```
    Returns the ProfileImageId.
    
    Returns:
    
    the ProfileImageId
  - setProfileImageVersion
```
public void setProfileImageVersion(String profileImageVersion)
```
    Sets ProfileImageVersion.
    
    Parameters:
    
    profileImageVersion -
  - getProfileImageVersion
```
public String getProfileImageVersion()
```
    Returns the ProfileImageVersion.
    
    Returns:
    
    the ProfileImageVersion
  - setLastProfileImageModificationDate
```
public void setLastProfileImageModificationDate(Date lastProfileImageModificationDate)
```
    Sets LastProfileImageModificationDate.
    
    Parameters:
    
    lastProfileImageModificationDate -
  - getLastProfileImageModificationDate
```
public Date getLastProfileImageModificationDate()
```
    Returns the LastProfileImageModificationDate.
    
    Returns:
    
    the LastProfileImageModificationDate
  - setBannerImageId
```
public void setBannerImageId(String bannerImageId)
```
    Sets BannerImageId.
    
    Parameters:
    
    bannerImageId -
  - getBannerImageId
```
public String getBannerImageId()
```
    Returns the BannerImageId.
    
    Returns:
    
    the BannerImageId
  - setBannerImageVersion
```
public void setBannerImageVersion(String bannerImageVersion)
```
    Sets BannerImageVersion.
    
    Parameters:
    
    bannerImageVersion -
  - getBannerImageVersion
```
public String getBannerImageVersion()
```
    Returns the BannerImageVersion.
    
    Returns:
    
    the BannerImageVersion
  - setLastBannerImageModificationDate
```
public void setLastBannerImageModificationDate(Date lastBannerImageModificationDate)
```
    Sets LastBannerImageModificationDate.
    
    Parameters:
    
    lastBannerImageModificationDate -
  - getLastBannerImageModificationDate
```
public Date getLastBannerImageModificationDate()
```
    Returns the LastBannerImageModificationDate.
    
    Returns:
    
    the LastBannerImageModificationDate
  - setCrawlLastModificationDate
```
public void setCrawlLastModificationDate(Date crawlLastModificationDate)
```
    Sets CrawlLastModificationDate.
    
    Parameters:
    
    crawlLastModificationDate -
  - getCrawlLastModificationDate
```
public Date getCrawlLastModificationDate()
```
    Returns the CrawlLastModificationDate.
    
    Returns:
    
    the CrawlLastModificationDate
  - setTopicListType
```
public void setTopicListType(ETopicListType topicListType)
```
    Sets the constant TopicListType.
    
    Parameters:
    
    the - constant topicListType
  - getTopicListType
```
public ETopicListType getTopicListType()
```
    Returns the constant TopicListType.
    
    Returns:
    
    the constant TopicListType
  - setF_topicAliases
```
public void setF_topicAliases(String[] f_topicAliases)
```
    Sets F_topicAliases.
    
    Parameters:
    
    f_topicAliases -
  - getF_topicAliases
```
public String[] getF_topicAliases()
```
    Returns the F_topicAliases.
    
    Returns:
    
    the F_topicAliases
  - setF_topicIds
```
public void setF_topicIds(Long[] f_topicIds)
```
    Sets F_topicIds.
    
    Parameters:
    
    f_topicIds -
  - getF_topicIds
```
public Long[] getF_topicIds()
```
    Returns the F_topicIds.
    
    Returns:
    
    the F_topicIds
  - setF_topicIdsToExclude
```
public void setF_topicIdsToExclude(Long[] f_topicIdsToExclude)
```
    Sets F_topicIdsToExclude.
    
    Parameters:
    
    f_topicIdsToExclude -
  - getF_topicIdsToExclude
```
public Long[] getF_topicIdsToExclude()
```
    Returns the F_topicIdsToExclude.
    
    Returns:
    
    the F_topicIdsToExclude
  - setF_showFollowedItems
```
public void setF_showFollowedItems(Boolean f_showFollowedItems)
```
    Sets F_showFollowedItems.
    
    Parameters:
    
    f_showFollowedItems -
  - getF_showFollowedItems
```
public Boolean getF_showFollowedItems()
```
    Returns the F_showFollowedItems.
    
    Returns:
    
    the F_showFollowedItems
  - setF_tags
```
public void setF_tags(String[] f_tags)
```
    Sets F_tags.
    
    Parameters:
    
    f_tags -
  - getF_tags
```
public String[] getF_tags()
```
    Returns the F_tags.
    
    Returns:
    
    the F_tags
  - setF_tagPrefix
```
public void setF_tagPrefix(String f_tagPrefix)
```
    Sets F_tagPrefix.
    
    Parameters:
    
    f_tagPrefix -
  - getF_tagPrefix
```
public String getF_tagPrefix()
```
    Returns the F_tagPrefix.
    
    Returns:
    
    the F_tagPrefix
  - setF_titleSearchString
```
public void setF_titleSearchString(String f_titleSearchString)
```
    Sets F_titleSearchString.
    
    Parameters:
    
    f_titleSearchString -
  - getF_titleSearchString
```
public String getF_titleSearchString()
```
    Returns the F_titleSearchString.
    
    Returns:
    
    the F_titleSearchString
  - setF_externalObjectSystemId
```
public void setF_externalObjectSystemId(String f_externalObjectSystemId)
```
    Sets F_externalObjectSystemId.
    
    Parameters:
    
    f_externalObjectSystemId -
  - getF_externalObjectSystemId
```
public String getF_externalObjectSystemId()
```
    Returns the F_externalObjectSystemId.
    
    Returns:
    
    the F_externalObjectSystemId
  - setF_externalObjectId
```
public void setF_externalObjectId(String f_externalObjectId)
```
    Sets F_externalObjectId.
    
    Parameters:
    
    f_externalObjectId -
  - getF_externalObjectId
```
public String getF_externalObjectId()
```
    Returns the F_externalObjectId.
    
    Returns:
    
    the F_externalObjectId
  - setOffset
```
public void setOffset(Integer offset)
```
    Sets Offset.
    
    Parameters:
    
    offset -
  - getOffset
```
public Integer getOffset()
```
    Returns the Offset.
    
    Returns:
    
    the Offset
  - setMaxCount
```
public void setMaxCount(Integer maxCount)
```
    Sets MaxCount.
    
    Parameters:
    
    maxCount -
  - getMaxCount
```
public Integer getMaxCount()
```
    Returns the MaxCount.
    
    Returns:
    
    the MaxCount
  - setCheckAtLeastMoreResults
```
public void setCheckAtLeastMoreResults(Integer checkAtLeastMoreResults)
```
    Sets CheckAtLeastMoreResults.
    
    Parameters:
    
    checkAtLeastMoreResults -
  - getCheckAtLeastMoreResults
```
public Integer getCheckAtLeastMoreResults()
```
    Returns the CheckAtLeastMoreResults.
    
    Returns:
    
    the CheckAtLeastMoreResults
  - handleUnknownProperties
```
public void handleUnknownProperties(String key,
                                    Object value)
```
    Log unknown properties to loglevel warn.

Class GetCollectionTopicParameter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

GetCollectionTopicParameter

GetCollectionTopicParameter

GetCollectionTopicParameter

Method Detail

setTopicId

getTopicId

setChildren

getChildren

setLastModificationDate

getLastModificationDate

setTopicEmail

getTopicEmail

setCreateSystemNotes

getCreateSystemNotes

setDescription

getDescription

setTags

getTags

setAlias

getAlias

setTitle

getTitle

setUserRole

getUserRole

setIsFollow

getIsFollow

setProfileImageId

getProfileImageId

setProfileImageVersion

getProfileImageVersion

setLastProfileImageModificationDate

getLastProfileImageModificationDate

setBannerImageId

getBannerImageId

setBannerImageVersion

getBannerImageVersion

setLastBannerImageModificationDate

getLastBannerImageModificationDate

setCrawlLastModificationDate

getCrawlLastModificationDate

setTopicListType

getTopicListType

setF_topicAliases

getF_topicAliases

setF_topicIds

getF_topicIds

setF_topicIdsToExclude

getF_topicIdsToExclude

setF_showFollowedItems

getF_showFollowedItems

setF_tags

getF_tags

setF_tagPrefix

getF_tagPrefix

setF_titleSearchString

getF_titleSearchString

setF_externalObjectSystemId

getF_externalObjectSystemId

setF_externalObjectId

getF_externalObjectId

setOffset

getOffset

setMaxCount

getMaxCount

setCheckAtLeastMoreResults

getCheckAtLeastMoreResults

handleUnknownProperties