Clearspace API (1.10.16) Web Services Client Javadocs
A B C D E F G H I J K L M N O P Q R S T U V W X

A

ABUSE - Static variable in class com.jivesoftware.community.JiveConstants
 
ACTIVITY - Static variable in class com.jivesoftware.community.JiveConstants
 
addAdministratorToGroup(long, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Make the user with the specified userID an administrator of the group with the specified groupID.
addAllowedType(String) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Adds a content type to the list of explicitly allowed types.
addAnonymousVote(long, int, String) - Method in interface com.jivesoftware.community.webservices.PollService
Add a guest vote for an option in the poll.
addAttachmentToBlogPost(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.BlogService
Adds an attachment to the blog post with the specified ID.
addAttachmentToDocumentByDocumentID(String, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Add a new attachment to the document with the specified id.
addAttachmentToDocumentByInternalDocID(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Add a new attachment to the document with the specified internal id.
addAttachmentToMessage(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.ForumService
Adds an attachment to the message with the specified ID.
addAuthor(long, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Adds the user with the supplied id as an author of this document of the specified document.
addComment(int, long, long, String) - Method in interface com.jivesoftware.community.webservices.CommentService
Adds a new comment to an object.
addCommentToComment(int, long, long, long, String) - Method in interface com.jivesoftware.community.webservices.CommentService
Adds a new comment having a parent comment to the object.
addCommunityPermissionToGroup(long, boolean, long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Add the specified permission on the specified community to the group with the specified id.
addCommunityPermissionToUser(long, boolean, long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Add the specified permission on the specified community to the user with the specified id.
addDisallowedType(String) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Adds a content type to the list of explicitly disallowed types.
addDocumentApproverOnCommunity(long, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Add the user as a document approver for this entire community.
addDocumentApproverOnDocument(long, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Adds a user as a document approver for this document.
addImageToBlogPost(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.BlogService
Adds an image to the blog post with the specified ID.
addImageToDocumentByDocumentID(String, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Add a new image to the document with the specified id.
addImageToDocumentByInternalDocID(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Add a new image to the document with the specified internal id.
addImageToMessage(long, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.ForumService
Adds an image to the message with the specified ID.
addMemberToGroup(long, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Add the user with the specified userID to the group with the specified groupID.
addOption(long, String) - Method in interface com.jivesoftware.community.webservices.PollService
Add a new option to the poll.
addPermissionToGroup(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Add the specified permission to the group with the specified id.
addPermissionToUser(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Add the specified permission to the user with the specified id.
addPoints(long, long, long, int, long, String) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Rewards points to a user.
addRating(long, int, long, int) - Method in interface com.jivesoftware.community.webservices.RatingsService
Add a rating to the JiveContentObject.
AddressBookService - Interface in com.jivesoftware.community.webservices
Provides ability to interace with the Private Message addressbook.
addressBookService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
addTag(String, JiveObject) - Method in interface com.jivesoftware.community.webservices.TagService
Associates a tag with this object
addUser(long, String) - Method in interface com.jivesoftware.community.webservices.AddressBookService
Adds a specified username to users addressbook.
addUsers(long, long[]) - Method in interface com.jivesoftware.community.webservices.AddressBookService
Adds a list of users to the Private Message addressbook of the specified user.
addUserVote(long, int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Add a user vote for an option in the poll.
ageList - Variable in class com.jivesoftware.community.webservices.Cache
Linked list to maintain time that cache objects were initially added to the cache, most recently added to oldest added.
ALL - Static variable in class com.jivesoftware.community.webservices.WSConstants.AccessType
Access type that specifies that any user including anonymous users can connect to web services.
ALLOW_ANONYMOUS_VOTE_MODIFICATION - Static variable in class com.jivesoftware.community.webservices.Poll
Mode to allow guests to change their vote after casting the vote.
ALLOW_USER_VOTE_MODIFICATION - Static variable in class com.jivesoftware.community.webservices.Poll
Mode to allow users to change their vote after casting the vote.
ANNOUNCEMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
ANONYMOUS - Static variable in class com.jivesoftware.community.JiveConstants
 
anonymousUserHasPermission(long, boolean) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if the anonymous users have a particular permission globally.
anonymousUserHasPermissionOnCommunity(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if the anonymous users have a particular permission on the community with the specified ID.
ApprovalStatus - Class in com.jivesoftware.community.webservices
Contains information on whether a user has approved a document edit and when.
ApprovalStatus() - Constructor for class com.jivesoftware.community.webservices.ApprovalStatus
 
args - Variable in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
ASCENDING - Static variable in class com.jivesoftware.community.webservices.Query
Ascending sort (ie 3, 4, 5...).
ASCENDING - Static variable in class com.jivesoftware.community.webservices.ResultFilter
Ascending sort (ie 3, 4, 5...).
ASSUMED_RESOLVED - Static variable in class com.jivesoftware.community.webservices.ResultFilter.ResolutionState
 
ATTACHMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
Attachment - Class in com.jivesoftware.community.webservices
 
Attachment() - Constructor for class com.jivesoftware.community.webservices.Attachment
 
AttachmentException - Exception in com.jivesoftware.community
Thrown if an error occurs uploading or updating an Attachment.
AttachmentException(String, Throwable) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, Throwable) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, Throwable, String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(int, String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(String, int) - Constructor for exception com.jivesoftware.community.AttachmentException
 
AttachmentException(String) - Constructor for exception com.jivesoftware.community.AttachmentException
 
attachmentManagerService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
AttachmentNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Attachment was not found.
AttachmentNotFoundException() - Constructor for exception com.jivesoftware.community.AttachmentNotFoundException
 
AttachmentNotFoundException(String) - Constructor for exception com.jivesoftware.community.AttachmentNotFoundException
 
AttachmentService - Interface in com.jivesoftware.community.webservices
A web service for managing attachment settings.
AUTH_FACTORY_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
AVATAR - Static variable in class com.jivesoftware.community.JiveConstants
 

B

BAD_CONTENT_TYPE - Static variable in exception com.jivesoftware.community.AttachmentException
 
BAN - Static variable in class com.jivesoftware.community.JiveConstants
 
BATCH_EMAIL_WATCH - Static variable in class com.jivesoftware.community.webservices.Watch
Batch email watch type.
BinaryBody - Class in com.jivesoftware.community.webservices
An object that encapsulates a binary document body.
BinaryBody() - Constructor for class com.jivesoftware.community.webservices.BinaryBody
 
BLOG - Static variable in class com.jivesoftware.community.JiveConstants
 
Blog - Class in com.jivesoftware.community.webservices
A container for a list of blog postings by a user or group of users.
Blog() - Constructor for class com.jivesoftware.community.webservices.Blog
 
BLOGPOST - Static variable in class com.jivesoftware.community.JiveConstants
 
BlogPost - Class in com.jivesoftware.community.webservices
A container for blog post data and for a hierarchy of blog comments.
BlogPost() - Constructor for class com.jivesoftware.community.webservices.BlogPost
 
BlogPostResultFilter - Class in com.jivesoftware.community.webservices
 
BlogPostResultFilter() - Constructor for class com.jivesoftware.community.webservices.BlogPostResultFilter
 
BlogResultFilter - Class in com.jivesoftware.community.webservices
Filters and sorts Blogs.
BlogResultFilter() - Constructor for class com.jivesoftware.community.webservices.BlogResultFilter
 
BlogService - Interface in com.jivesoftware.community.webservices
A web service interface for managing blogs.
blogService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
BlogTagResultFilter - Class in com.jivesoftware.community.webservices
 
BlogTagResultFilter() - Constructor for class com.jivesoftware.community.webservices.BlogTagResultFilter
 

C

Cache - Class in com.jivesoftware.community.webservices
A specialized Map that is size-limited (using an LRU algorithm) and has an optional expiration time for cache items.
Cache(int, long) - Constructor for class com.jivesoftware.community.webservices.Cache
Create a new cache and specify the maximum size of for the cache in bytes, and the maximum lifetime of objects.
CacheableService - Interface in com.jivesoftware.community.webservices
If services are acquired by ServiceLocator you can cast a service to this interface to enable/modify caching settings.
cacheHits - Variable in class com.jivesoftware.community.webservices.Cache
Maintain the number of cache hits and misses.
cacheMisses - Variable in class com.jivesoftware.community.webservices.Cache
Maintain the number of cache hits and misses.
changeAnonymousVote(long, int, int, String) - Method in interface com.jivesoftware.community.webservices.PollService
Change a guest vote.
changeUserVote(long, int, int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Change a user vote.
clear() - Method in class com.jivesoftware.community.webservices.Cache
 
clearCache() - Method in interface com.jivesoftware.community.webservices.CacheableService
Calling this method will clear the content from the services cache.
com.jivesoftware.base - package com.jivesoftware.base
Base APIs and classes for Jive Software products.
com.jivesoftware.community - package com.jivesoftware.community
Core interfaces and classes for Clearspace.
com.jivesoftware.community.webservices - package com.jivesoftware.community.webservices
 
COMMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
Comment - Class in com.jivesoftware.community.webservices
 
Comment() - Constructor for class com.jivesoftware.community.webservices.Comment
 
COMMENT_AUTH_DEFAULT - Static variable in class com.jivesoftware.community.webservices.Blog
The default comment authentication value.
COMMENT_AUTH_OPTIONAL - Static variable in class com.jivesoftware.community.webservices.Blog
Value for comment authentication which indicates that users need not register with the system nor do they have to provide an email address as part of a comment.
COMMENT_AUTH_OPTIONAL_WITH_EMAIL - Static variable in class com.jivesoftware.community.webservices.Blog
Value for comment authentication which indicates that users must either register and authenticate with the system or provide an email address as part of an anonymous comment before submitting a comment.
COMMENT_AUTH_REQUIRED - Static variable in class com.jivesoftware.community.webservices.Blog
Value for comment authentication which indicates that users must register and authenticate with the system before adding a comment.
CommentResultFilter - Class in com.jivesoftware.community.webservices
 
CommentResultFilter() - Constructor for class com.jivesoftware.community.webservices.CommentResultFilter
 
COMMENTS_CLOSED - Static variable in class com.jivesoftware.community.webservices.Document
Comment status for documents that may have allowed comments in the past but presently do not accept comments.
COMMENTS_NONE - Static variable in class com.jivesoftware.community.webservices.Document
Comment status for documents that do not accept comments.
COMMENTS_OPEN - Static variable in class com.jivesoftware.community.webservices.Document
Comment status for documents that do accept comments.
CommentService - Interface in com.jivesoftware.community.webservices
 
commentService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
COMMUNITY - Static variable in class com.jivesoftware.community.JiveConstants
 
Community - Class in com.jivesoftware.community.webservices
A container for threads and a hierarchy of other communities.
Community() - Constructor for class com.jivesoftware.community.webservices.Community
 
COMMUNITY_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer a community.
COMMUNITY_NAME - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMUNITY_QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 
COMMUNITY_SEARCH_QUERY - Static variable in class com.jivesoftware.community.JiveConstants
 
CommunityNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified Community was not found
CommunityNotFoundException() - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
 
CommunityNotFoundException(String, long) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
Creates this exception with a messages and the id of the community that could not be found.
CommunityNotFoundException(long) - Constructor for exception com.jivesoftware.community.CommunityNotFoundException
Creates this exception with the id of the community that could not be found.
CommunityService - Interface in com.jivesoftware.community.webservices
Provides the ability to manipulate communities.
communityService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
containsKey(Object) - Method in class com.jivesoftware.community.webservices.Cache
 
containsValue(Object) - Method in class com.jivesoftware.community.webservices.Cache
 
CONTENT_OBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
ContentTag - Class in com.jivesoftware.community.webservices
Container for tags associated with a taggable object.
ContentTag() - Constructor for class com.jivesoftware.community.webservices.ContentTag
 
countQuickMessageSearchResultsByCommunityID(long, String, int[]) - Method in interface com.jivesoftware.community.webservices.SearchService
Returns the number of possible results for the specified query.
countQuickSearchResults(String, int[]) - Method in interface com.jivesoftware.community.webservices.SearchService
Returns the number of possible results for the specified query.
countSearchResults(Query, int[]) - Method in interface com.jivesoftware.community.webservices.SearchService
Returns the number of possible results for the specified query.
countSearchResultsByCommunityID(long, Query, int[]) - Method in interface com.jivesoftware.community.webservices.SearchService
Returns the number of possible results for the specified query by category.
CREATE_ANNOUNCEMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create, delete, and schedule announcements.
CREATE_BLOG - Static variable in class com.jivesoftware.community.Permissions
Permission to create a blog.
CREATE_COMMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a comment
CREATE_DOC_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create an attachment
CREATE_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create a document
CREATE_IMAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to create an image
CREATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to create a new message.
CREATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create attachments.
CREATE_POLL - Static variable in class com.jivesoftware.community.Permissions
Permission to create polls.
CREATE_PRIVATE_MESSAGE_ATTACHMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to create attachments in a private message.
CREATE_THREAD - Static variable in class com.jivesoftware.community.Permissions
Permission to create a new thread.
createBinaryDocument(long, long, long, String, String, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Creates a new binary document.
createBlog(long, String, String) - Method in interface com.jivesoftware.community.webservices.BlogService
Creates a new blog.
createBlogPost(String, String, long, long) - Method in interface com.jivesoftware.community.webservices.BlogService
Creates a new blog post.
createCommunity(String, String, String) - Method in interface com.jivesoftware.community.webservices.CommunityService
Creates a new Community as a sub-community of the root community using the name and description.
createCommunityWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Create a watch on a community for the specified user.
createDefaultContentCommentFilter() - Static method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
 
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Creates a default blog post ResultFilter: only blog posts that have status = BlogPost.STATUS_PUBLISH with results sorted on the blog post publish date (newest blog posts first).
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.BlogResultFilter
Creates a default blog ResultFilter: all blogs with results sorted on the blog creation date (newest blogs first).
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.BlogTagResultFilter
Creates a default tag ResultFilter: all tags associated with blog posts that have status = BlogPost.STATUS_PUBLISH, publishDate less than now() (with minute precision) ordered by tag name in descending order.
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.CommentResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
createDefaultFilter(Community) - Static method in class com.jivesoftware.community.webservices.CommentResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment creation date.
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.DocumentResultFilter
 
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.FeedbackResultFilter
Creates a default comment ResultFilter: no filtering with results sorted on the comment / trackback creation date.
createDefaultFilter() - Static method in class com.jivesoftware.community.webservices.TagResultFilter
Creates a default TagResultFilter: all tags sorted in descending order with no minimum number of JiveContentObjects.
createDefaultMessageFilter() - Static method in class com.jivesoftware.community.webservices.ResultFilter
Creates a default message ResultFilter: no filtering with results sorted on the message creation date in ascending order.
createDefaultThreadFilter() - Static method in class com.jivesoftware.community.webservices.ResultFilter
Creates a default thread ResultFilter: no filtering with results sorted on the thread modification date.
createDefaultUserMessagesFilter() - Static method in class com.jivesoftware.community.webservices.ResultFilter
Creates a default user messages ResultFilter: no filtering with results sorted on the message creation date descending (newest messages appear first).
createDocument(long, long, long, String, String, String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Create a new document.
createFolder(long, String) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Creates a new folder.
createGroup(String, String) - Method in interface com.jivesoftware.community.webservices.GroupService
Creates a new group.
createMessage(String, String, long, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Creates a new message on the given thread.
createMessage(long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Creates a new private message.
createPoll(int, long, long, String) - Method in interface com.jivesoftware.community.webservices.PollService
 
createProfileField(ProfileField) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Creates a new profile field.
createRating(int, String) - Method in interface com.jivesoftware.community.webservices.RatingsService
Create a new rating with the specified attributes.
createRecentDocumentsFilter(int) - Static method in class com.jivesoftware.community.webservices.DocumentResultFilter
Creates a filter for the latest documents by creation date, with the number of results defined by numResults
createReplyMessage(String, String, long, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Creates a new message that is a direct response to a given message.
createServiceProxy(Class<U>, boolean) - Method in class com.jivesoftware.community.webservices.ServiceLocator
This will create an service proxy for the specified class interface.
createStatusLevel(String, String, int, int) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Creates a new points based StatusLevel.
createStatusLevel(String, String, long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Creates a new group based StatusLevel Level
createSubCommunity(String, String, String, long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Creates a new Community as a sub-community off of the specified community.
createTag(String) - Method in interface com.jivesoftware.community.webservices.TagService
Creates a tag in the database.
createThread(String, String, long, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Creates a new thread.
createThreadWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Create a watch on a thread for the specified user.
createUser(String, String, String) - Method in interface com.jivesoftware.community.webservices.UserService
Create a new user.
createUserWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Create a watch on a user for the specified user.
createUserWithUser(User) - Method in interface com.jivesoftware.community.webservices.UserService
Create a new user.
CREATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
creationDate - Variable in class com.jivesoftware.community.webservices.ContentTag
 
CRONTASK - Static variable in class com.jivesoftware.community.JiveConstants
 
cullCache() - Method in class com.jivesoftware.community.webservices.Cache
Removes the least recently used elements if the cache size is greater than or equal to the maximum allowed size until the cache is at least 10% empty.

D

DATE - Static variable in class com.jivesoftware.community.webservices.Query
Sort by date
DAY - Static variable in class com.jivesoftware.community.JiveConstants
One day (in milliseconds).
deleteAllComments(int, long) - Method in interface com.jivesoftware.community.webservices.CommentService
Deletes all comments on the object.
deleteBlog(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Permanently deletes a blog and all of the blog postings and comments associated with the blog.
deleteBlogPost(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Permanently deletes a blog post and all of the comments associated with the it.
deleteComment(int, long, long) - Method in interface com.jivesoftware.community.webservices.CommentService
Deletes a comment in the object.
deleteCommentRecursive(int, long, long, boolean) - Method in interface com.jivesoftware.community.webservices.CommentService
Deletes a comment in the object.
deleteCommunity(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Used to delete the specified community
deleteDocument(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Deletes a document.
deleteDocumentProperty(String, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Delete a property with the given name from the document with the given ID.
deleteExpiredEntries() - Method in class com.jivesoftware.community.webservices.Cache
Clears all entries out of cache where the entries are older than the maximum defined age.
deleteFolder(long, int) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Deletes a folder.
deleteGroup(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Delete the group with the specified id.
deleteMessage(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Delete the message with the following id.
deleteMessage(long, long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Deletes a private message from the folder by moving it to the trash folder.
deleteMessageAndChildren(long, boolean) - Method in interface com.jivesoftware.community.webservices.ForumService
Delete the message with the specified id.
deleteMessageProperty(String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Delete a property with the given name from the message with the given ID.
deleteOption(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Remove an option from the poll.
deletePoll(long) - Method in interface com.jivesoftware.community.webservices.PollService
Deletes a poll.
deleteProfileByID(long) - Method in interface com.jivesoftware.community.webservices.ProfileService
Removes all user profile data associated with a particular profile field.
deleteProfileByUserID(long) - Method in interface com.jivesoftware.community.webservices.ProfileService
Removes all user profile data associated with a particular user.
deleteProfileField(long) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Removes a profile field from the system.
deleteProperty(String, long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Delete a property with the given name from the community with the given id.
deleteProperty(String, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Deletes an extended property from the specfied group.
deleteProperty(String) - Method in interface com.jivesoftware.community.webservices.SystemPropertiesService
Deletes a Jive System Property.
deleteStatusLevel(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Deletes a statusLevel level from the system
deleteThread(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Deletes a thread with the specified ID.
deleteThreadProperty(String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Delete a property with the given name from the thread with the given ID.
deleteUser(long) - Method in interface com.jivesoftware.community.webservices.UserService
Delete the user with the specified id.
deleteUserProperty(String, long) - Method in interface com.jivesoftware.community.webservices.UserService
Delete an extended property from a user.
deleteWatch(Watch) - Method in interface com.jivesoftware.community.webservices.WatchService
Delete the specified watch.
deleteWatches(long) - Method in interface com.jivesoftware.community.webservices.WatchService
Deletes all watches that a user has.
DESCENDING - Static variable in class com.jivesoftware.community.webservices.Query
Descending sort (ie 3, 2, 1...).
DESCENDING - Static variable in class com.jivesoftware.community.webservices.ResultFilter
Descending sort (ie 3, 2, 1...).
DOCUMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
Document - Class in com.jivesoftware.community.webservices
A Document object encapsulates a document in the Clearspace system.
Document() - Constructor for class com.jivesoftware.community.webservices.Document
 
DOCUMENT_BACKCHANNEL - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_BODY - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_FIELD - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_FIELD_OPTION - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_FIELD_TYPE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_ID - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_PRESENTER - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_STATE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TITLE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TYPE - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_TYPE_ELEMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_VERSION - Static variable in class com.jivesoftware.community.JiveConstants
 
DOCUMENT_VERSION_COMMENT - Static variable in class com.jivesoftware.community.JiveConstants
 
DocumentResultFilter - Class in com.jivesoftware.community.webservices
Filters and sorts lists of Documents.
DocumentResultFilter() - Constructor for class com.jivesoftware.community.webservices.DocumentResultFilter
 
DocumentService - Interface in com.jivesoftware.community.webservices
This service provides methods to load and manipulate documents, comments.
documentService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
DRAFT - Static variable in class com.jivesoftware.community.JiveConstants
 

E

EDIT_AVATAR - Static variable in class com.jivesoftware.community.Permissions
Permission to create and delete avatars
editProfileField(ProfileField) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Edits the profile field data.
editProfileFieldOptions(ProfileField) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Edits the ProfileFieldOption objects for a profile field.
EMAIL_WATCH - Static variable in class com.jivesoftware.community.webservices.Watch
Email watch type.
entrySet() - Method in class com.jivesoftware.community.webservices.Cache
 
equals(Object) - Method in class com.jivesoftware.community.webservices.ApprovalStatus
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Blog
 
equals(Object) - Method in class com.jivesoftware.community.webservices.BlogPost
 
equals(Object) - Method in class com.jivesoftware.community.webservices.ContentTag
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Document
 
equals(Object) - Method in class com.jivesoftware.community.webservices.ForumMessage
 
equals(Object) - Method in class com.jivesoftware.community.webservices.ForumThread
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Group
 
equals(Object) - Method in class com.jivesoftware.community.webservices.JiveObject
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Locale
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Poll
 
equals(Object) - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Property
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Query
 
equals(Rating) - Method in class com.jivesoftware.community.webservices.Rating
Test for equality between two rating objects.
equals(Object) - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
equals(Object) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
equals(Object) - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
equals(Object) - Method in class com.jivesoftware.community.webservices.TagCount
 
equals(Object) - Method in class com.jivesoftware.community.webservices.User
 
equals(Object) - Method in class com.jivesoftware.community.webservices.Watch
 
equals(Object) - Method in class com.jivesoftware.community.webservices.WSConstants.AccessType
 
EXPIRATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
EXTENDED_PROPERTY - Static variable in class com.jivesoftware.community.JiveConstants
 

F

FAULT_ATTACHMENT - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the AttachmentManager
FAULT_BINARY_BODY - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to BinaryBodyException
FAULT_BLOG_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to BlogNotFoundException
FAULT_BLOG_POST_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to BlogPostNotFoundException
FAULT_COMMENT_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to ClassNotFoundException
FAULT_COMMUNITY_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the CommunityNotFoundException
FAULT_DOCUMENT_ALREADY_EXISTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the DocumentObjectNotFoundException
FAULT_DOCUMENT_OBJECT_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the DocumentObjectNotFoundException
FAULT_GROUP_ALREADY_EXISTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the GroupNotFoundException
FAULT_GROUP_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the GroupNotFoundException
FAULT_JIVE_RUNTIME - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the JiveRuntimeException
FAULT_LICENSE_EXCEPTION - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to LicenseException
FAULT_MESSAGE_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the ForumMessageNotFoundException
FAULT_MESSAGE_REJECTED - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the RejectedException
FAULT_NAME_ALREADY_EXISTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the NameAlreadyExistsException
FAULT_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the RejectedException
FAULT_POLL_EXCEPTION - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to LicenseException
FAULT_TAG_OBJECT_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to TagObjectNotFoundException
FAULT_THREAD_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the ForumThreadNotFoundException
FAULT_UNAUTHORIZED - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault to the UnauthorizedException
FAULT_USER_NOT_FOUND - Static variable in class com.jivesoftware.community.webservices.WSConstants
Maps a fault code to the UserNotFoundException
FeedbackResultFilter - Class in com.jivesoftware.community.webservices
 
FeedbackResultFilter() - Constructor for class com.jivesoftware.community.webservices.FeedbackResultFilter
 
FOLDER_DRAFTS - Static variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
FOLDER_INBOX - Static variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
FOLDER_SENT - Static variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
FOLDER_TRASH - Static variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
ForumMessage - Class in com.jivesoftware.community.webservices
A ForumMessage encapsulates message data.
ForumMessage() - Constructor for class com.jivesoftware.community.webservices.ForumMessage
 
ForumMessageNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified ForumMessage was not found
ForumMessageNotFoundException() - Constructor for exception com.jivesoftware.community.ForumMessageNotFoundException
 
ForumMessageNotFoundException(String) - Constructor for exception com.jivesoftware.community.ForumMessageNotFoundException
 
ForumService - Interface in com.jivesoftware.community.webservices
Provides the ability to manipulate forum messages.
forumService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
ForumThread - Class in com.jivesoftware.community.webservices
A ForumThread is a container for a hierarchy of ForumMessages.
ForumThread() - Constructor for class com.jivesoftware.community.webservices.ForumThread
 
ForumThreadNotFoundException - Exception in com.jivesoftware.community
Thrown if the specified ForumThread was not found
ForumThreadNotFoundException() - Constructor for exception com.jivesoftware.community.ForumThreadNotFoundException
 
ForumThreadNotFoundException(String) - Constructor for exception com.jivesoftware.community.ForumThreadNotFoundException
 

G

GATEWAY - Static variable in class com.jivesoftware.community.JiveConstants
 
GENERAL_ERROR - Static variable in exception com.jivesoftware.community.AttachmentException
 
get(Object) - Method in class com.jivesoftware.community.webservices.Cache
 
getAccessType(String) - Static method in class com.jivesoftware.community.webservices.WSConstants.AccessType
Returns the access type that matches the access type name.
getActivePollCount() - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all active polls in the system.
getActivePollCount(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all active polls of a given type and object ID.
getActivePolls() - Method in interface com.jivesoftware.community.webservices.PollService
Returns an iterable of active polls in the system.
getActivePolls(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns an iterable of active polls associated with the object specified by the objectType and objectID.
getAddressBookService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of AddressBookService.
getAdministratorCount(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns the count of how many administrators there are for the group with the specified ID.
getAfterDate() - Method in class com.jivesoftware.community.webservices.Query
Returns the earliest date for search results.
getAllBlogPostIDs() - Method in class com.jivesoftware.community.webservices.Blog
Returns all the blog post IDs for this blog.
getAllowedTypes() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns a List of explicitly allowed types.
getAllStatusLevelScenarios() - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns all of the StatusLevelScenario objects.
getAnonymousVoteCount(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all guests user votes for all options in the poll.
getAnonymousVoteCount(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all user votes for the specified option in the poll.
getAnonymousVoteIndices(long, String) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a list of option indexes corresponding to the anonymous votes, or an empty array if the user has not voted.
getAnonymousVotes(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a list of uniqueID's for guests who have voted for the option at the given index.
getAnonymousVotes(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Returns an Iterator of uniqueID's for guests who have voted for the option at the given index.
getApprovalStatusForDocument(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns a collection of ApprovalStatus objects.
getApprovedDate() - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Returns the date the user approved the document.
getArgs() - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
getAttachmentCount() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the number of attachments this blog post has.
getAttachmentCount() - Method in class com.jivesoftware.community.webservices.Document
 
getAttachmentCount() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the number of attachments this message has.
getAttachmentCountByDocumentID(String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the number of attachments on the document with the specified id.
getAttachmentCountByInternalDocID(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the number of attachments on the document with the specified internal id.
getAttachmentManagerService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of AttachmentService
getAttachmentName() - Method in exception com.jivesoftware.community.AttachmentException
 
getAttachmentsByBlogPostID(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns an array of attachments that are attached to the specified blog post.
getAttachmentsByDocumentID(String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Acquire the attachments for a document by the document id.
getAttachmentsByInternalDocID(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Acquire the attachments for a document by the internal document id.
getAttachmentsByMessageID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array of attachments that are attached to the specified message.
getAuthorCount() - Method in class com.jivesoftware.community.webservices.Document
Returns the count of authors which have been added to this document.
getAuthors(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the userss who are allowed to edit the document.
getAvailableRatingCount() - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns the count of currently available ratings.
getAvailableRatings() - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns an iterable of Rating objects that list all the available ratings.
getBeforeDate() - Method in class com.jivesoftware.community.webservices.Query
Returns the latest date for search results.
getBinaryDocumentContent(String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the content of the binary document.
getBlog(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns a blog by blog ID.
getBlog(String) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns a blog by blog name.
getBlogCount() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the total number of blogs on this system.
getBlogCount(BlogResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the total number of blogs on this system that match the criteria specified by the ResultFilter.
getBlogCountForUser(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the count of all blogs which are associated with the given user.
getBlogID() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the blog ID this post belongs to.
getBlogID() - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Returns the blogID that results will be filtered on.
getBlogPost(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns a blog by blog ID.
getBlogPostCount() - Method in class com.jivesoftware.community.webservices.Blog
Returns the number of blog posts on this blog, by default only includes blog posts where status = BlogPost.STATUS_PUBLISH and publish date less than now().
getBlogPostCount() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the number of blog posts on the system, by default only includes blog posts where status = BlogPost.STATUS_PUBLISH and publish date less than now().
getBlogPostCount(BlogPostResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the number of blog posts on the system.
getBlogPosts(BlogPostResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all the blog posts that match the criteria specified by the BlogPostResultFilter on the entire system.
getBlogsByDisplayName(String, int, int, int) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all the blogs on this system whose display name is LIKE the given query.
getBlogService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns an instance of BlogService.
getBlogsForUser(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all blogs which are associated with the given user.
getBody() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the post body.
getBody() - Method in class com.jivesoftware.community.webservices.Comment
 
getBody() - Method in class com.jivesoftware.community.webservices.Document
Returns the textual body of the document.
getBody() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the message body.
getBody() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getCachedSize() - Method in class com.jivesoftware.community.Permissions
 
getCacheHits() - Method in class com.jivesoftware.community.webservices.Cache
 
getCacheMisses() - Method in class com.jivesoftware.community.webservices.Cache
 
getChild(long, int) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the child of parent at index index in the parent's child array.
getChildCount(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of children of parent.
getChildren(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array of all the child messages of the parent.
getCode() - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
getComment(int, long, long) - Method in interface com.jivesoftware.community.webservices.CommentService
Acquire a comment.
getCommentAuthenticationStrategy() - Method in class com.jivesoftware.community.webservices.Blog
Returns the comment authentication strategy of this blog which may be any one of the following: Blog.COMMENT_AUTH_REQUIRED -- must register and login to comment Blog.COMMENT_AUTH_OPTIONAL_WITH_EMAIL -- must either register and login or provide an email address in the comment form.
getCommentCount() - Method in class com.jivesoftware.community.webservices.Blog
Returns the total number of comments on this blog.
getCommentCount() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the number of comments this blog post has.
getCommentCount() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the number of comments on blog posts in the system.
getCommentCount(FeedbackResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns the number of comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getCommentCount(int, long) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns the number of comments in the object.
getCommentCountWithFilter(int, long, CommentResultFilter) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns the number of comments in the object based on the specified ResultFilter.
getCommentObjectID() - Method in class com.jivesoftware.community.webservices.Comment
 
getCommentObjectType() - Method in class com.jivesoftware.community.webservices.Comment
 
getComments(FeedbackResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all the comments on blog posts that match the criteria specified by the FeedbackResultFilter in the entire system.
getComments(int, long) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns an array of all the comments in the object.
getCommentService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns an instance of CommentService.
getCommentStatus() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the comment status of this blog post which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now Defaults to OPEN.
getCommentStatus() - Method in class com.jivesoftware.community.webservices.Document
Returns the comment status of this document.
getCommentStatus() - Method in class com.jivesoftware.community.webservices.Poll
Returns the comment status of this poll which may be any one of the following: NONE -- no comments allowed OPEN -- comments are permitted CLOSED -- comments were permitted but are not allowed now Defaults to OPEN.
getCommunity(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns a Community by its id
getCommunityCount() - Method in class com.jivesoftware.community.webservices.Community
Returns the number of community in the community.
getCommunityDepth() - Method in class com.jivesoftware.community.webservices.Community
Returns the depth of a this community relative to the root.
getCommunityID() - Method in exception com.jivesoftware.community.CommunityNotFoundException
The id of the community that was not found.
getCommunityID() - Method in class com.jivesoftware.community.webservices.CommentResultFilter
Returns the communityID.
getCommunityID() - Method in class com.jivesoftware.community.webservices.Document
 
getCommunityID() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the ID of the community this message belongs to.
getCommunityID() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the ID of the community this thread belongs to.
getCommunityIndex() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the index of this message in the community.
getCommunityService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of CommunityService.
getCommunityWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns a watch on a particular community, or null if there isn't a watch.
getCommunityWatchCount(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Return the count of all community watches in a particular communityID for the given userID.
getCommunityWatches(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns an array of IDs for all the community objects a user is watching in a community.
getContainerObjectID() - Method in class com.jivesoftware.community.webservices.Poll
Returns the object ID of the container that 'contains' the poll.
getContainerObjectType() - Method in class com.jivesoftware.community.webservices.Poll
Returns the object type of the container that 'contains' the poll.
getContentType() - Method in class com.jivesoftware.community.webservices.Attachment
 
getContentType() - Method in class com.jivesoftware.community.webservices.BinaryBody
Returns the content type of the body object.
getContentType() - Method in class com.jivesoftware.community.webservices.Image
 
getContentTypes() - Method in class com.jivesoftware.community.webservices.Community
 
getCountryCode() - Method in class com.jivesoftware.community.webservices.Locale
Returns the country/region code for this locale, which will either be the empty string or an upercase ISO 3166 2-letter code.
getCreationDate() - Method in class com.jivesoftware.community.webservices.Blog
Returns the date that this blog was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the date that this post was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.Comment
 
getCreationDate() - Method in class com.jivesoftware.community.webservices.Community
Returns the Date that the community was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.ContentTag
Returns the date that this tag was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.Document
A convenience method which returns the date the document was originally created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the date this message was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the date that this thread was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.Group
Returns the date that the group was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.Poll
Returns the date the poll was created.
getCreationDate() - Method in class com.jivesoftware.community.webservices.User
Returns the date that the user was created.
getCreationDateRangeMax() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns a date that represents the upper boundry for messages or threads to be selected by the result filter.
getCreationDateRangeMin() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the creation date that represents the lower boundary for messages or threads to be filtered on.
getData() - Method in class com.jivesoftware.community.webservices.Attachment
 
getData() - Method in class com.jivesoftware.community.webservices.BinaryBody
Returns a InputStream for the binary contents of the body object.
getData() - Method in class com.jivesoftware.community.webservices.Image
 
getDate() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getDeleteDays() - Method in interface com.jivesoftware.community.webservices.WatchService
Returns the number of days that a watched object can remain inactive before watches on that object are deleted.
getDescription() - Method in class com.jivesoftware.community.webservices.Blog
Returns the description of the blog.
getDescription() - Method in class com.jivesoftware.community.webservices.Community
Returns the description of the community.
getDescription() - Method in class com.jivesoftware.community.webservices.Group
Returns the description of the group.
getDescription() - Method in class com.jivesoftware.community.webservices.Poll
Returns a brief description of the poll.
getDescription() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets the description of this profile field.
getDescription() - Method in class com.jivesoftware.community.webservices.Rating
Retrieve the description for the rating.
getDescription() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getDisallowedTypes() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns a List of explicitly disallowed types.
getDisplayName() - Method in class com.jivesoftware.community.webservices.Blog
Gets the display name of a blog.
getDisplayName() - Method in class com.jivesoftware.community.webservices.Community
Returns the displayName of the community.
getDocumentApproversOnCommunity(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.
getDocumentApproversOnDocument(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns all of the users that must approve new documents before they reach a PUBLISHED state when it is in a PENDING_APPROVAL state.
getDocumentByDocumentID(String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns a document from the community based on its document ID.
getDocumentByDocumentIDAndVersion(String, int) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the revision of the document with the specified docID and version number.
getDocumentByInternalDocID(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the document with the specified docID.
getDocumentByInternalDocIDAndVersion(long, int) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the revision of document with the specified docID and version number.
getDocumentID() - Method in class com.jivesoftware.community.webservices.Document
Returns the document ID corresponding to the document.
getDocumentIDs(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns document IDs for all the published documents in the community.
getDocumentProperties(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns all tbe extended properties for the message with the specified ID.
getDocumentProperty(String, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns a specific extended property for the document with the specified property name and document ID.
getDocumentsByCommunity(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns all of the documents for the specified community.
getDocumentsByCommunityAndFilter(long, DocumentResultFilter) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns all of the documents in the given community after the specified filter has been applied.
getDocumentService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
 
getDocumentTypeID() - Method in class com.jivesoftware.community.webservices.Document
Return the type of the document.
getDownloadCount() - Method in class com.jivesoftware.community.webservices.BinaryBody
Returns the number of times the binary body has been downloaded.
getEmail() - Method in class com.jivesoftware.community.webservices.Comment
 
getEmail() - Method in class com.jivesoftware.community.webservices.User
Returns the user's email address.
getEndDate() - Method in class com.jivesoftware.community.webservices.Poll
Returns the date voting for the poll should end.
getErrorType() - Method in exception com.jivesoftware.community.AttachmentException
 
getExpirationDate() - Method in class com.jivesoftware.community.webservices.Document
Returns the date that the document is set to expire on.
getExpirationDate() - Method in class com.jivesoftware.community.webservices.Poll
Returns the date the poll should expire.
getFieldID() - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Gets the id of the ProfileField in which this option belongs.
getFieldID() - Method in class com.jivesoftware.community.webservices.UserProfile
Gets the id of the profile field.
getFinalLocale() - Method in class com.jivesoftware.community.webservices.Community
Returns the locale for this community.
getFirstPostID() - Method in class com.jivesoftware.community.webservices.Blog
Returns the first blog post ID on this blog.
getFolder(long, int) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the specified folder for a user.
getFolderID() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getFolders(long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns an Iterator of PrivateMessageFolder objects for the folders the user has.
getForumMessage(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns a ForumMessage by its ID.
getForumService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of ForumService.
getForumThread(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns a ForumThread by its ID.
getForumThreadID() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the ID of the thread this message belongs to.
getGroup(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns a Group by its ID.
getGroup() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getGroupAdmins(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns an array of all the user IDs that administer this group.
getGroupByName(String) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns a Group by its name.
getGroupCount() - Method in interface com.jivesoftware.community.webservices.GroupService
Returns a count of all groups in the system.
getGroupMembers(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns an array of all userIDs for all the members of a particular group.
getGroups() - Method in interface com.jivesoftware.community.webservices.GroupService
Returns an array of all the group IDs for all the groups in the system.
getGroupService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of GroupService
getGroupStatusLevel(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
If there is a status level associated with the group passed in then the status level will be returned, Otherwise null will be returned.
getGroupStatusLevels() - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an array of all group based status levels in the system.
getI18nKey() - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
getID() - Method in class com.jivesoftware.community.webservices.Attachment
 
getID() - Method in class com.jivesoftware.community.webservices.Comment
 
getID() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the id of this message.
getID() - Method in class com.jivesoftware.community.webservices.JiveObject
Retrieve the unique identifier for the jive object, or -1 if the object hasn't yet been added/inserted into the system.
getID() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets the id representing this profile field.
getID() - Method in class com.jivesoftware.community.webservices.User
Returns the user's id.
getImageCount() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the number of images this blog post has.
getImageCount() - Method in class com.jivesoftware.community.webservices.Document
Returns the number of images the document has.
getImageCount() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the number of images this message has.
getImageCountByDocumentID(String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the number of images on the document with the specified id.
getImageCountByInternalDocID(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the number of images on the document with the specified internal id.
getImagePath() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getImagePreviewMaxSize() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns the max dimension of generated thumbnails (ie, the max value for the width or height).
getImagesByBlogPostID(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns an array of images that are attached to the specified blog post.
getImagesByMessageID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array of images that are attached to the specified message.
getIndex() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets the index of this profile field.
getIndex() - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Gets the index of this option which represents the order in which the options will appear in the list.
getIndexOfChild(long, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the index of child in parent.
getIPAddress() - Method in class com.jivesoftware.community.webservices.Comment
 
getJiveObject() - Method in exception com.jivesoftware.community.RejectedException
Returns the jive object that triggered the exception.
getLanguage() - Method in class com.jivesoftware.community.webservices.Document
Return the ISO-639 code of the language associated with the document, or null if the document has no language specified (thus implying that it uses the global default language).
getLanguageCode() - Method in class com.jivesoftware.community.webservices.Locale
Returns the language code for this locale, which will either be the empty string or a lowercase ISO 639 code.
getLargeImagePath() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getLastPostID() - Method in class com.jivesoftware.community.webservices.Blog
Returns the last blog post ID on this blog.
getLatestMessageID() - Method in class com.jivesoftware.community.webservices.Community
Returns the most recently created or edited message in this community (including all sub-communities).
getLatestMessageID() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the ID of the most recently created messages in this thread.
getLeaders() - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an array of system wide leaders.
getLeaders(int, int) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an array of system wide leaders.
getLeaders(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an Iterable of leaders for a specific community
getLeaders(long, int, int) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an Iterable of leaders for a specific community
getLivePollCount() - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all live polls in the system.
getLivePollCount(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all live polls of a given type and object ID.
getLivePolls() - Method in interface com.jivesoftware.community.webservices.PollService
Returns a List of live polls in the system.
getLivePolls(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns an iterable of live polls associated with the object specified by the objectType and objectID.
getLocale() - Method in class com.jivesoftware.community.webservices.Community
Returns the locale for this community.
getMaxAttachmentSize() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns the maximum size of an individual attachment in kilobytes.
getMaxAttachmentsPerBlogPost() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns the maximum number of attachments per blog post.
getMaxAttachmentsPerDocument() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns the maximum number of attachments per document.
getMaxAttachmentsPerMessage() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns the maximum number of attachments per message.
getMaxCacheLifetime() - Method in interface com.jivesoftware.community.webservices.CacheableService
Returns the maximum amount of time an item can be in the cache.
getMaxCacheSize() - Method in class com.jivesoftware.community.webservices.Cache
 
getMaxCacheSize() - Method in interface com.jivesoftware.community.webservices.CacheableService
Returns the maximum size of the cache.
getMaxLifetime() - Method in class com.jivesoftware.community.webservices.Cache
 
getMaxPoints() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getMeanRating(int, long) - Method in interface com.jivesoftware.community.webservices.RatingsService
A convenience method which returns a geometric mean average of all the ratings given to the JiveContentObject.
getMemberCount() - Method in class com.jivesoftware.community.webservices.Group
Returns the number of users that belon gto this group.
getMessage(long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the specified private message.
getMessageCount() - Method in class com.jivesoftware.community.webservices.Community
Returns the number of messages in the community.
getMessageCount() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the number of messages in the thread.
getMessageCount() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
getMessageCount(long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the total number of private messages a user has in their mailbox.
getMessageCountByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the community.
getMessageCountByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the community with the specified id after the specified filter has been applied.
getMessageCountByThreadID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the thread.
getMessageCountByThreadIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the thread with the specified id after the specified filter has been applied.
getMessageCountForFolder(long, int) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the message count on a specific folder.
getMessageCountsByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the community.
getMessageCountsByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of messages that are in the forum with the specified id after the specified filter has been applied.
getMessageDepth(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the depth of a message in the message tree hierarchy.
getMessageIDsByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the message IDs for all of the message that are in the community.
getMessageIDsByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the message IDs for all of the message that are in the community with the specified ID, filtered by the the specified result filter.
getMessageIDsByThreadID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the IDs of the messages that are in the thread.
getMessageIDsByThreadIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the message IDs for all of the message that are in the thread after the specified filter has been applied.
getMessageProperties(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all tbe extended properties for the message with the specified ID.
getMessageProperty(String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns a specific extended property for the message with the specified property name and message ID.
getMessages(long, long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns all the messages in the folder sorted by date descending.
getMessagesByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the messages that are in the community.
getMessagesByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the messages that are in the community with the specified ID, filtered by the the specified result filter.
getMessagesByThreadID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the messages that are in the thread.
getMessagesByThreadIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the messages that are in the thread after the specified filter has been applied.
getMethod() - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
getMinimum() - Method in class com.jivesoftware.community.webservices.TagResultFilter
Returns the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
getMinPoints() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getMode() - Method in class com.jivesoftware.community.webservices.Poll
 
getModerationRangeMax() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the moderation value that represents the upper bound for messages or threads to be selected by the result filter.
getModerationRangeMin() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the moderation value that represents the lower boundry for messages or threads to be selected by the result filter.
getModerationValue() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the number of moderation points this message has.
getModerationValue() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the number of moderation points this thread has.
getModificationDate() - Method in class com.jivesoftware.community.webservices.Blog
Returns the date that the blog name, display name or description was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the date that this post was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.Comment
 
getModificationDate() - Method in class com.jivesoftware.community.webservices.Community
Returns the Date this community was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.Document
A convenience method which returns the date the document was last modified as determined by the version with a DocumentState.PUBLISHED state, or if no version has that state the modification date of the current instance of the document.
getModificationDate() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the date this message was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the date that this thread was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.Group
Returns the date that the group was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.Poll
Returns the date the poll was last modified.
getModificationDate() - Method in class com.jivesoftware.community.webservices.User
Returns the date that the user was last modified.
getModificationDateRangeMax() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns a date that represents the upper boundry for messages or threads to be selected by the result filter.
getModificationDateRangeMin() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns a date that represents the lower boundary for messages or threads to be selected by the result filter.
getName() - Method in class com.jivesoftware.community.webservices.Attachment
 
getName() - Method in class com.jivesoftware.community.webservices.BinaryBody
Returns the name of the body object.
getName() - Method in class com.jivesoftware.community.webservices.Blog
Returns the name of the blog.
getName() - Method in class com.jivesoftware.community.webservices.Comment
 
getName() - Method in class com.jivesoftware.community.webservices.Community
Returns the name of the community.
getName() - Method in class com.jivesoftware.community.webservices.ContentTag
Returns the name of the tag
getName() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the subject of the root message of this thread.
getName() - Method in class com.jivesoftware.community.webservices.Group
Returns the name of the group.
getName() - Method in class com.jivesoftware.community.webservices.Image
 
getName() - Method in class com.jivesoftware.community.webservices.Poll
Returns the name of the poll.
getName() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
getName() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets the internal name of this profile field.
getName() - Method in class com.jivesoftware.community.webservices.Property
Returns the property name.
getName() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
getName() - Method in class com.jivesoftware.community.webservices.TagCount
Returns the name of the tag.
getName() - Method in class com.jivesoftware.community.webservices.User
Returns the user's name.
getName() - Method in class com.jivesoftware.community.webservices.WSConstants.AccessType
 
getNestedThrowable() - Method in exception com.jivesoftware.base.UnauthorizedException
 
getNextPostID() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the next blogpost ID that has been published.
getNumResults() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the max number of results that should be returned.
getObjectID() - Method in class com.jivesoftware.community.webservices.Watch
Returns the object ID of the object being watched.
getObjectType() - Method in class com.jivesoftware.community.webservices.Comment
 
getObjectType() - Method in class com.jivesoftware.community.webservices.JiveObject
Return the object type of the jive object.
getObjectType() - Method in class com.jivesoftware.community.webservices.Watch
Returns the object type of the object being watched.
getOption(int) - Method in class com.jivesoftware.community.webservices.Poll
Returns the text of the option at the specified index.
getOptionCount() - Method in class com.jivesoftware.community.webservices.Poll
Returns the number of options available in the poll.
getOptions() - Method in class com.jivesoftware.community.webservices.Poll
 
getOptions() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets a array of ProfileFieldOption objects for this profile field.
getOwnerID() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getOwnerID() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
getParent(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the parent of the child ForumMessage.
getParentCommunityID() - Method in class com.jivesoftware.community.webservices.Community
Returns ID of the parent community of this community.
getParentMessageID() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the ID of the parent message of this message or 0 if this message is the root message of a thread.
getPassword() - Method in class com.jivesoftware.community.webservices.User
 
getPermalink() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the permalink for this post, where the permalink is a composed only of unreserved characters: unreserved = ALPHA / DIGIT / "-" / "." / "_" / "~" as according to RFC 3986: http://www.ietf.org/rfc/rfc3986.txt Space characters and characters not in the list of unreserved characters are replaced with a hyphen character.
getPermissionService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of PermissionService
getPingServices() - Method in class com.jivesoftware.community.webservices.Blog
Returns a line break separated list of services that the user has chosen to ping.
getPingServices() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns a comma delimited list of available ping services for the system.
getPlainBody() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the plain body.
getPlainSubject() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the plain subject.
getPointLevel(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns the point level for a user system wide.
getPointLevel(long, long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns the status level points for a user in regards to a specific community
getPoints() - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
getPointStatusLevels() - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns an array of point based status levels in the system sorted by point range.
getPoll(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns the Poll specified by the poll ID.
getPollCount() - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all polls, both active and inactive.
getPollCount(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns an count of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPolls() - Method in interface com.jivesoftware.community.webservices.PollService
Returns an iterable of all polls, both active and inactive.
getPolls(int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns an iterable of polls, both active and inactive, associated with the object specified by the objectType and objectID.
getPollService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Return an instance of PollService
getPopularDocuments() - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the top x documents across all communities according to ratings, document views & time passed since the document was created.
getPopularDocumentsByCommunity(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the top x documents in the given community according to ratings, document views & time passed since the document was created.
getPopularDocumentsByLanguage(String[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the top x documents across all communities according to ratings, document views & time passed since the document was created in the languages specified.
getPopularTags() - Method in class com.jivesoftware.community.webservices.Blog
Returns the 20 most popular tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog.
getPopularThreads() - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array of thread IDs for all the popular threads in the system.
getPopularThreadsByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Return an array of popular threads by community.
getPrefix() - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Returns an optional prefix to be used when search blogs by name.
getPreviousPostID() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the previous blogpost ID that has been published.
getProfile(long) - Method in interface com.jivesoftware.community.webservices.ProfileService
Gets a map of user profile values for a particular user mapped to their corresponding ProfileField id.
getProfileField(long) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Gets a profile field object by its id.
getProfileFields() - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Gets the list of all profile fields in the system.
getProfileFieldService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns an instance of ProfileFieldService.
getProfileImage(long) - Method in interface com.jivesoftware.community.webservices.ProfileService
Returns the profile image for a user.
getProfileService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns an instance of ProfileService
getProperties() - Method in class com.jivesoftware.community.webservices.Blog
Returns the properties associated with this blog.
getProperties() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the properties associated with this blogpost.
getProperties() - Method in class com.jivesoftware.community.webservices.Comment
 
getProperties(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns all tbe extended properties for the community with the specified id.
getProperties(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns an array of all the extended properties for a group.
getProperties() - Method in interface com.jivesoftware.community.webservices.SystemPropertiesService
Obtains all Jive System Properties.
getProperty(String, long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns a specific extended property for the community with the specified property name and community ID.
getPublishDate() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns that date that this post should be published.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Returns a date that represents the upper boundry for blog posts to be selected by the result filter.
getPublishDateRangeMax() - Method in class com.jivesoftware.community.webservices.BlogTagResultFilter
Returns a date that represents the upper boundry for tags to be selected by the result filter.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getPublishDateRangeMin() - Method in class com.jivesoftware.community.webservices.BlogTagResultFilter
Returns the publish date that represents the lower boundary for blog posts to be filtered on.
getQueryString() - Method in class com.jivesoftware.community.webservices.Query
Returns the query string for the Query object.
getRating(long, int, long) - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns the rating associated with the user, or null if this user hasn't rated the JiveContentObject.
getRatingCount(int, long) - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns the total number of ratings given to the JiveContentObject.
getRatingFromScore(int) - Method in interface com.jivesoftware.community.webservices.RatingsService
Retrieve the rating with the specified score.
getRatings(int, long) - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns an Iterable of all the ratings given to the JiveContentObject.
getRatingsService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Return an instance of RatingsService
getRecentBlogPostIDs() - Method in class com.jivesoftware.community.webservices.Blog
Returns (at most) the ten most recent blog postsIDs on this blog.
getRecentBlogs() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns (at most) the ten most recent blogs created on this system.
getRecentCommentIDs() - Method in class com.jivesoftware.community.webservices.Blog
Returns (at most) the ten most recent comment IDs on this blog.
getRecipientID() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getRecursiveChildCount(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the total number of recursive children of a parent.
getRecursiveChildren(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array for all child messages (and sub-children, etc) of the parent.
getRecursiveCommunities() - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns all of the communities in the system recursively.
getRecursiveCommunitiesByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns all of the communities under the specified community recursively.
getRecursiveCommunityCount() - Method in class com.jivesoftware.community.webservices.Community
Returns the number of communities in the community and all sub-communities.
getRecursiveCommunityCount() - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns a count of all the communities in the system.
getRecursiveCommunityCountByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns a count of call the communities under a community
getRecursiveMessages(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns an array for all messages in the thread in depth-first order.
getResolutionDateRangeMin() - Method in class com.jivesoftware.community.webservices.ResultFilter
 
getResolutionnDateRangeMax() - Method in class com.jivesoftware.community.webservices.ResultFilter
 
getResolutionStates() - Method in class com.jivesoftware.community.webservices.ResultFilter
 
getRootCommunity() - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns the root community in the system.
getRootMessage(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the root of a thread.
getRootMessage() - Method in class com.jivesoftware.community.webservices.ForumThread
Returns the root message this thread.
getRoster(long) - Method in interface com.jivesoftware.community.webservices.AddressBookService
Retrieves a list of users contained within the specified users addressbook.
getScore() - Method in class com.jivesoftware.community.webservices.Rating
Retrieve the score for the rating.
getSearchService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of SearchService.
getSenderID() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getSize() - Method in class com.jivesoftware.community.webservices.BinaryBody
Returns the size of the body object in bytes.
getSortField() - Method in class com.jivesoftware.community.webservices.Query
Returns the currently selected sort field.
getSortField() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the currently selected sort field.
getSortOrder() - Method in class com.jivesoftware.community.webservices.Query
Returns the sort order, which will be Query.ASCENDING for ascending sorting, or Query.DESCENDING for descending sorting.
getSortOrder() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the sort order, which will be ResultFilter.ASCENDING for ascending sorting, or ResultFilter.DESCENDING for descending sorting.
getStartDate() - Method in class com.jivesoftware.community.webservices.Poll
Returns the date voting for the poll is set to start.
getStartIndex() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the index of the first result to return.
getStatus() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the status of this blog post which may be any one of the following: PENDING_APPROVAL -- post has status of unpublished PUBLISH -- post has status of published.
getStatusLevel(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Used to acquire a specific status level object from the system
getStatusLevelByPoints(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Used to get a status level by a point value.
getStatusLevelScenarioByCode(String) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns a StatusLevelScenario by its code.
getSubCommunities(long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Returns all the sub communities for the parent community.
getSubject() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the blog post subject.
getSubject() - Method in class com.jivesoftware.community.webservices.Document
Returns the title of the document.
getSubject() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the message subject.
getSubject() - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
getSystemPropertiesService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of SystemPropertiesService
getTagByID(long) - Method in interface com.jivesoftware.community.webservices.TagService
Returns a tag given a tag ID.
getTagByName(String) - Method in interface com.jivesoftware.community.webservices.TagService
Returns a tag by tag name.
getTags() - Method in class com.jivesoftware.community.webservices.Blog
Returns all tags for a given blog in a Map where the key is the name of tag and the value is the number of times the tag has been used in this blog.
getTags() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the tags associated with this blogpost.
getTags() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all tags for blogs in the system.
getTags(BlogTagResultFilter) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns all tags for blogs in the system filtered by the BlogTagResultFilter.
getTags() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the the ContentTags to filter on.
getTags(JiveObject) - Method in interface com.jivesoftware.community.webservices.TagService
Return an Iterable for all the tags associated with this manager.
getTagService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns an instance of TagService.
getThreadCount() - Method in class com.jivesoftware.community.webservices.Community
Returns number of thread in the community and all sub-communities
getThreadCountByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of threads in the specified community.
getThreadCountByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the number of threads in the specified community after being filtered by the specified filter.
getThreadProperties(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all tbe extended properties for the thread with the specified ID.
getThreadProperty(String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns a specific extended property for the thread with the specified property name and thread ID.
getThreadsByCommunityID(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the IDs for threads a community.
getThreadsByCommunityIDAndFilter(long, ResultFilter) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns all of the IDs for threads a community has filtered by the specified result filter.
getThreadWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns a watch on a particular thread, or null if there isn't a watch.
getTotalWatchCount(long, int) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns a count of all watches that a userID has of a particular type.
getTrackbackCount() - Method in class com.jivesoftware.community.webservices.Blog
Returns the total number of trackbacks on this blog.
getTypeID() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets the id of the type of this profile field.
getUnfilteredBody() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the unfiltered body.
getUnfilteredBody() - Method in class com.jivesoftware.community.webservices.Comment
 
getUnfilteredBody() - Method in class com.jivesoftware.community.webservices.Document
Returns the textual body of the document, bypassing any active filters.
getUnfilteredBody() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the message body, bypassing any active filters.
getUnfilteredMessageProperties(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns the properties without applying filters to them first.
getUnfilteredName() - Method in class com.jivesoftware.community.webservices.ContentTag
Returns the unfiltered name of the tag
getUnfilteredSubject() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the unfiltered subject.
getUnfilteredSubject() - Method in class com.jivesoftware.community.webservices.Document
Returns the document title, bypassing any active filters.
getUnfilteredSubject() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the message subject, bypassing any active filters.
getUnreadMessageCount() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
getUnreadMessageCount(long) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the total number of unread private messages a user has in their mailbox.
getUnreadMessageCountForFolder(long, int) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns the total number of unread private messages a user has in a specific folder.
getUploadedDocBodyId(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the bodyID of the uploaded document
getUploadedDocName(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns the name of the uploaded document
getURL() - Method in class com.jivesoftware.community.webservices.Comment
 
getUser() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns the ID User that authored this blogpost.
getUser() - Method in class com.jivesoftware.community.webservices.Comment
 
getUser() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns the ID User that authored this message.
getUser() - Method in class com.jivesoftware.community.webservices.Poll
Returns the user who created the poll or null if the poll was created anonymously.
getUser(long) - Method in interface com.jivesoftware.community.webservices.UserService
Returns a user by its id.
getUserApprovalDocuments(long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns a list of documents that a user needs to approve.
getUserByEmailAddress(String) - Method in interface com.jivesoftware.community.webservices.UserService
Returns a user object corresponding to the email address given.
getUserByUsername(String) - Method in interface com.jivesoftware.community.webservices.UserService
Returns a user by its username.
getUserContentCommentCount(long) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentCommentCountWithFilter(long, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns a count of all the comments in all content which has been authored by the supplied user.
getUserContentComments(long) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns array of all the comments in all content which has been authored by the supplied user.
getUserContentCommentsWithFilter(long, UserContentCommentResultFilter) - Method in interface com.jivesoftware.community.webservices.CommentService
Returns array of all the comments in all content which has been authored by the supplied user.
getUserCount() - Method in class com.jivesoftware.community.webservices.Blog
Returns the number of users associated with this blog.
getUserCount() - Method in interface com.jivesoftware.community.webservices.UserService
Returns the number of users in the system.
getUserGroups(long) - Method in interface com.jivesoftware.community.webservices.GroupService
Returns an array of all the group IDs that a user belongs too.
getUserID() - Method in exception com.jivesoftware.base.UserNotFoundException
Returns id of the user not found if available, else -1.
getUserID() - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Returns the id of the approval user.
getUserID() - Method in class com.jivesoftware.community.webservices.Document
Returns the user that authored the document.
getUserID() - Method in class com.jivesoftware.community.webservices.ResultFilter
Returns the userID that results will be filtered on.
getUserID() - Method in class com.jivesoftware.community.webservices.Watch
Returns the if of the user who is associated with this watch.
getUserIDs() - Method in class com.jivesoftware.community.webservices.Blog
Return all the user IDs given permission to post to this blog.
getUsername() - Method in exception com.jivesoftware.base.UserNotFoundException
Returns username of the user not found if available, else null.
getUsername() - Method in class com.jivesoftware.community.webservices.User
Returns the user's username.
getUserProperties(long) - Method in interface com.jivesoftware.community.webservices.UserService
Return all extended properties for the user with the specified id.
getUsers() - Method in interface com.jivesoftware.community.webservices.UserService
Returns the IDs of the first 1000 users.
getUsersBounded(int, int) - Method in interface com.jivesoftware.community.webservices.UserService
Returns the IDs of users begining at startIndex and until the number results equals numResults.
getUserService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of UserService
getUserStatusLevel(long) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns the system wide status level for specific user, will return null if there is no status level for this user.
getUserVoteCount(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all user votes for all options in the poll.
getUserVoteCount(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all user votes for the specified option in the poll.
getUserVoteIndices(long, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a list of option indexes corresponding to the user votes, or an empty array if the user has not voted.
getUserVotes(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a List of User objects for users who have voted for any options in the poll.
getUserVotes(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a list of User objects for users who have voted for the option at the given index.
getUserWatch(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns a watch on a particular user, or null if there isn't a watch.
getUses() - Method in class com.jivesoftware.community.webservices.TagCount
Returns the number of times the tag is used.
getValue() - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Gets the value of this option.
getValue() - Method in class com.jivesoftware.community.webservices.Property
Returns the property value.
getValue() - Method in class com.jivesoftware.community.webservices.UserProfile
Gets the value that the user selected for the profile field.
getValues() - Method in class com.jivesoftware.community.webservices.UserProfile
Gets the array of values that the user selected for the profile field.
getVersion() - Method in class com.jivesoftware.community.webservices.Document
 
getViewCount() - Method in class com.jivesoftware.community.webservices.Document
 
getVoteCount() - Method in class com.jivesoftware.community.webservices.Poll
Returns a count of all votes (both guest and user votes) for all options in the poll.
getVoteCount(long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all votes (both guest and user votes) for all options in the poll.
getVoteCount(long, int) - Method in interface com.jivesoftware.community.webservices.PollService
Returns a count of all votes (both guest and user votes) for the specified option in the poll.
getWatchList(long, int) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns an array of Watch objects for a particular object type that the given user is watching.
getWatchService() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns a new instance of WatchService
getWatchType() - Method in class com.jivesoftware.community.webservices.Watch
Returns the type of the watch.
getWatchUsers(int, long, int) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns all the users who are watching this objectType and objectID.
getXFire() - Method in class com.jivesoftware.community.webservices.ServiceLocator
Returns the current DefaultXFire instance.
GROUP - Static variable in class com.jivesoftware.community.JiveConstants
 
Group - Class in com.jivesoftware.community.webservices
Organizes users into a group for easier permissions management.
Group() - Constructor for class com.jivesoftware.community.webservices.Group
 
GROUP_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer a particular group.
GROUP_MANAGER_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
GroupNotFoundException - Exception in com.jivesoftware.base
Thrown when unable to find a group.
GroupNotFoundException() - Constructor for exception com.jivesoftware.base.GroupNotFoundException
 
GroupNotFoundException(String) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
 
GroupNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
 
GroupNotFoundException(Throwable) - Constructor for exception com.jivesoftware.base.GroupNotFoundException
 
GroupService - Interface in com.jivesoftware.community.webservices
Provides a the ability for managing groups and group membership.
groupService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 

H

hasAnonymousVoted(long, String) - Method in interface com.jivesoftware.community.webservices.PollService
Returns true if the guest associated with the uniqueID has previously voted in the poll, false otherwise.
hashCode() - Method in class com.jivesoftware.community.webservices.ApprovalStatus
 
hashCode() - Method in class com.jivesoftware.community.webservices.Blog
 
hashCode() - Method in class com.jivesoftware.community.webservices.BlogPost
 
hashCode() - Method in class com.jivesoftware.community.webservices.ContentTag
 
hashCode() - Method in class com.jivesoftware.community.webservices.Document
 
hashCode() - Method in class com.jivesoftware.community.webservices.ForumMessage
 
hashCode() - Method in class com.jivesoftware.community.webservices.ForumThread
 
hashCode() - Method in class com.jivesoftware.community.webservices.Group
 
hashCode() - Method in class com.jivesoftware.community.webservices.JiveObject
 
hashCode() - Method in class com.jivesoftware.community.webservices.Locale
 
hashCode() - Method in class com.jivesoftware.community.webservices.Poll
 
hashCode() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
hashCode() - Method in class com.jivesoftware.community.webservices.Property
 
hashCode() - Method in class com.jivesoftware.community.webservices.Query
 
hashCode() - Method in class com.jivesoftware.community.webservices.Rating
 
hashCode() - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
hashCode() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
hashCode() - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
hashCode() - Method in class com.jivesoftware.community.webservices.TagCount
 
hashCode() - Method in class com.jivesoftware.community.webservices.User
 
hashCode() - Method in class com.jivesoftware.community.webservices.Watch
 
hashCode() - Method in class com.jivesoftware.community.webservices.WSConstants.AccessType
 
hasParent(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns true if the child message has a parent message.
hasPermission(long) - Method in class com.jivesoftware.community.Permissions
Returns true if one or more of the permission types is set to true.
hasRated(long, int, long) - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns whether the user has rated the JiveContentObject or not.
hasUserVoted(long, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns true if the user specified has previously voted in the poll, false otherwise.
HOSTED_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to perform hosted operations
HOUR - Static variable in class com.jivesoftware.community.JiveConstants
One hour (in milliseconds).

I

id - Variable in class com.jivesoftware.community.webservices.JiveObject
 
IMAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
Image - Class in com.jivesoftware.community.webservices
 
Image(String, String, byte[]) - Constructor for class com.jivesoftware.community.webservices.Image
 
IMPORT - Static variable in class com.jivesoftware.community.JiveConstants
 
isAllowAllByDefault() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns true if in the "allow all content types by default" mode.
isAnonymous() - Method in class com.jivesoftware.community.webservices.Comment
 
isAnonymous() - Method in class com.jivesoftware.community.webservices.Document
 
isAnonymous() - Method in class com.jivesoftware.community.webservices.ForumMessage
Returns true if this message was posted anonymously.
isApprovalEnabled() - Method in class com.jivesoftware.community.webservices.Document
 
isApproved() - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Returns true if the user has approved the document.
isAttachmentsEnabled() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns true if attachments are enabled, false otherwise.
isAuthorized(long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if the current user has globally has the specified permission.
isAuthorizedOnCommunity(long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if the current user has the permission specified on the specified community.
isBlogsEnabled() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the blogs feature is turned on.
isCachingEnabled() - Method in interface com.jivesoftware.community.webservices.CacheableService
Returns true if caching is enabled for this service.
isCommentModerationEnabled() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if comment moderation is enabled for this blog, false if not.
isCommentNotificationEnabled() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if comment notification is enabled for this blog, false if not.
isCommentsEnabled() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the comments feature is turned on.
isCommentsEnabled() - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns true if the comments feature is turned on.
isCommunityBlog() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if this blog is a community blog, false if not.
isCommunityWatched(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns true if the user is watching the specified community.
isDefaultOption() - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Gets whether or not this option is to be selected by default.
isEditable() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets whether or not this profile field is editable by the user.
isEmailVisible() - Method in class com.jivesoftware.community.webservices.User
Returns true if the user has chosen to make her email visible to other users.
isEmpty() - Method in class com.jivesoftware.community.webservices.Cache
 
isEnabled() - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
isEnabled() - Method in class com.jivesoftware.community.webservices.User
Returns true if the user is enabled.
isExpirable() - Method in class com.jivesoftware.community.webservices.Watch
Returns whether this watch is expirable or not.
isFeedEnabled() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if feeds are enabled for this blog, false if not.
isFeedFullContent() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if the full blog post should be published in feeds, false to instead include an excerpt of the blog post.
isFilterable() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets whether or not this profile field is filterable.
isImagePreviewEnabled() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns true if image preview support is enabled.
isImagePreviewRatioEnabled() - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns true if the aspect ratio of thumbnails should be preserved.
isIncludeAuthorsInUserFilter() - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Returns true if users who have been added as authors to a document should be included when filtering user content comments by user.
isIncludeDocumentBackChannelComments() - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Returns true if document backchannel comments should be included.
isIncludeModerated() - Method in class com.jivesoftware.community.webservices.CommentResultFilter
Returns whether the result to be selected by the result filter should include moderated comments.
isIncludeModerated() - Method in class com.jivesoftware.community.webservices.FeedbackResultFilter
Returns whether the result to be selected by the result filter should include moderated comments.
isIncludeOwnComments() - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Returns true if comments by the user whose content is being queried for comments should be included.
isLeaf(long) - Method in interface com.jivesoftware.community.webservices.ForumService
Returns true if node is a leaf.
isModeEnabled(long, long) - Method in interface com.jivesoftware.community.webservices.PollService
Returns true if the mode specified is enabled for the poll, false otherwise.
isModerated() - Method in class com.jivesoftware.community.webservices.Comment
 
isNameVisible() - Method in class com.jivesoftware.community.webservices.User
Returns true if the user has chosen to make her name visible to other users.
isOnlyCommunity() - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Returns whether the result to be selected by the result filter should include only community blogs.
isOnlyPersonal() - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Returns whether the result to be selected by the result filter should include only personal blogs.
isOnlyPublished() - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Returns whether the result to be selected by the result filter should include published blog posts.
isOverridePing() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if the blog has been configured to override the system settings, false to use the system blog ping settings.
isPingsEnabled() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the pings feature is turned on.
isPingsOverrideEnabled() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the system has been configured to allow users to override the ping URIs configured for the system.
isPrivateMessagesEnabled() - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Returns true if the feature is enabled, false otherwise.
isRatingsEnabled() - Method in interface com.jivesoftware.community.webservices.RatingsService
Returns true if the rating feature is turned on.
isRecursive() - Method in class com.jivesoftware.community.webservices.ResultFilter
If true, the result filter will return content from all sub-communities of specified community, including content from sub-communities of sub-communities, etc.
isRequired() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets whether or not this profile field is a required field.
isSearchable() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets whether or not this profile field is searchable.
isStatusLevelsEnabled() - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Returns true if status levels are enabled in the system
isTextBody() - Method in class com.jivesoftware.community.webservices.Document
Returns true if the body of the document is text, false if it's binary.
isThreadWatched(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns true if the user is watching the specified thread.
isTrackbackModerationEnabled() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if trackback moderation is enabled for this blog, false if not.
isTrackbackNotificationEnabled() - Method in class com.jivesoftware.community.webservices.Blog
Returns true if trackback notification is enabled for this blog, false if not.
isTrackbacksEnabled() - Method in class com.jivesoftware.community.webservices.BlogPost
Returns true if trackbacks are accepted on this blog post, false if not.
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the trackbacks feature is turned on.
isTrackbacksEnabled() - Method in class com.jivesoftware.community.webservices.Document
 
isTrackbacksEnabled() - Method in interface com.jivesoftware.community.webservices.DocumentService
Returns true if the trackbacks feature is turned on.
isUserAuthorized(long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Check to see if the specified user has the particular permission system wide.
isUserAuthorizedOnCommunity(long, long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Check to see if the specified user has the particular permission on the specified community.
isUserWatched(long, long) - Method in interface com.jivesoftware.community.webservices.WatchService
Returns true if the user is watching the specified user.
isValidType(String) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Returns true if the content type is valid based on the current settings of the allowAllByDefault flag and the allowed and disallowed types list.
isVisible() - Method in class com.jivesoftware.community.webservices.ProfileField
Gets whether or not this profile field is visible by the public.

J

JiveConstants - Class in com.jivesoftware.community
Contains constant values representing various objects in Clearspace.
JiveException - Exception in com.jivesoftware.community
Base exception class for all Jive exceptions.
JiveException() - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(String) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(String, Throwable) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveException(Throwable) - Constructor for exception com.jivesoftware.community.JiveException
 
JiveObject - Class in com.jivesoftware.community.webservices
Super-class of other jive webservice objects.
JiveObject(long, int) - Constructor for class com.jivesoftware.community.webservices.JiveObject
Create a new instance of this object.
JiveObject() - Constructor for class com.jivesoftware.community.webservices.JiveObject
Create a new instance of this object.
JiveRuntimeException - Exception in com.jivesoftware.community
Base exception class for all Jive runtime exceptions.
JiveRuntimeException() - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(String) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(String, Throwable) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 
JiveRuntimeException(Throwable) - Constructor for exception com.jivesoftware.community.JiveRuntimeException
 

K

keySet() - Method in class com.jivesoftware.community.webservices.Cache
 

L

lastAccessedList - Variable in class com.jivesoftware.community.webservices.Cache
Linked list to maintain order that cache objects are accessed in, most used to least used.
Locale - Class in com.jivesoftware.community.webservices
Webservice object that contains locale information such as the country code and language code.
Locale() - Constructor for class com.jivesoftware.community.webservices.Locale
 
Locale(String, String) - Constructor for class com.jivesoftware.community.webservices.Locale
Creates a new instance of a Locale using the specified country code and language code.
LOGIN_CANCEL_URL - Static variable in class com.jivesoftware.community.JiveConstants
The name of the session key where the login cancel url is stored
LOGIN_SUCCESS_URL - Static variable in class com.jivesoftware.community.JiveConstants
The name of the session key where the login success url is stored

M

map - Variable in class com.jivesoftware.community.webservices.Cache
The map the keys and values are stored in.
MAX_MESSAGE_RESULTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
The maximum amount of message IDs that will be returned by any method by default.
MAX_THREAD_RESULTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
The maximum amount of thread IDs that will be returned by any method by default.
MAX_USER_RESULTS - Static variable in class com.jivesoftware.community.webservices.WSConstants
The maximum amount of user IDs that will be returned by any method by default.
maxCacheSize - Variable in class com.jivesoftware.community.webservices.Cache
Maximum number of items the cache will hold.
maxLifetime - Variable in class com.jivesoftware.community.webservices.Cache
Maximum length of time objects can exist in cache before expiring.
MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
MESSAGE_BODY - Static variable in class com.jivesoftware.community.JiveConstants
 
MESSAGE_MODERATION_ABUSE_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value for messages that have been reported as abusive and should be hidden until the message is reviewed.
MESSAGE_MODERATION_ABUSE_VISIBLE - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value for messages that have been reported as abusive.
MESSAGE_MODERATION_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value at which content is automatically hidden (0).
MESSAGE_MODERATION_VIRUSSCAN_HIDDEN - Static variable in class com.jivesoftware.community.JiveConstants
The moderation value that messages will be set to while waiting to be scanned for viruses.
MESSAGE_MODERATION_VISIBLE - Static variable in class com.jivesoftware.community.JiveConstants
Moderation value at which content is automatically visible (1).
MESSAGE_SUBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
messageCount - Variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
method - Variable in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
MINUTE - Static variable in class com.jivesoftware.community.JiveConstants
One minute (in milliseconds).
MODERATOR - Static variable in class com.jivesoftware.community.Permissions
Permission to moderate content.
MODIFICATION_DATE - Static variable in class com.jivesoftware.community.JiveConstants
 
moveDocument(long, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Moves a document from it's current community to another.
moveMessage(long, long, int) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Moves a private message to another folder.
moveThread(long, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Moves the thread with the specified ID to the community with the specified ID.
MULTIPLE_SELECTIONS_ALLOWED - Static variable in class com.jivesoftware.community.webservices.Poll
Mode to allow users to select multiple options in a poll.

N

name - Variable in class com.jivesoftware.community.webservices.ContentTag
 
name - Variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
NameAlreadyExistsException - Exception in com.jivesoftware.community
Thrown if the specified name already exists on the object.
NameAlreadyExistsException() - Constructor for exception com.jivesoftware.community.NameAlreadyExistsException
 
NameAlreadyExistsException(String) - Constructor for exception com.jivesoftware.community.NameAlreadyExistsException
 
NAMESPACE - Static variable in class com.jivesoftware.community.webservices.WSConstants
The namespace used for jive web services.
NONE - Static variable in class com.jivesoftware.community.Permissions
No permissions.
NORMAL_WATCH - Static variable in class com.jivesoftware.community.webservices.Watch
Normal watch type.
NULL_INT - Static variable in class com.jivesoftware.community.webservices.ResultFilter
An integer value that represents NULL.

O

OBJECT_COMMUNITY - Static variable in interface com.jivesoftware.community.webservices.WatchService
An integer representing Community objects.
OBJECT_THREAD - Static variable in interface com.jivesoftware.community.webservices.WatchService
An integer representing Forum Thread objects.
OBJECT_USER - Static variable in interface com.jivesoftware.community.webservices.WatchService
An integer representing User objects.
objectServiceFactory - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
objectType - Variable in class com.jivesoftware.community.webservices.JiveObject
 
OFFLINE - Static variable in class com.jivesoftware.community.JiveConstants
 
OPEN - Static variable in class com.jivesoftware.community.webservices.ResultFilter.ResolutionState
 
OSWORKFLOW_ENTRY - Static variable in class com.jivesoftware.community.JiveConstants
 
OSWORKFLOW_STEP - Static variable in class com.jivesoftware.community.JiveConstants
 
ownerID - Variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 

P

password - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
PERM_HIDDEN_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
Used as an alternative to removing messages from the database.
Permissions - Class in com.jivesoftware.community
Represents a set of permissions that an entity has for an object in the system.
Permissions(long) - Constructor for class com.jivesoftware.community.Permissions
Create a new permissions object with the specified permissions.
Permissions(Permissions, Permissions) - Constructor for class com.jivesoftware.community.Permissions
Creates a new Permission object by combining two permissions objects.
PermissionService - Interface in com.jivesoftware.community.webservices
Provides a webservice for managing permissions on users and groups.
permissionService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
POLL - Static variable in class com.jivesoftware.community.JiveConstants
 
Poll - Class in com.jivesoftware.community.webservices
Poll webervices object.
Poll() - Constructor for class com.jivesoftware.community.webservices.Poll
 
PollService - Interface in com.jivesoftware.community.webservices
 
pollService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
POPULARITY - Static variable in class com.jivesoftware.community.JiveConstants
 
POSSIBLY_RESOLVED - Static variable in class com.jivesoftware.community.webservices.ResultFilter.ResolutionState
 
printStackTrace() - Method in exception com.jivesoftware.base.UnauthorizedException
 
printStackTrace(PrintStream) - Method in exception com.jivesoftware.base.UnauthorizedException
 
printStackTrace(PrintWriter) - Method in exception com.jivesoftware.base.UnauthorizedException
 
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
 
PRIVATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to get and send private messages.
PRIVATE_MESSAGE_FOLDER - Static variable in class com.jivesoftware.community.JiveConstants
 
PrivateMessage - Class in com.jivesoftware.community.webservices
Represents a private message.
PrivateMessage() - Constructor for class com.jivesoftware.community.webservices.PrivateMessage
 
PrivateMessageFolder - Class in com.jivesoftware.community.webservices
Represents a private message folder.
PrivateMessageFolder() - Constructor for class com.jivesoftware.community.webservices.PrivateMessageFolder
 
PrivateMessageService - Interface in com.jivesoftware.community.webservices
Provides the ability to manipulate private messages.
PROFILE_FIELD - Static variable in class com.jivesoftware.community.JiveConstants
 
ProfileField - Class in com.jivesoftware.community.webservices
A profile field defines a single field of a user's profile, such as 'Phone Number' or 'Job Title'.
ProfileField() - Constructor for class com.jivesoftware.community.webservices.ProfileField
 
ProfileFieldOption - Class in com.jivesoftware.community.webservices
Represents a possible option of a ProfileField
ProfileFieldOption() - Constructor for class com.jivesoftware.community.webservices.ProfileFieldOption
 
ProfileFieldService - Interface in com.jivesoftware.community.webservices
Defines methods used to create, access, update, and remove profile fields data.
profileFieldService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
ProfileService - Interface in com.jivesoftware.community.webservices
Manages user profile data.
profileService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
Property - Class in com.jivesoftware.community.webservices
Represents 1 extended property on an object.
Property() - Constructor for class com.jivesoftware.community.webservices.Property
 
Property(String, String) - Constructor for class com.jivesoftware.community.webservices.Property
Creates a new property the specfied property name and value.
PROPERTY_ACCESS_TYPE - Static variable in class com.jivesoftware.community.webservices.WSConstants
The Jive Property is set to determine the type of access the webservices will allow.
PROPERTY_ALLOWED_GROUPS - Static variable in class com.jivesoftware.community.webservices.WSConstants
If access type is set to SPECIFIC_GROUPS then this property should contain a comma seperated list of group names of groups who can access web services.
PROPERTY_ALLOWED_USERS - Static variable in class com.jivesoftware.community.webservices.WSConstants
If access type is set to SPECIFIC_USERS then this property should contain a comma seperated list of usernames of users who can access web services.
PROPERTY_FORCE_SSL - Static variable in class com.jivesoftware.community.webservices.WSConstants
If this jive property is set webservices will only work over an ssl connection, non ssl requests will be denied.
PROPERTY_PERMISION_HANDLER - Static variable in class com.jivesoftware.community.webservices.WSConstants
The inbound handler for xfire that handles permissions
PROPERTY_SOAP_ENABLED - Static variable in class com.jivesoftware.community.webservices.WSConstants
This Jive Property should be set to true if SOAP web services should be enabled.
PROPERTY_XMLRPC_ENABLED - Static variable in class com.jivesoftware.community.webservices.WSConstants
This Jive Property should be set to true if XMLRPC web services should be enabled.
proxyFactory - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
proxyHost - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
proxyPort - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
PUBLISH_DATE - Static variable in class com.jivesoftware.community.webservices.BlogPostResultFilter
Sort on the publish date.
publishBinaryDocument(long, long, long, String, String, String, String, byte[]) - Method in interface com.jivesoftware.community.webservices.DocumentService
Publish a new binary document.
publishBlogPost(String, String, long, long) - Method in interface com.jivesoftware.community.webservices.BlogService
 
publishDocument(long, long, long, String, String, String) - Method in interface com.jivesoftware.community.webservices.DocumentService
Publish a new document.
put(Object, Object) - Method in class com.jivesoftware.community.webservices.Cache
 
putAll(Map) - Method in class com.jivesoftware.community.webservices.Cache
 

Q

Query - Class in com.jivesoftware.community.webservices
Provides the ability to create complex search queries.
Query() - Constructor for class com.jivesoftware.community.webservices.Query
 
QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 
quickMessageSearchByCommunityID(long, String, int[], int, int) - Method in interface com.jivesoftware.community.webservices.SearchService
Provides the ability to do quick search queries based on the provided string.
quickSearch(String, int[], int, int) - Method in interface com.jivesoftware.community.webservices.SearchService
Provides the ability to do quick search queries based on the provided string.

R

RATE_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to rate documents in a community
RATE_MESSAGE - Static variable in class com.jivesoftware.community.Permissions
Permission to rate messages.
RATING - Static variable in class com.jivesoftware.community.JiveConstants
 
RATING - Static variable in class com.jivesoftware.community.webservices.Query
Sort by rating
Rating - Class in com.jivesoftware.community.webservices
 
Rating() - Constructor for class com.jivesoftware.community.webservices.Rating
 
RatingsService - Interface in com.jivesoftware.community.webservices
 
ratingsService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
READ_BLOG - Static variable in class com.jivesoftware.community.Permissions
Permission to read blog a blog.
READ_COMMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to read a comment
READ_DOCUMENT - Static variable in class com.jivesoftware.community.Permissions
Permission to read a document
READ_STAT - Static variable in class com.jivesoftware.community.JiveConstants
 
READ_STAT_SESSION - Static variable in class com.jivesoftware.community.JiveConstants
 
REGISTERED - Static variable in class com.jivesoftware.community.webservices.WSConstants.AccessType
Access type that will allow only registered users to connect to web services.
REGISTERED_USERS - Static variable in class com.jivesoftware.community.JiveConstants
 
registeredUserHasPermission(long, boolean) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if registered users have a particular permission globally.
registeredUserHasPermissionOnCommunity(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns true if registered users have a particular permission on the community with the specified ID.
REJECTED_MESSAGE - Static variable in class com.jivesoftware.community.JiveConstants
Messages rejected by a moderator will be marked with this value.
RejectedException - Exception in com.jivesoftware.community
Thrown by a JiveInterceptor when a jive object is prevented from being posted.
RejectedException() - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(String) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(String, JiveObject) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(Throwable, JiveObject) - Constructor for exception com.jivesoftware.community.RejectedException
 
RejectedException(Throwable) - Constructor for exception com.jivesoftware.community.RejectedException
 
RELEVANCE - Static variable in class com.jivesoftware.community.webservices.Query
Sort by relevance
remove(Object) - Method in class com.jivesoftware.community.webservices.Cache
 
remove(Object, boolean) - Method in class com.jivesoftware.community.webservices.Cache
 
removeAdministratorFromGroup(long, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Remove the user with the specified ID as an administrator from the group with the specified ID.
removeAllowedType(String) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Removes a content type fromt he list of explicitly allowed types.
removeAllTags(JiveObject) - Method in interface com.jivesoftware.community.webservices.TagService
Disassociates this object with all tags.
removeAnonymousVote(long, int, String) - Method in interface com.jivesoftware.community.webservices.PollService
Remove a guest vote.
removeAuthor(long, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Removes the user with the supplied id as an author of this document.
removeCommunityPermissionFromGroup(long, boolean, long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Remove the specified permission on the specified community from the group with the specified id.
removeCommunityPermissionFromUser(long, boolean, long, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Remove the specified permission on the specified community from the user with the specified id.
removeDisallowedType(String) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Removes a content type from the list of explicitly disallowed types.
removeMemberFromGroup(long, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Remove the user with the specified id from the group with the specified id.
removePermissionFromGroup(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Remove the specified permission from the group with the specified id.
removePermissionFromUser(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Remove the specified permission from the user with the specified id.
removeRating(int) - Method in interface com.jivesoftware.community.webservices.RatingsService
Remove the specified rating from the list of currently available ratings.
removeTag(String, JiveObject) - Method in interface com.jivesoftware.community.webservices.TagService
Disassociates this object with the given tag.
removeUser(long, String) - Method in interface com.jivesoftware.community.webservices.AddressBookService
Removes the specified username from a users Private Message addressbook.
removeUsers(long, long[]) - Method in interface com.jivesoftware.community.webservices.AddressBookService
Removes the specified list of users from a users Private Message addressbook.
removeUserVote(long, int, long) - Method in interface com.jivesoftware.community.webservices.PollService
Remove a user vote.
RESOLVED - Static variable in class com.jivesoftware.community.webservices.ResultFilter.ResolutionState
 
ResultFilter - Class in com.jivesoftware.community.webservices
Filters and sorts lists of threads and messages.
ResultFilter() - Constructor for class com.jivesoftware.community.webservices.ResultFilter
 
ResultFilter.ResolutionState - Class in com.jivesoftware.community.webservices
 
ResultFilter.ResolutionState() - Constructor for class com.jivesoftware.community.webservices.ResultFilter.ResolutionState
 
ROSTER - Static variable in class com.jivesoftware.community.JiveConstants
 

S

saveMessageAsDraft(PrivateMessage) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Saves a message as a draft by storing it in the sender's Drafts folder.
saveProperty(String, String) - Method in interface com.jivesoftware.community.webservices.SystemPropertiesService
Saves a name/value pair as a Jive System Property.
SEARCH - Static variable in class com.jivesoftware.community.JiveConstants
 
search(Query, int[], int, int) - Method in interface com.jivesoftware.community.webservices.SearchService
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc.
SEARCH_ENGINE - Static variable in class com.jivesoftware.community.JiveConstants
 
SEARCH_QUERY - Static variable in class com.jivesoftware.community.JiveConstants
 
searchByCommunities(long, Query, int[], int, int) - Method in interface com.jivesoftware.community.webservices.SearchService
Provides the ability to create complex search queries with the ability to change sorting, filtering, etc. all by category.
SearchService - Interface in com.jivesoftware.community.webservices
Provides the ability to search for content.
searchService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
SECOND - Static variable in class com.jivesoftware.community.JiveConstants
One second (in milliseconds).
sendMessage(PrivateMessage, long, boolean) - Method in interface com.jivesoftware.community.webservices.PrivateMessageService
Sends a private message to another user.
ServiceLocator - Class in com.jivesoftware.community.webservices
Entry point to the jive java soap webservices api.
ServiceLocator(String, String, String) - Constructor for class com.jivesoftware.community.webservices.ServiceLocator
Create a new service locator.
ServiceLocator(String, String, String, String, String) - Constructor for class com.jivesoftware.community.webservices.ServiceLocator
 
ServiceLocator(String) - Constructor for class com.jivesoftware.community.webservices.ServiceLocator
Creates a new anonymous Service Locator.
ServiceLocator.CacheKey - Class in com.jivesoftware.community.webservices
Cache key used by CacheHandler
ServiceLocator.CacheKey(String, Object[]) - Constructor for class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
set(long, boolean) - Method in class com.jivesoftware.community.Permissions
Sets the permissions given by a bit mask to true or false.
setAfterDate(Date) - Method in class com.jivesoftware.community.webservices.Query
Sets the earliest date for search results.
setAllBlogPostIDs(Long[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets all the blog post IDs for this blog.
setAllowAllByDefault(boolean) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the default allowed content types mode.
setAnonymous(boolean) - Method in class com.jivesoftware.community.webservices.Comment
 
setAnonymous(boolean) - Method in class com.jivesoftware.community.webservices.Document
 
setAnonymous(boolean) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets whether or not this message was created anonymously.
setApprovalEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Document
 
setApproved(boolean) - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Set to true if the user has approved the document.
setApprovedDate(Date) - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Sets the date the user approved the document.
setArgs(Object[]) - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
setAttachmentCount(int) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the number of attachments this blog post has.
setAttachmentCount(int) - Method in class com.jivesoftware.community.webservices.Document
 
setAttachmentCount(int) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the number of attachments this message has.
setAttachmentsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets whether attachments are enabled, false otherwise.
setAuthorCount(int) - Method in class com.jivesoftware.community.webservices.Document
 
setBeforeDate(Date) - Method in class com.jivesoftware.community.webservices.Query
Sets the latest date for search results.
setBlogID(long) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the blog ID this post belongs to.
setBlogID(long) - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Sets the blogID that results will be filtered on.
setBlogPostCount(int) - Method in class com.jivesoftware.community.webservices.Blog
Sets the number of blog posts on this blog.
setBlogsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.BlogService
Enables or disables the blogs feature.
setBody(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the body of this post.
setBody(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setBody(String) - Method in class com.jivesoftware.community.webservices.Document
 
setBody(String) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the body of this message.
setBody(String) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setCachingEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.CacheableService
Setting true to this method will enabled caching, false will disable it and clear current caches.
setCode(String) - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
setCommentAuthenticationStrategy(int) - Method in class com.jivesoftware.community.webservices.Blog
Set the comment authentication strategy of this blog which may be any one of the following: Blog.COMMENT_AUTH_REQUIRED -- must register and login to comment Blog.COMMENT_AUTH_OPTIONAL_WITH_EMAIL -- must either register and login or provide an email address in the comment form.
setCommentCount(int) - Method in class com.jivesoftware.community.webservices.Blog
Sets the total number of comments on this blog.
setCommentCount(int) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the number of comments this blog post has.
setCommentModerationEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables comment moderation for this blog.
setCommentNotificationEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables comment notification for this blog.
setCommentObjectID(long) - Method in class com.jivesoftware.community.webservices.Comment
 
setCommentObjectType(int) - Method in class com.jivesoftware.community.webservices.Comment
 
setCommentsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.BlogService
Enables or disables the comments feature system wide.
setCommentsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.DocumentService
Enables or disables the comments feature system wide.
setCommentStatus(int) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the comment status of this blog post.
setCommentStatus(int) - Method in class com.jivesoftware.community.webservices.Document
 
setCommentStatus(int) - Method in class com.jivesoftware.community.webservices.Poll
 
setCommunityBlog(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables the community aspects of this blog.
setCommunityCount(int) - Method in class com.jivesoftware.community.webservices.Community
 
setCommunityDepth(int) - Method in class com.jivesoftware.community.webservices.Community
 
setCommunityID(long) - Method in exception com.jivesoftware.community.CommunityNotFoundException
Sets the id of the community that was not found.
setCommunityID(long) - Method in class com.jivesoftware.community.webservices.CommentResultFilter
Sets the communityID to use to restrict results to be selected by the result filter.
setCommunityID(long) - Method in class com.jivesoftware.community.webservices.Document
 
setCommunityID(long) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the ID of the community that this message belongs too.
setCommunityID(long) - Method in class com.jivesoftware.community.webservices.ForumThread
Called by the ForumThreadService to set the ID of the thread this community belongs too.
setCommunityIndex(int) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the community index of this message.
setContainerObjectID(long) - Method in class com.jivesoftware.community.webservices.Poll
 
setContainerObjectType(int) - Method in class com.jivesoftware.community.webservices.Poll
 
setContentType(String) - Method in class com.jivesoftware.community.webservices.Attachment
 
setContentType(String) - Method in class com.jivesoftware.community.webservices.BinaryBody
 
setContentType(String) - Method in class com.jivesoftware.community.webservices.Image
 
setContentTypes(String...) - Method in class com.jivesoftware.community.webservices.Community
 
setCountryCode(String) - Method in class com.jivesoftware.community.webservices.Locale
Sets the country/region code for this locale, which will either be the empty string or an upercase ISO 3166 2-letter code.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Blog
Sets the creation date of this blog.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the creation date of this post.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Comment
 
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Community
Sets the creation date of the community.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.ContentTag
Sets the date that this tag was created.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Document
 
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the creation date of this message.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.ForumThread
Sets the creation date of this thread.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Group
Sets the creation date of the group.
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.Poll
 
setCreationDate(Date) - Method in class com.jivesoftware.community.webservices.User
Sets the creation date of the user.
setCreationDateRangeMax(Date) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter.
setCreationDateRangeMin(Date) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the date that represents the lower boundary for messages or threads to be selected by the result filter.
setData(byte[]) - Method in class com.jivesoftware.community.webservices.Attachment
 
setData(byte[]) - Method in class com.jivesoftware.community.webservices.BinaryBody
 
setData(byte[]) - Method in class com.jivesoftware.community.webservices.Image
 
setDate(Date) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setDefaultOption(boolean) - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Sets whether or not this option is to be selected by default.
setDeleteDays(int) - Method in interface com.jivesoftware.community.webservices.WatchService
Sets the number of days that a watched object can remain inactive before watches on that object are deleted.
setDescription(String) - Method in class com.jivesoftware.community.webservices.Blog
Sets the description of the blog, max length of 255 characters.
setDescription(String) - Method in class com.jivesoftware.community.webservices.Community
Sets the description of the community.
setDescription(String) - Method in class com.jivesoftware.community.webservices.Group
Sets the description of the group.
setDescription(String) - Method in class com.jivesoftware.community.webservices.Poll
Sets the description of the poll.
setDescription(long, String) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the description of the poll.
setDescription(String) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets the description of this profile field.
setDescription(String) - Method in class com.jivesoftware.community.webservices.Rating
 
setDescription(String) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setDisplayName(String) - Method in class com.jivesoftware.community.webservices.Blog
Sets the display name of the blog that is used as the URI.
setDisplayName(String) - Method in class com.jivesoftware.community.webservices.Community
Sets the displayName of the community.
setDocumentID(String) - Method in class com.jivesoftware.community.webservices.Document
Sets the document ID corresponding to the document.
setDocumentProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.DocumentService
Set an extended for the property with the given document id.
setDocumentTypeID(long) - Method in class com.jivesoftware.community.webservices.Document
 
setDownloadCount(int) - Method in class com.jivesoftware.community.webservices.BinaryBody
 
setEditable(boolean) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets whether or not this profile field is editable by the user.
setEmail(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setEmail(String) - Method in class com.jivesoftware.community.webservices.User
Sets the user's email address.
setEmailVisible(boolean) - Method in class com.jivesoftware.community.webservices.User
Sets whether a user's email is visible to other users.
setEnabled(boolean) - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
setEnabled(boolean) - Method in class com.jivesoftware.community.webservices.User
Sets the whether this user is enabled or not.
setEndDate(Date) - Method in class com.jivesoftware.community.webservices.Poll
Sets the date the poll should end.
setEndDate(long, Date) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the date the poll should end.
setExpirable(boolean) - Method in class com.jivesoftware.community.webservices.Watch
Sets whether this watch is expirable or not.
setExpirationDate(Date) - Method in class com.jivesoftware.community.webservices.Document
Sets the date the document should expire on.
setExpirationDate(Date) - Method in class com.jivesoftware.community.webservices.Poll
Sets the date the poll should expire.
setExpirationDate(long, Date) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the date the poll should expire.
setFeedEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables feeds for this blog.
setFeedFullContent(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables or disables the publishing of the full blog post in feeds.
setFieldID(long) - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Sets the id of the ProfileField in which this option belongs.
setFieldID(long) - Method in class com.jivesoftware.community.webservices.UserProfile
Sets the id of the profile field.
setFilterable(boolean) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets whether or not this profile field is filterable.
setFinalLocale(Locale) - Method in class com.jivesoftware.community.webservices.Community
 
setFirstPostID(long) - Method in class com.jivesoftware.community.webservices.Blog
Sets the first blog post ID on this blog.
setFolderID(long) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setForumThreadID(long) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the ID of thread that this message belongs too.
setGroup(Group) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setHtml(boolean) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets whether or not this message contains html.
setI18nKey(String) - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
setID(long) - Method in class com.jivesoftware.community.webservices.Attachment
 
setID(long) - Method in class com.jivesoftware.community.webservices.Comment
 
setID(long) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the id of this message.
setID(long) - Method in class com.jivesoftware.community.webservices.JiveObject
Set the unique id of this object.
setID(long) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets the id representing this profile field.
setID(long) - Method in class com.jivesoftware.community.webservices.User
 
setImageCount(int) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the number of images this blog post has.
setImageCount(int) - Method in class com.jivesoftware.community.webservices.Document
 
setImageCount(int) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the number of images this message has.
setImagePath(String) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setImagePreviewEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Toggles whether image preview support is enabled.
setImagePreviewMaxSize(int) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the max dimension of generated thumbnails (ie, the max value for the width or height).
setImagePreviewRatioEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Toggles whether the aspect ratio of thumbnails should be preserved.
setIncludeAuthorsInUserFilter(boolean) - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Sets whether users who have been added as authors to a document should be included when filtering user content comments by user.
setIncludeDocumentBackChannelComments(boolean) - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Sets whether document backchannel comments should be included.
setIncludeModerated(boolean) - Method in class com.jivesoftware.community.webservices.CommentResultFilter
Sets whether the result to be selected by the result filter should include moderated comments.
setIncludeModerated(boolean) - Method in class com.jivesoftware.community.webservices.FeedbackResultFilter
Sets whether the result to be selected by the result filter should include moderated comments.
setIncludeOwnComments(boolean) - Method in class com.jivesoftware.community.webservices.UserContentCommentResultFilter
Sets whether comments by the user whose content is being queried for comments should be included.
setIndex(int) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets the index of this profile field.
setIndex(int) - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Sets the index of this option which represents the order in which the options will appear in the list.
setIndex(long, int) - Method in interface com.jivesoftware.community.webservices.ProfileFieldService
Sets the index of the profile field.
setIPAddress(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setLanguage(String) - Method in class com.jivesoftware.community.webservices.Document
Sets the language of the document.
setLanguageCode(String) - Method in class com.jivesoftware.community.webservices.Locale
Sets the language code for this locale, which will either be the empty string or a lowercase ISO 639 code.
setLargeImagePath(String) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setLastPostID(long) - Method in class com.jivesoftware.community.webservices.Blog
Sets the last blog post ID on this blog.
setLatestMessageID(long) - Method in class com.jivesoftware.community.webservices.Community
 
setLatestMessageID(long) - Method in class com.jivesoftware.community.webservices.ForumThread
Called by the ForumThreadService to set the appropriate latestMessageID into the thread.
setLocale(Locale) - Method in class com.jivesoftware.community.webservices.Community
Sets the locale for this community.
setMaxAttachmentSize(int) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the maximum size of an individual attachment in kilobytes.
setMaxAttachmentsPerBlogPost(int) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the maximum number of attachments per blog post.
setMaxAttachmentsPerDocument(int) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the maximum number of attachments per document.
setMaxAttachmentsPerMessage(int) - Method in interface com.jivesoftware.community.webservices.AttachmentService
Sets the maximum number of attachments per message.
setMaxCacheLifetime(long) - Method in interface com.jivesoftware.community.webservices.CacheableService
Set the maximum amount of time an item will be stored in the cache.
setMaxCacheSize(int) - Method in class com.jivesoftware.community.webservices.Cache
 
setMaxCacheSize(int) - Method in interface com.jivesoftware.community.webservices.CacheableService
The maximum size of the cache in bytes.
setMaxLifetime(long) - Method in class com.jivesoftware.community.webservices.Cache
 
setMaxPoints(int) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setMemberCount(int) - Method in class com.jivesoftware.community.webservices.Group
Sets the number of users that belon gto this group.
setMessageCount(int) - Method in class com.jivesoftware.community.webservices.Community
 
setMessageCount(int) - Method in class com.jivesoftware.community.webservices.ForumThread
Set the number of messages in this thread.
setMessageCount(int) - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
setMessageProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Set an extended for the property with the given message id.
setMethod(String) - Method in class com.jivesoftware.community.webservices.ServiceLocator.CacheKey
 
setMinimum(int) - Method in class com.jivesoftware.community.webservices.TagResultFilter
Sets the minimum number of JiveContentObjects that a tag must be associated with to be included in the result set.
setMinPoints(int) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setMode(long) - Method in class com.jivesoftware.community.webservices.Poll
 
setMode(long, long, boolean) - Method in interface com.jivesoftware.community.webservices.PollService
Sets a mode to be enabled or disabled for the poll.
setModerated(boolean) - Method in class com.jivesoftware.community.webservices.Comment
 
setModerationRangeMax(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the upper bound for the moderation value that will pass the result filter.
setModerationRangeMin(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the moderation value that represents the lower bound for messages or threads to be selected by the result filter.
setModerationValue(int) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the number of moderation points this message has.
setModerationValue(int) - Method in class com.jivesoftware.community.webservices.ForumThread
Used to change the moderation value of the community.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Blog
Sets the date this blog was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the date this post was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Comment
 
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Community
Sets the date the community was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Document
 
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the date this message was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.ForumThread
Sets the date this thread was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Group
Sets the date the group was last modified.
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.Poll
 
setModificationDate(Date) - Method in class com.jivesoftware.community.webservices.User
Sets the date the user was last modified.
setModificationDateRangeMax(Date) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets a date that represents the upper boundry for messages or threads to be selected by the result filter.
setModificationDateRangeMin(Date) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets a date that represents the lower boundary for messages or threads to be selected by the result filter.
setName(String) - Method in class com.jivesoftware.community.webservices.Attachment
 
setName(String) - Method in class com.jivesoftware.community.webservices.BinaryBody
Sets the name of the body object.
setName(String) - Method in class com.jivesoftware.community.webservices.Blog
Sets the name of a blog.
setName(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setName(String) - Method in class com.jivesoftware.community.webservices.Community
Sets the name of the community.
setName(String) - Method in class com.jivesoftware.community.webservices.ContentTag
Sets the name of the tag
setName(String) - Method in class com.jivesoftware.community.webservices.ForumThread
Used by ForumThreadService to set the value of this field.
setName(String) - Method in class com.jivesoftware.community.webservices.Group
Sets the name of the group.
setName(String) - Method in class com.jivesoftware.community.webservices.Image
 
setName(String) - Method in class com.jivesoftware.community.webservices.Poll
Sets the name of the poll.
setName(long, String) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the name of the poll.
setName(String) - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
setName(String) - Method in class com.jivesoftware.community.webservices.ProfileField
 
setName(String) - Method in class com.jivesoftware.community.webservices.Property
Set the property name.
setName(String) - Method in class com.jivesoftware.community.webservices.StatusLevel
 
setName(String) - Method in class com.jivesoftware.community.webservices.TagCount
Sets the name of the tag.
setName(String) - Method in class com.jivesoftware.community.webservices.User
Sets the user's name.
setNameVisible(boolean) - Method in class com.jivesoftware.community.webservices.User
Sets whether a user's name is visible to other users.
setNextPostID(long) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the next blogpost ID that has been published.
setNumResults(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the limit on the number of results to be returned.
setObjectID(long) - Method in class com.jivesoftware.community.webservices.Watch
 
setObjectType(int) - Method in class com.jivesoftware.community.webservices.Comment
 
setObjectType(int) - Method in class com.jivesoftware.community.webservices.JiveObject
Sets the object type of the jive object.
setObjectType(int) - Method in class com.jivesoftware.community.webservices.Watch
 
setOnlyCommunity(boolean) - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Sets whether the result to be selected by the result filter should include only community blogs.
setOnlyPersonal(boolean) - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Sets whether the result to be selected by the result filter should include only personal blogs.
setOnlyPublished(boolean) - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Sets whether the result to be selected by the result filter should include published blog posts.
setOption(long, int, String) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the text of the option at the specified index.
setOptionCount(int) - Method in class com.jivesoftware.community.webservices.Poll
 
setOptionIndex(long, int, int) - Method in interface com.jivesoftware.community.webservices.PollService
Moves the option's index.
setOptions(String[]) - Method in class com.jivesoftware.community.webservices.Poll
 
setOptions(ProfileFieldOption[]) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets a array of ProfileFieldOption objects for this profile field.
setOverridePing(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables or disables the blog to override the ping settings in the system.
setOwnerID(long) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setOwnerID(long) - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
setParentCommunityID(long) - Method in class com.jivesoftware.community.webservices.Community
 
setParentMessageID(long) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the id of the parent message to this message.
setPassword(String) - Method in class com.jivesoftware.community.webservices.User
Sets the users's password.
setPassword(long, String) - Method in interface com.jivesoftware.community.webservices.UserService
Used to change a user's password.
setPermalink(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the permalink for this blog post.
setPingsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.BlogService
Enables or disables the pings feature system wide.
setPingServices(String) - Method in class com.jivesoftware.community.webservices.Blog
A line break separated list of services that the user has chosen to ping.
setPingServices(String) - Method in interface com.jivesoftware.community.webservices.BlogService
Sets the comma delimited list of available ping services for the system.
setPingsOverrideEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.BlogService
Configures the system to allow users to override the ping URIs configured for all blogs.
setPlainBody(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the plain body.
setPlainSubject(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the plain subject.
setPoints(long) - Method in class com.jivesoftware.community.webservices.StatusLevelScenario
 
setPopularTags(TagCount[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets the 20 most popular tags for a given blog.
setPrefix(String) - Method in class com.jivesoftware.community.webservices.BlogResultFilter
Set a single character prefix to be used when searching blogs.
setPreviousPostID(long) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the previous blogpost ID that has been published.
setProfile(long, UserProfile[]) - Method in interface com.jivesoftware.community.webservices.ProfileService
Sets a array of profile values for a particular user.
setProfileImage(long, String, byte[]) - Method in interface com.jivesoftware.community.webservices.ProfileService
Set a new profile page image for the specified user.
setProperties(Property[]) - Method in class com.jivesoftware.community.webservices.Blog
Set the properties associated with this blog.
setProperties(Property[]) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the properties associated with this blogpost.
setProperties(Property[]) - Method in class com.jivesoftware.community.webservices.Comment
 
setProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.CommunityService
Set an extended propery for the community with the given community id.
setProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.GroupService
Set a new extended property on the specified group.
setPublishDate(Date) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the publish date of this post.
setPublishDateRangeMax(Date) - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Sets a date that represents the upper boundry for blog posts to be selected by the result filter.
setPublishDateRangeMax(Date) - Method in class com.jivesoftware.community.webservices.BlogTagResultFilter
Sets a date that represents the upper boundry for tags to be selected by the result filter.
setPublishDateRangeMin(Date) - Method in class com.jivesoftware.community.webservices.BlogPostResultFilter
Sets the date that represents the lower boundary for blog posts to be selected by the result filter.
setPublishDateRangeMin(Date) - Method in class com.jivesoftware.community.webservices.BlogTagResultFilter
Sets the date that represents the lower boundary for blog posts to be selected by the result filter.
setQueryString(String) - Method in class com.jivesoftware.community.webservices.Query
Sets the query string for the Query object.
setRatingsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.RatingsService
Enables or disables the ratings feature.
setRecentBlogPostIDs(Long[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets the the most recent blog post IDs on this blog
setRecentCommentIDs(Long[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets the most recent comment IDs on this blog.
setRecipientID(long) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setRecursive(boolean) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the recursive value of queries.
setRecursiveCommunityCount(int) - Method in class com.jivesoftware.community.webservices.Community
 
setRequired(boolean) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets whether or not this profile field is a required field.
setResolutionDateRangeMin(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
 
setResolutionnDateRangeMax(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
 
setResolutionStates(String[]) - Method in class com.jivesoftware.community.webservices.ResultFilter
 
setRootMessage(ForumMessage) - Method in class com.jivesoftware.community.webservices.ForumThread
Called by the ForumThreadService to set the appropriate rootMessageID into the thread.
setScore(int) - Method in class com.jivesoftware.community.webservices.Rating
 
setSearchable(boolean) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets whether or not this profile field is searchable.
setSenderID(long) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setSize(long) - Method in class com.jivesoftware.community.webservices.BinaryBody
 
setSortField(int) - Method in class com.jivesoftware.community.webservices.Query
Sets the sort field to use.
setSortField(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the sort field to use.
setSortOrder(int) - Method in class com.jivesoftware.community.webservices.Query
Sets the sort type.
setSortOrder(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the sort type.
setStartDate(Date) - Method in class com.jivesoftware.community.webservices.Poll
Sets the date voting for the poll should start.
setStartDate(long, Date) - Method in interface com.jivesoftware.community.webservices.PollService
Sets the date voting for the poll should start.
setStartIndex(int) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the index of the first result to return.
setStatus(int) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the publishing status of this blog post which may be any one of the following: PENDING_APPROVAL -- post has status of unpublished PUBLISH -- post has status of published.
setStatusLevelsEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Sets whether status levels should be enabled in the system.
setSubject(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the subject of this blog post.
setSubject(String) - Method in class com.jivesoftware.community.webservices.Document
Sets the title of the document.
setSubject(String) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the subject of this message.
setSubject(String) - Method in class com.jivesoftware.community.webservices.PrivateMessage
 
setTags(TagCount[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets the tags for a given blog.
setTags(String[]) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the tags associated with this blogpost.
setTags(String[]) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the ContentTags to filter on.
setTextBody(boolean) - Method in class com.jivesoftware.community.webservices.Document
 
setThreadCount(int) - Method in class com.jivesoftware.community.webservices.Community
 
setThreadProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.ForumService
Set an extended for the property for the thread with the given ID.
setTrackbackCount(int) - Method in class com.jivesoftware.community.webservices.Blog
Sets the total number of trackbacks on this blog.
setTrackbackModerationEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables trackback moderation for this blog.
setTrackbackNotificationEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Blog
Enables and disables trackback notification for this blog.
setTrackbacksEnabled(boolean) - Method in class com.jivesoftware.community.webservices.BlogPost
Enables and disables trackbacks for this blog post.
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.BlogService
Enables or disables the trackbacks feature system wide.
setTrackbacksEnabled(boolean) - Method in class com.jivesoftware.community.webservices.Document
 
setTrackbacksEnabled(boolean) - Method in interface com.jivesoftware.community.webservices.DocumentService
Enables or disables the trackbacks feature system wide.
setTypeID(int) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets the id of the type of this profile field.
setUnfilteredBody(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the unfiltered body.
setUnfilteredBody(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setUnfilteredBody(String) - Method in class com.jivesoftware.community.webservices.Document
 
setUnfilteredBody(String) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the unfiltered body of the message
setUnfilteredName(String) - Method in class com.jivesoftware.community.webservices.ContentTag
Sets the unfiltered name of the tag.
setUnfilteredSubject(String) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the unfiltered subject.
setUnfilteredSubject(String) - Method in class com.jivesoftware.community.webservices.Document
 
setUnfilteredSubject(String) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the unfiltered version of the subject.
setUnreadMessageCount(int) - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
setURL(String) - Method in class com.jivesoftware.community.webservices.Comment
 
setUser(User) - Method in class com.jivesoftware.community.webservices.BlogPost
Sets the id of the user.
setUser(User) - Method in class com.jivesoftware.community.webservices.Comment
 
setUser(User) - Method in class com.jivesoftware.community.webservices.ForumMessage
Sets the id of the user.
setUser(User) - Method in class com.jivesoftware.community.webservices.Poll
 
setUserCount(int) - Method in class com.jivesoftware.community.webservices.Blog
Sets the number of users associated with this blog.
setUserID(long) - Method in exception com.jivesoftware.base.UserNotFoundException
 
setUserID(long) - Method in class com.jivesoftware.community.webservices.ApprovalStatus
Sets the id of the approval User.
setUserID(long) - Method in class com.jivesoftware.community.webservices.Document
Returns the user that authored the document.
setUserID(long) - Method in class com.jivesoftware.community.webservices.ResultFilter
Sets the userID that results will be filtered on.
setUserID(long) - Method in class com.jivesoftware.community.webservices.Watch
 
setUserIDs(Long[]) - Method in class com.jivesoftware.community.webservices.Blog
Sets the user IDs given permission to post to this blog.
setUsername(String) - Method in exception com.jivesoftware.base.UserNotFoundException
 
setUsername(String) - Method in class com.jivesoftware.community.webservices.User
 
setUserProperty(String, String, long) - Method in interface com.jivesoftware.community.webservices.UserService
Set an extended property for a user.
setUses(int) - Method in class com.jivesoftware.community.webservices.TagCount
Sets the number of times the tag is used.
setValue(String) - Method in class com.jivesoftware.community.webservices.ProfileFieldOption
Sets the value of this option.
setValue(String) - Method in class com.jivesoftware.community.webservices.Property
Sets the property value.
setValue(String) - Method in class com.jivesoftware.community.webservices.UserProfile
Sets the value that the user selected for the profile field.
setValues(String[]) - Method in class com.jivesoftware.community.webservices.UserProfile
Sets the array of values that the user selected for the profile field.
setVersion(int) - Method in class com.jivesoftware.community.webservices.Document
 
setViewCount(int) - Method in class com.jivesoftware.community.webservices.Document
 
setVisible(boolean) - Method in class com.jivesoftware.community.webservices.ProfileField
Sets whether or not this profile field is visible by the public.
setVoteCount(int) - Method in class com.jivesoftware.community.webservices.Poll
 
setWatchType(int) - Method in class com.jivesoftware.community.webservices.Watch
Sets the watch type.
size() - Method in class com.jivesoftware.community.webservices.Cache
 
SORT_ACTIVITY - Static variable in class com.jivesoftware.community.webservices.Blog
 
SORT_BLOGID - Static variable in class com.jivesoftware.community.webservices.Blog
 
SORT_DISPLAYNAME - Static variable in class com.jivesoftware.community.webservices.Blog
 
SORT_NAME - Static variable in class com.jivesoftware.community.webservices.Blog
 
SORT_TAGCOUNT - Static variable in class com.jivesoftware.community.webservices.ContentTag
Sort field: sort by tag count.
SORT_TAGNAME - Static variable in class com.jivesoftware.community.webservices.ContentTag
Sort field: sort by tag name.
SPECIFIC_GROUPS - Static variable in class com.jivesoftware.community.webservices.WSConstants.AccessType
Access type that will only allow a list of specific groups to connect to web services.
SPECIFIC_USERS - Static variable in class com.jivesoftware.community.webservices.WSConstants.AccessType
Access type that will only allow a list of specific users to connect to web services.
STATUS_DEFAULT - Static variable in class com.jivesoftware.community.webservices.BlogPost
The default public status for a blog post.
STATUS_DRAFT - Static variable in class com.jivesoftware.community.webservices.BlogPost
Status value for blog posts that have been saved to the system but haven't been published and shouldn't be viewable to the public.
STATUS_LEVEL - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_LEVEL_POINT - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_LEVEL_SCENARIO - Static variable in class com.jivesoftware.community.JiveConstants
 
STATUS_PUBLISH - Static variable in class com.jivesoftware.community.webservices.BlogPost
Status value for blog posts that have been published to the system and should be viewable to the public.
STATUS_SCHEDULED - Static variable in class com.jivesoftware.community.webservices.BlogPost
Status value for blog posts that have been scheduled for publication in the future and shouldn't be viewable to the public.
StatusLevel - Class in com.jivesoftware.community.webservices
 
StatusLevel() - Constructor for class com.jivesoftware.community.webservices.StatusLevel
 
StatusLevelScenario - Class in com.jivesoftware.community.webservices
 
StatusLevelScenario() - Constructor for class com.jivesoftware.community.webservices.StatusLevelScenario
 
StatusLevelService - Interface in com.jivesoftware.community.webservices
Manages status level feature.
SUBJECT - Static variable in class com.jivesoftware.community.webservices.Query
Sort by message subject
SYSTEM - Static variable in class com.jivesoftware.community.JiveConstants
 
SYSTEM_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer the entire sytem.
SYSTEM_QUESTION - Static variable in class com.jivesoftware.community.JiveConstants
 
systemPropertiesService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
SystemPropertiesService - Interface in com.jivesoftware.community.webservices
Provides a web service for managing Jive System Properties.

T

TAG - Static variable in class com.jivesoftware.community.JiveConstants
 
TAG_SET - Static variable in class com.jivesoftware.community.JiveConstants
 
TagCount - Class in com.jivesoftware.community.webservices
Container for tag and its count.
TagCount() - Constructor for class com.jivesoftware.community.webservices.TagCount
 
TagCount(String, int) - Constructor for class com.jivesoftware.community.webservices.TagCount
Creates a new Tag
TagResultFilter - Class in com.jivesoftware.community.webservices
 
TagResultFilter() - Constructor for class com.jivesoftware.community.webservices.TagResultFilter
 
tagService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
TagService - Interface in com.jivesoftware.community.webservices
Provides a service to create, retrieve and delete tags.
TEMPORARY_DOCUMENT_ID - Static variable in class com.jivesoftware.community.JiveConstants
 
THREAD - Static variable in class com.jivesoftware.community.JiveConstants
 
THREAD_NAME - Static variable in class com.jivesoftware.community.JiveConstants
 
TOO_LARGE - Static variable in exception com.jivesoftware.community.AttachmentException
 
TOO_MANY_ATTACHMENTS - Static variable in exception com.jivesoftware.community.AttachmentException
 
toString() - Method in class com.jivesoftware.community.Permissions
 
toString() - Method in class com.jivesoftware.community.webservices.ApprovalStatus
 
toString() - Method in class com.jivesoftware.community.webservices.Blog
 
toString() - Method in class com.jivesoftware.community.webservices.BlogPost
 
toString() - Method in class com.jivesoftware.community.webservices.ContentTag
 
toString() - Method in class com.jivesoftware.community.webservices.Document
 
toString() - Method in class com.jivesoftware.community.webservices.ForumMessage
 
toString() - Method in class com.jivesoftware.community.webservices.ForumThread
 
toString() - Method in class com.jivesoftware.community.webservices.Group
 
toString() - Method in class com.jivesoftware.community.webservices.JiveObject
 
toString() - Method in class com.jivesoftware.community.webservices.Locale
 
toString() - Method in class com.jivesoftware.community.webservices.Poll
 
toString() - Method in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
toString() - Method in class com.jivesoftware.community.webservices.Property
 
toString() - Method in class com.jivesoftware.community.webservices.Query
 
toString() - Method in class com.jivesoftware.community.webservices.StatusLevel
 
toString() - Method in class com.jivesoftware.community.webservices.TagCount
 
toString() - Method in class com.jivesoftware.community.webservices.User
 
toString() - Method in class com.jivesoftware.community.webservices.Watch
 
toString() - Method in class com.jivesoftware.community.webservices.WSConstants.AccessType
 
TRACKBACK - Static variable in class com.jivesoftware.community.JiveConstants
 
TRACKBACKS_DEFAULT - Static variable in class com.jivesoftware.community.webservices.BlogPost
The default trackback status for a blog post.

U

UnauthorizedException - Exception in com.jivesoftware.base
Thrown if a User does not have permission to access a particular method.
UnauthorizedException() - Constructor for exception com.jivesoftware.base.UnauthorizedException
 
UnauthorizedException(String) - Constructor for exception com.jivesoftware.base.UnauthorizedException
 
UnauthorizedException(Throwable) - Constructor for exception com.jivesoftware.base.UnauthorizedException
 
UnauthorizedException(String, Throwable) - Constructor for exception com.jivesoftware.base.UnauthorizedException
 
unfilteredName - Variable in class com.jivesoftware.community.webservices.ContentTag
 
unreadMessageCount - Variable in class com.jivesoftware.community.webservices.PrivateMessageFolder
 
updateBlogPost(BlogPost) - Method in interface com.jivesoftware.community.webservices.BlogService
 
updateComment(int, long, Comment) - Method in interface com.jivesoftware.community.webservices.CommentService
Updates an existing comment.
updateCommunity(Community) - Method in interface com.jivesoftware.community.webservices.CommunityService
Update a Community
updateDocument(Document) - Method in interface com.jivesoftware.community.webservices.DocumentService
 
updateForumMessage(ForumMessage) - Method in interface com.jivesoftware.community.webservices.ForumService
Used to update the subject and body of a ForumMessage
updateGroup(Group) - Method in interface com.jivesoftware.community.webservices.GroupService
Update the following group in the system.
updateStatusLevelScenario(StatusLevelScenario) - Method in interface com.jivesoftware.community.webservices.StatusLevelService
Update the points and whether or not this scenario is included in status level results.
updateUser(User) - Method in interface com.jivesoftware.community.webservices.UserService
Used to update user information in the system.
url - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
USER - Static variable in class com.jivesoftware.community.JiveConstants
 
User - Class in com.jivesoftware.community.webservices
Provides information about and services for users of the system.
User() - Constructor for class com.jivesoftware.community.webservices.User
 
USER_ADMIN - Static variable in class com.jivesoftware.community.Permissions
Permission to administer a particular user.
USER_LOCALE_PROP_NAME - Static variable in class com.jivesoftware.community.JiveConstants
The name of the extended user property used to store the user's locale code.
USER_MANAGER_CLASS - Static variable in class com.jivesoftware.community.JiveConstants
 
USER_STATUS - Static variable in class com.jivesoftware.community.JiveConstants
 
USER_TIMEZONE_PROP_NAME - Static variable in class com.jivesoftware.community.JiveConstants
The name of the extended user property used to store the user's time zone code.
UserContentCommentResultFilter - Class in com.jivesoftware.community.webservices
A result filter for use in creating queries which return all comments on content created by a given user.
UserContentCommentResultFilter() - Constructor for class com.jivesoftware.community.webservices.UserContentCommentResultFilter
 
userHasBlogs(long) - Method in interface com.jivesoftware.community.webservices.BlogService
Returns true if the given user has one or more blogs, false if the user does not have a blog.
username - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
UserNotFoundException - Exception in com.jivesoftware.base
Thrown when User cannot be found.
UserNotFoundException() - Constructor for exception com.jivesoftware.base.UserNotFoundException
 
UserNotFoundException(long) - Constructor for exception com.jivesoftware.base.UserNotFoundException
Allows you to create an exception specifying the id of the user that was not found
UserNotFoundException(String) - Constructor for exception com.jivesoftware.base.UserNotFoundException
 
UserNotFoundException(String, Throwable) - Constructor for exception com.jivesoftware.base.UserNotFoundException
 
UserNotFoundException(Throwable) - Constructor for exception com.jivesoftware.base.UserNotFoundException
 
UserProfile - Class in com.jivesoftware.community.webservices
Contains user data for a particular ProfileField.
UserProfile() - Constructor for class com.jivesoftware.community.webservices.UserProfile
 
userService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
UserService - Interface in com.jivesoftware.community.webservices
Provides a webservice for managing user's, avatar's, and status levels.
usersWithPermission(long, boolean) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns all the userID's of users with a particular permission.
usersWithPermissionCount(long, boolean) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns a count of the users that have a particular permission.
usersWithPermissionCountOnCommunity(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns a count of the users that have a particular permission on the specified community.
usersWithPermissionOnCommunity(long, boolean, long) - Method in interface com.jivesoftware.community.webservices.PermissionService
Returns all the userID's of users with a particular permission on the specified community.

V

value() - Method in class com.jivesoftware.community.Permissions
Returns the long value (bitmask) of the permissions that are set.
values() - Method in class com.jivesoftware.community.webservices.Cache
 
VIEW_COMMUNITY - Static variable in class com.jivesoftware.community.Permissions
Permission to read object.
VIEW_ONLINE_STATUS - Static variable in class com.jivesoftware.community.Permissions
Permission to see the online status of a particular user.
VOTE_IN_POLL - Static variable in class com.jivesoftware.community.Permissions
Permission to vote in polls.

W

Watch - Class in com.jivesoftware.community.webservices
A watch is a way for a user to track updates to an object.
Watch() - Constructor for class com.jivesoftware.community.webservices.Watch
 
WATCH_SETTINGS - Static variable in class com.jivesoftware.community.JiveConstants
 
WATCHABLE_OBJECT - Static variable in class com.jivesoftware.community.JiveConstants
 
watchService - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 
WatchService - Interface in com.jivesoftware.community.webservices
A service for manipulating a user's watches on objects
WEEK - Static variable in class com.jivesoftware.community.JiveConstants
One week (in milliseconds).
WIDGET - Static variable in class com.jivesoftware.community.JiveConstants
 
WIDGET_FRAME - Static variable in class com.jivesoftware.community.JiveConstants
 
WORKGROUP_AGENT - Static variable in class com.jivesoftware.community.JiveConstants
 
WORKGROUP_GROUP - Static variable in class com.jivesoftware.community.JiveConstants
 
WORKGROUP_QUEUE - Static variable in class com.jivesoftware.community.JiveConstants
 
WSConstants - Class in com.jivesoftware.community.webservices
Constants used with webservices
WSConstants() - Constructor for class com.jivesoftware.community.webservices.WSConstants
 
WSConstants.AccessType - Class in com.jivesoftware.community.webservices
Used to distinguish what kind of access is allowed on the server.

X

xfire - Variable in class com.jivesoftware.community.webservices.ServiceLocator
 

A B C D E F G H I J K L M N O P Q R S T U V W X
Clearspace Project Page

Copyright © 1999-2007 Jive Software.