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

Class TopicResourceHelper

java.lang.Object

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

public final class TopicResourceHelper
extends Object

Helper for TopicResourceHandler

Author:

Communote GmbH - http://www.communote.com/

Method Summary

Modifier and Type	Method and Description
static BlogQueryParameters	configureQueryInstance(GetCollectionTopicParameter topicCollectionParameter, QueryParametersParameterNameProvider nameProvider) Get query instance to filter notes
static CreationBlogTO	getBlogTO(CreateTopicParameter createTopicParameter) Get transfer object of topic
static BlogTO	getBlogTO(EditTopicParameter editTopicParameter, Blog topic) Get transfer object of topic
static long	getTopicIdByIdentifier(String eTopicIdentifierName, String topicId, BlogManagement blogManagement) Get the topic identifier of alias or id

Methods inherited from class java.lang.Object

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

Method Detail

configureQueryInstance

public static BlogQueryParameters configureQueryInstance(GetCollectionTopicParameter topicCollectionParameter,
                                                         QueryParametersParameterNameProvider nameProvider)
                                                  throws IllegalRequestParameterException

Get query instance to filter notes

Parameters:

topicCollectionParameter - Extract context parameter needed for filter

nameProvider - The name provider.

Returns:

NoteQueryInstance

Throws:

IllegalRequestParameterException - request parameter exception

getBlogTO

public static CreationBlogTO getBlogTO(CreateTopicParameter createTopicParameter)

Get transfer object of topic

Parameters:

createTopicParameter - CreateTopicParameter

Returns:

BlogTO

getBlogTO

public static BlogTO getBlogTO(EditTopicParameter editTopicParameter,
                               Blog topic)
                        throws BlogAccessException,
                               BlogNotFoundException

Get transfer object of topic

Parameters:

editTopicParameter - EditTopicParameter

topic - Blog

Returns:

BlogTO

Throws:

BlogNotFoundException - can not found topic

BlogAccessException - can not access blog

getTopicIdByIdentifier

public static long getTopicIdByIdentifier(String eTopicIdentifierName,
                                          String topicId,
                                          BlogManagement blogManagement)
                                   throws BlogNotFoundException,
                                          BlogAccessException

Get the topic identifier of alias or id

Parameters:

eTopicIdentifierName - enumeration of identifier possibilities

topicId - identifier alias or topicId

blogManagement - BlogManagement

Returns:

topic identifier

Throws:

BlogNotFoundException - topic can not been found by alias

BlogAccessException - in case the current user has no access to the topic