Summary: Methods | [Expand All]
public interface

KindlingClient

org.mule.module.kindling.client.KindlingClient
Known Indirect Subclasses

Summary

Public Methods
abstract KindlingCategory createCategory(KindlingCategory category)
abstract KindlingComment createComment(KindlingComment comment)
abstract KindlingGroup createGroup(KindlingGroup group)
abstract KindlingIdea createIdea(KindlingIdea idea)
abstract KindlingPost createPost(KindlingPost group)
abstract KindlingUser createUser(KindlingUser user)
abstract void deleteComment(String commentId)
abstract void deleteUser(String userId)
abstract KindlingCollection<KindlingCategory> retrieveCategories(Integer depth, String sort, Integer page, Integer limit, KindlingCategoryState state, String query, Integer associatedWithUserId)
abstract KindlingCategory retrieveCategory(String categoryId, Integer depth)
abstract KindlingComment retrieveComment(String commentId, Integer depth)
abstract KindlingCollection<KindlingComment> retrieveComments(KindlingCommentParentType parentType, Integer depth, String sort, Integer page, Integer limit, KindlingState state, Integer parentId, KindlingCommentType type)
abstract KindlingGroup retrieveGroup(String groupId, Integer depth)
abstract KindlingCollection<KindlingGroup> retrieveGroups(Integer depth, String sort, Integer page, Integer limit, KindlingState state, String startsWith, String query)
abstract KindlingIdea retrieveIdea(String ideaId, Integer depth)
abstract KindlingCollection<KindlingIdea> retrieveIdeas(Integer depth, String sort, Integer page, Integer limit, String state, Boolean allowsVoting, String query, String authorId, String categoryId, KindlingIdeaFilter filter)
abstract KindlingPost retrievePost(String postId, Integer depth)
abstract KindlingCollection<KindlingPost> retrievePosts(Integer depth, String sort, Integer page, Integer limit, KindlingPostState state, String startsWith, String query)
abstract KindlingUser retrieveUser(String userId, Integer depth)
abstract KindlingCollection<KindlingUser> retrieveUsers(Integer depth, String sort, Integer page, Integer limit, KindlingUserState state, Integer associatedWithCategoryId, KindlingUserDigest digest, String query, KindlingUserReputationTimeframe reputationTimeframe)
abstract KindlingCategory updateCategory(String categoryId, KindlingCategory category)
abstract KindlingGroup updateGroup(String groupId, KindlingGroup group)
abstract KindlingIdea updateIdea(String ideaId, KindlingIdea idea)
abstract KindlingPost updatePost(String postId, KindlingPost group)
abstract KindlingUser updateUser(String userId, KindlingUser user)

Public Methods

public abstract KindlingCategory createCategory (KindlingCategory category)

Parameters
category
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingComment createComment (KindlingComment comment)

Parameters
comment
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingGroup createGroup (KindlingGroup group)

Parameters
group
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingIdea createIdea (KindlingIdea idea)

Parameters
idea
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingPost createPost (KindlingPost group)

Parameters
group
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingUser createUser (KindlingUser user)

Parameters
user
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract void deleteComment (String commentId)

Parameters
commentId
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract void deleteUser (String userId)

Parameters
userId
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingCategory> retrieveCategories (Integer depth, String sort, Integer page, Integer limit, KindlingCategoryState state, String query, Integer associatedWithUserId)

Parameters
depth
sort
page
limit
state
query
associatedWithUserId
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCategory retrieveCategory (String categoryId, Integer depth)

Parameters
categoryId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingComment retrieveComment (String commentId, Integer depth)

Parameters
commentId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingComment> retrieveComments (KindlingCommentParentType parentType, Integer depth, String sort, Integer page, Integer limit, KindlingState state, Integer parentId, KindlingCommentType type)

Parameters
parentType
depth
sort
page
limit
state
parentId
type
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingGroup retrieveGroup (String groupId, Integer depth)

Parameters
groupId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingGroup> retrieveGroups (Integer depth, String sort, Integer page, Integer limit, KindlingState state, String startsWith, String query)

Parameters
depth
sort
page
limit
state
startsWith
query
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingIdea retrieveIdea (String ideaId, Integer depth)

Parameters
ideaId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingIdea> retrieveIdeas (Integer depth, String sort, Integer page, Integer limit, String state, Boolean allowsVoting, String query, String authorId, String categoryId, KindlingIdeaFilter filter)

Parameters
depth
sort
page
limit
state
allowsVoting
query
authorId
categoryId
filter
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingPost retrievePost (String postId, Integer depth)

Parameters
postId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingPost> retrievePosts (Integer depth, String sort, Integer page, Integer limit, KindlingPostState state, String startsWith, String query)

Parameters
depth
sort
page
limit
state
startsWith
query
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingUser retrieveUser (String userId, Integer depth)

Parameters
userId
depth
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCollection<KindlingUser> retrieveUsers (Integer depth, String sort, Integer page, Integer limit, KindlingUserState state, Integer associatedWithCategoryId, KindlingUserDigest digest, String query, KindlingUserReputationTimeframe reputationTimeframe)

Parameters
depth
sort
page
limit
state
associatedWithCategoryId
digest
query
reputationTimeframe
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingCategory updateCategory (String categoryId, KindlingCategory category)

Parameters
categoryId
category
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingGroup updateGroup (String groupId, KindlingGroup group)

Parameters
groupId
group
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingIdea updateIdea (String ideaId, KindlingIdea idea)

Parameters
ideaId
idea
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingPost updatePost (String postId, KindlingPost group)

Parameters
postId
group
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException

public abstract KindlingUser updateUser (String userId, KindlingUser user)

Parameters
userId
user
Throws
KindlingConnectorException
KindlingConnectorUnauthorizedException