CommunityService (Appian API)

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

Deprecated.
Use the class ContentService instead.
```
@Deprecated
public interface CommunityService
extends com.appiancorp.services.ContextSensitiveService
```
This interface provides services for other applications using methods related to collaboration communities.
Methods of service classes can all throw the unchecked exception ServiceException if any system-level error (for example, server failure) occurs, and will in general throw a checked exception (InvalidXXXException) when an entity to be retrieved is inaccessible, instead of returning null. Exceptions to this paradigm (including the use of ResultList as described below) are noted. All checked exceptions extend AppianException.
It may be necessary to retrieve a subset of results as opposed to an entire collection, and also to sort the subset by some property of the returned object. "Paging" methods which return a ResultPage are provided in certain instances for this purpose. The ResultPage will contain the sorted subset of results (via Result.getResults()), and the total number of items in the available result set (via ResultPage.getAvailableItems()).
It may also be necessary to retrieve some results, even if all results cannot be retrieved (for instance, some of the entities corresponding to a list of entity IDs may no longer exist). Methods which return a ResultList are provided for this purpose. The Result.getResults() method in this case will return all results which can be retrieved. In addition, there will be a list of result codes (ResultList.getResultCodes()) that represent the successful retrieval of an entity, or, if the entity could not be retrieved, the reason for the failure. See the CODE_XXX constants in ResultList for details.

See Also:

AdministrationService, CollaborationSearchService, DocumentService, FolderService, KnowledgeCenterService, ReportingService, StatisticsService

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`addCommunitiesToFavorites$UPDATES` Deprecated.
`static boolean`	`addCommunityToFavorites$UPDATES` Deprecated.
`static boolean`	`canGroupAdministrateCommunity$UPDATES` Deprecated.
`static boolean`	`canUserAdministrateCommunity$UPDATES` Deprecated.
`static boolean`	`createCommunities$UPDATES` Deprecated.
`static boolean`	`createCommunity$UPDATES` Deprecated.
`static boolean`	`deleteCommunity$UPDATES` Deprecated.
`static boolean`	`getAccessLevelForCommunities$UPDATES` Deprecated.
`static boolean`	`getAccessLevelForCommunity$UPDATES` Deprecated.
`static boolean`	`getAdministratableCommunitiesForUser$UPDATES` Deprecated.
`static boolean`	`getAdministratableCommunitiesForUserPaging$UPDATES` Deprecated.
`static boolean`	`getChildCommunities$UPDATES` Deprecated.
`static boolean`	`getChildCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`getChildKnowledgeCenters$UPDATES` Deprecated.
`static boolean`	`getChildKnowledgeCentersPaging$UPDATES` Deprecated.
`static boolean`	`getCommunities$UPDATES` Deprecated.
`static boolean`	`getCommunitiesForUser$UPDATES` Deprecated.
`static boolean`	`getCommunitiesForUserPaging$UPDATES` Deprecated.
`static boolean`	`getCommunitiesList$UPDATES` Deprecated.
`static boolean`	`getCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`getCommunity$UPDATES` Deprecated.
`static boolean`	`getCommunityIdForContentId$UPDATES` Deprecated.
`static boolean`	`getCommunityIdsForContentIds$UPDATES` Deprecated.
`static boolean`	`getContentIdForCommunityId$UPDATES` Deprecated.
`static boolean`	`getContentIdsForCommunityIds$UPDATES` Deprecated.
`static boolean`	`getFavoriteCommunities$UPDATES` Deprecated.
`static boolean`	`getFavoriteCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForCommunity$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForCommunityForUser$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForCommunityForUserPaging$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForCommunityPaging$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForTopLevelCommunity$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForTopLevelCommunityForUser$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATES` Deprecated.
`static boolean`	`getFeaturedDocumentsForTopLevelCommunityPaging$UPDATES` Deprecated.
`static boolean`	`getFullTree$UPDATES` Deprecated.
`static boolean`	`getFullTreePaging$UPDATES` Deprecated.
`static boolean`	`getInactiveCommunities$UPDATES` Deprecated.
`static boolean`	`getInactiveCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`getInheritedAdministratorGroups$UPDATES` Deprecated.
`static boolean`	`getInheritedAdministrators$UPDATES` Deprecated.
`static boolean`	`getRoleMapForCommunity$UPDATES` Deprecated.
`static boolean`	`getRootCommunities$UPDATES` Deprecated.
`static boolean`	`getRootCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`getSystemCommunityId$UPDATES` Deprecated.
`static boolean`	`getVisibleChildrenOfCommunity$UPDATES` Deprecated.
`static boolean`	`isCommunityEmpty$UPDATES` Deprecated.
`static boolean`	`reactivateCommunity$UPDATES` Deprecated.
`static boolean`	`removeCommunitiesFromFavorites$UPDATES` Deprecated.
`static boolean`	`removeCommunityFromFavorites$UPDATES` Deprecated.
`static boolean`	`removeFeaturedDocumentFromCommunity$UPDATES` Deprecated.
`static boolean`	`removeFeaturedDocumentsFromCommunity$UPDATES` Deprecated.
`static boolean`	`searchCommunitiesPaging$UPDATES` Deprecated.
`static boolean`	`setFeaturedDocumentForCommunity$UPDATES` Deprecated.
`static boolean`	`setFeaturedDocumentsForCommunity$UPDATES` Deprecated.
`static boolean`	`setRoleMapForCommunity$UPDATES` Deprecated.
`static boolean`	`setSystemCommunityId$UPDATES` Deprecated.
`static boolean`	`suggest$UPDATES` Deprecated.
`static boolean`	`updateCommunities$UPDATES` Deprecated.
`static boolean`	`updateCommunity$UPDATES` Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addCommunitiesToFavorites(java.lang.Long[] communityIds_)` Deprecated. Adds multiple `Community` objects to the user's list of favorites
`void`	`addCommunityToFavorites(java.lang.Long communityId_)` Deprecated. Adds a `Community` to the user's list of favorites
`boolean`	`canGroupAdministrateCommunity(java.lang.Long groupId_, java.lang.Long communityId_)` Deprecated. Returns `true` if the specified `Group` is an administrator of the `Community`
`boolean`	`canUserAdministrateCommunity(java.lang.Long communityId_)` Deprecated. Returns `true` if the current `User` is an administrator of the `Community`
`java.lang.Long[]`	`createCommunities(Community[] communities_)` Deprecated. Creates `Community` objects in bulk in the collaboration application
`java.lang.Long`	`createCommunity(Community community_)` Deprecated. Creates a new `Community` in the collaboration application
`void`	`deleteCommunity(java.lang.Long communityId_)` Deprecated. Deletes the specified `Community`
`int[]`	`getAccessLevelForCommunities(java.lang.Long[] cids_)` Deprecated. Retrieves the Access Levels for a list of communities
`int`	`getAccessLevelForCommunity(java.lang.Long cid_)` Deprecated. Retrieves the Access Level for a community
`Community[]`	`getAdministratableCommunitiesForUser()` Deprecated. use `getAdministratableCommunitiesForUserPaging(int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getAdministratableCommunitiesForUserPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `Community` objects of which the current `User` is an administrator.
`Community[]`	`getChildCommunities(java.lang.Long communityId_, java.lang.Integer sortOrder_, java.lang.String sortColumn_)` Deprecated. use `getChildCommunitiesPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getChildCommunitiesPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `Community` objects which are direct children of the specified parent `Community`.
`KnowledgeCenter[]`	`getChildKnowledgeCenters(java.lang.Long communityId_, java.lang.Integer sortOrder_, java.lang.String sortColumn_)` Deprecated. use `getChildKnowledgeCentersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getChildKnowledgeCentersPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `KnowledgeCenter` objects which are direct children of the specified parent `Community` NOTE: The returned list will be sorted first by `sortProperty_`, and then by user status in the order: `KnowledgeCenter.USER_STATUS_SUBSCRIBED`, `KnowledgeCenter.USER_STATUS_PENDING`, `KnowledgeCenter.USER_STATUS_UNSUBSCRIBED`
`Community[]`	`getCommunities(java.lang.Long[] communityIds_)` Deprecated. use `getCommunitiesPaging(Long[], int, int, Integer, Integer)` instead
`Community[]`	`getCommunitiesForUser()` Deprecated. use `getCommunitiesForUserPaging(int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getCommunitiesForUserPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `Community` objects which contain `Document` objects to which the current `User` has access Users will only be able to see those `Document` objects to which they have at least read-only access.
`ResultList`	`getCommunitiesList(java.lang.Long[] ids_)` Deprecated. Get the `Community` objects by the requested IDs.
`ResultPage`	`getCommunitiesPaging(java.lang.Long[] communityIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves a list of `Community` objects from their IDs
`Community`	`getCommunity(java.lang.Long communityId_)` Deprecated. Retrieves a `Community`
`java.lang.Long`	`getCommunityIdForContentId(java.lang.Long id_)` Deprecated. Converts a content id into a community id.
`java.lang.Long[]`	`getCommunityIdsForContentIds(java.lang.Long[] id_)` Deprecated. Converts an array of content id's into an array of community id's.
`java.lang.Long`	`getContentIdForCommunityId(java.lang.Long id_)` Deprecated. Converts a community id into a content id.
`java.lang.Long[]`	`getContentIdsForCommunityIds(java.lang.Long[] ids_)` Deprecated. Converts an array of community id's into an array of content id's.
`Community[]`	`getFavoriteCommunities(java.lang.Integer sortOrder_, java.lang.String sortColumn_)` Deprecated. use `getFavoriteCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getFavoriteCommunitiesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `Community` objects which have been tagged as favorites by the user
`Document[]`	`getFeaturedDocumentsForCommunity(java.lang.Long communityId_)` Deprecated. use `getFeaturedDocumentsForCommunityPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`Document[]`	`getFeaturedDocumentsForCommunityForUser(java.lang.Long communityId_)` Deprecated. use `getFeaturedDocumentsForCommunityForUserPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getFeaturedDocumentsForCommunityForUserPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the featured `Document` objects for a given `Community` and its subcommunities that the current `User` can access.
`ResultPage`	`getFeaturedDocumentsForCommunityPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the featured `Document` objects for a given `Community` (and its subcommunities)
`Document[]`	`getFeaturedDocumentsForTopLevelCommunity(java.lang.Long communityId_)` Deprecated. use `getFeaturedDocumentsForTopLevelCommunityPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`Document[]`	`getFeaturedDocumentsForTopLevelCommunityForUser(java.lang.Long communityId_)` Deprecated. use `getFeaturedDocumentsForTopLevelCommunityForUserPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getFeaturedDocumentsForTopLevelCommunityForUserPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the featured `Document` objects for a given `Community` (but not its subcommunities) that the current user can access.
`ResultPage`	`getFeaturedDocumentsForTopLevelCommunityPaging(java.lang.Long communityId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the featured documents for a given Community (but not its subcommunities)
`MenuTree[]`	`getFullTree()` Deprecated. Get a list of `MenuTree` objects for construction of the collaboration navigation tree
`ResultPage`	`getFullTreePaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Get a list of `MenuTree` objects for construction of the collaboration navigation tree
`Community[]`	`getInactiveCommunities()` Deprecated. use `getInactiveCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getInactiveCommunitiesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of inactive `Community` objects
`java.lang.Long[]`	`getInheritedAdministratorGroups(java.lang.Long communityId_)` Deprecated. Get the inherited administrator groups for a `Community`.
`java.lang.String[]`	`getInheritedAdministrators(java.lang.Long communityId_)` Deprecated. Get the inherited administrators for a `Community`.
`CollaborationRoleMap`	`getRoleMapForCommunity(java.lang.Long communityId_)` Deprecated. Retrieves the `CollaborationRoleMap` object for a given `Community`
`Community[]`	`getRootCommunities()` Deprecated. use `getRootCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer)` instead
`ResultPage`	`getRootCommunitiesPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Retrieves the list of `Community` objects which are root communities NOTE: The returned list will be sorted first by `sortProperty_`, and then by user status in the order: `Community.USER_STATUS_SUBSCRIBED`, `Community.USER_STATUS_PENDING`, `Community.USER_STATUS_UNSUBSCRIBED`
`java.lang.Long`	`getSystemCommunityId(java.lang.String name_)` Deprecated. use `ContentService.getIdByUuid(String)` and `getCommunityIdForContentId(Long)`
`java.lang.Integer[]`	`getVisibleChildrenOfCommunity(java.lang.Long[] communityIds_)` Deprecated. Retrieve visible children of a `Community`.
`boolean`	`isCommunityEmpty(java.lang.Long communityId_)` Deprecated. Checks whether a community contains children (sub-communities, knowledge centers, folders or documents).
`void`	`reactivateCommunity(java.lang.Long communityId_)` Deprecated. Reactivate a `Community`.
`void`	`removeCommunitiesFromFavorites(java.lang.Long[] communityIds_)` Deprecated. Removes multiple `Community` objects from the user's favorites list
`void`	`removeCommunityFromFavorites(java.lang.Long communityId_)` Deprecated. Removes a `Community` from the user's favorites list
`void`	`removeFeaturedDocumentFromCommunity(java.lang.Long documentId_)` Deprecated. Unfeature a `Document` for the `Community` in which it currently resides
`void`	`removeFeaturedDocumentsFromCommunity(java.lang.Long[] documentIds_)` Deprecated. Unfeature a list of `Document` objects for the `Community` in which they currently reside
`ResultPage`	`searchCommunitiesPaging(java.lang.String searchterm_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)` Deprecated. Get the `Community` objects whose names match `searchterm_`.
`void`	`setFeaturedDocumentForCommunity(java.lang.Long documentId_)` Deprecated. Set a `Document` to be 'featured' for the `Community` in which the `Document` currently resides.
`void`	`setFeaturedDocumentsForCommunity(java.lang.Long[] documentIds_)` Deprecated. Set a list of `Document` objects to be 'featured' for the `Community` in which they currently reside
`void`	`setRoleMapForCommunity(java.lang.Long communityId_, CollaborationRoleMap crm_)` Deprecated. Set the `CollaborationRoleMap` object for a given `Community`.
`void`	`setSystemCommunityId(java.lang.String name_, java.lang.Long id_)` Deprecated. use `createCommunity(Community)` with a pre-populated UUID
`java.lang.String`	`suggest(java.lang.String query_, int maxItems_, SuggestParam[] params_, java.lang.Boolean groupResults_)` Deprecated.
`java.lang.String`	`suggest(java.lang.String query_, int maxItems_, SuggestParam[] params_, java.lang.Boolean groupResults_, java.lang.Long[] allowList)` Deprecated.
`void`	`updateCommunities(Community[] communities_)` Deprecated. Updates the information stored about a list of `Community` objects
`void`	`updateCommunity(Community community_)` Deprecated. Updates a `Community`

Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext

- Field Detail
  - createCommunity$UPDATES
```
static final boolean createCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - createCommunities$UPDATES
```
static final boolean createCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - deleteCommunity$UPDATES
```
static final boolean deleteCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunity$UPDATES
```
static final boolean getCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunities$UPDATES
```
static final boolean getCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunitiesPaging$UPDATES
```
static final boolean getCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunitiesForUser$UPDATES
```
static final boolean getCommunitiesForUser$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunitiesForUserPaging$UPDATES
```
static final boolean getCommunitiesForUserPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getAdministratableCommunitiesForUser$UPDATES
```
static final boolean getAdministratableCommunitiesForUser$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getAdministratableCommunitiesForUserPaging$UPDATES
```
static final boolean getAdministratableCommunitiesForUserPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getRootCommunities$UPDATES
```
static final boolean getRootCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getRootCommunitiesPaging$UPDATES
```
static final boolean getRootCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - updateCommunity$UPDATES
```
static final boolean updateCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - updateCommunities$UPDATES
```
static final boolean updateCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getInactiveCommunities$UPDATES
```
static final boolean getInactiveCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getInactiveCommunitiesPaging$UPDATES
```
static final boolean getInactiveCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getChildCommunities$UPDATES
```
static final boolean getChildCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getChildCommunitiesPaging$UPDATES
```
static final boolean getChildCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getChildKnowledgeCenters$UPDATES
```
static final boolean getChildKnowledgeCenters$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getChildKnowledgeCentersPaging$UPDATES
```
static final boolean getChildKnowledgeCentersPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - isCommunityEmpty$UPDATES
```
static final boolean isCommunityEmpty$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFavoriteCommunities$UPDATES
```
static final boolean getFavoriteCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFavoriteCommunitiesPaging$UPDATES
```
static final boolean getFavoriteCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - addCommunityToFavorites$UPDATES
```
static final boolean addCommunityToFavorites$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - addCommunitiesToFavorites$UPDATES
```
static final boolean addCommunitiesToFavorites$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - removeCommunityFromFavorites$UPDATES
```
static final boolean removeCommunityFromFavorites$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - removeCommunitiesFromFavorites$UPDATES
```
static final boolean removeCommunitiesFromFavorites$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFullTree$UPDATES
```
static final boolean getFullTree$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFullTreePaging$UPDATES
```
static final boolean getFullTreePaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - setRoleMapForCommunity$UPDATES
```
static final boolean setRoleMapForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getRoleMapForCommunity$UPDATES
```
static final boolean getRoleMapForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForCommunity$UPDATES
```
static final boolean getFeaturedDocumentsForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForCommunityPaging$UPDATES
```
static final boolean getFeaturedDocumentsForCommunityPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForCommunityForUser$UPDATES
```
static final boolean getFeaturedDocumentsForCommunityForUser$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForCommunityForUserPaging$UPDATES
```
static final boolean getFeaturedDocumentsForCommunityForUserPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForTopLevelCommunity$UPDATES
```
static final boolean getFeaturedDocumentsForTopLevelCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForTopLevelCommunityPaging$UPDATES
```
static final boolean getFeaturedDocumentsForTopLevelCommunityPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForTopLevelCommunityForUser$UPDATES
```
static final boolean getFeaturedDocumentsForTopLevelCommunityForUser$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATES
```
static final boolean getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - setFeaturedDocumentForCommunity$UPDATES
```
static final boolean setFeaturedDocumentForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - setFeaturedDocumentsForCommunity$UPDATES
```
static final boolean setFeaturedDocumentsForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - removeFeaturedDocumentFromCommunity$UPDATES
```
static final boolean removeFeaturedDocumentFromCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - removeFeaturedDocumentsFromCommunity$UPDATES
```
static final boolean removeFeaturedDocumentsFromCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getInheritedAdministrators$UPDATES
```
static final boolean getInheritedAdministrators$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getInheritedAdministratorGroups$UPDATES
```
static final boolean getInheritedAdministratorGroups$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - reactivateCommunity$UPDATES
```
static final boolean reactivateCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - canUserAdministrateCommunity$UPDATES
```
static final boolean canUserAdministrateCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - canGroupAdministrateCommunity$UPDATES
```
static final boolean canGroupAdministrateCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getVisibleChildrenOfCommunity$UPDATES
```
static final boolean getVisibleChildrenOfCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunitiesList$UPDATES
```
static final boolean getCommunitiesList$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - searchCommunitiesPaging$UPDATES
```
static final boolean searchCommunitiesPaging$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getSystemCommunityId$UPDATES
```
static final boolean getSystemCommunityId$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - setSystemCommunityId$UPDATES
```
static final boolean setSystemCommunityId$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - suggest$UPDATES
```
static final boolean suggest$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getContentIdForCommunityId$UPDATES
```
static final boolean getContentIdForCommunityId$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getContentIdsForCommunityIds$UPDATES
```
static final boolean getContentIdsForCommunityIds$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunityIdForContentId$UPDATES
```
static final boolean getCommunityIdForContentId$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getCommunityIdsForContentIds$UPDATES
```
static final boolean getCommunityIdsForContentIds$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getAccessLevelForCommunity$UPDATES
```
static final boolean getAccessLevelForCommunity$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
  - getAccessLevelForCommunities$UPDATES
```
static final boolean getAccessLevelForCommunities$UPDATES
```
    Deprecated.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - createCommunity
```
java.lang.Long createCommunity(Community community_)
                        throws InvalidUserException,
                               InvalidCommunityException
```
    Deprecated.
    
    Creates a new Community in the collaboration application
    
    Parameters:
    
    community_ - A Community object which should contain all of the information required to create a valid Community. Minimum required fields: name, description
    
    Returns:
    
    The unique ID of the newly created Community
    
    Throws:
    
    InvalidUserException - if the current user does not exist
    
    InvalidCommunityException - if the parent ID of the Community specifies a Community that does not exist
    
    ServiceException - if any system-level error occurs
  - createCommunities
```
java.lang.Long[] createCommunities(Community[] communities_)
                            throws InvalidUserException,
                                   InvalidCommunityException
```
    Deprecated.
    
    Creates Community objects in bulk in the collaboration application
    
    Parameters:
    
    communities_ - An array of Community objects, each of which should contain all of the information required to create a valid Community. Minimum required fields: name, description
    
    Returns:
    
    The unique IDs of the newly created Community objects
    
    Throws:
    
    InvalidUserException - if the current user does not exist
    
    InvalidCommunityException - if the parent ID of any of the Community objects specifies a Community that does not exist
    
    ServiceException - if any system-level error occurs
  - deleteCommunity
```
void deleteCommunity(java.lang.Long communityId_)
              throws InvalidCommunityException,
                     NotEmptyException
```
    Deprecated.
    
    Deletes the specified Community
    
    Parameters:
    
    communityId_ - the unique ID of the Community to be deleted
    
    Throws:
    
    InvalidCommunityException - if no Community exists with the unique ID communityId_
    
    NotEmptyException - if the Community contains children (either other Community objects or KnowledgeCenter objects) and therefore cannot be deleted.
    
    ServiceException - if any system-level error occurs
  - getCommunity
```
Community getCommunity(java.lang.Long communityId_)
                throws InvalidCommunityException
```
    Deprecated.
    
    Retrieves a Community
    
    Parameters:
    
    communityId_ - The unique ID of the Community to be retrieved
    
    Returns:
    
    A Community object representing the community with unique ID communityId_
    
    Throws:
    
    InvalidCommunityException - if no Community exists with the unique ID communityId_.
    
    ServiceException - if any system-level error occurs
  - getCommunities
```
@Deprecated
Community[] getCommunities(java.lang.Long[] communityIds_)
                                throws InvalidCommunityException
```
    Deprecated. use getCommunitiesPaging(Long[], int, int, Integer, Integer) instead
    
    Retrieves a list of Community objects from their IDs
    
    Parameters:
    
    communityIds_ - an array of unique IDs of the communities to be retrieved
    
    Returns:
    
    an array of Community objects representing the communities whose unique IDs are in communityIds_
    
    Throws:
    
    InvalidCommunityException - if any of the unique IDs in communityIds_ is invalid
    
    ServiceException - if any system-level error occurs
  - getCommunitiesPaging
```
ResultPage getCommunitiesPaging(java.lang.Long[] communityIds_,
                                int startIndex_,
                                int batchSize_,
                                java.lang.Integer sortProperty_,
                                java.lang.Integer sortOrder_)
                         throws InvalidCommunityException
```
    Deprecated.
    
    Retrieves a list of Community objects from their IDs
    
    Parameters:
    
    communityIds_ - an array of unique IDs of the communities to be retrieved
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - the property by which the results will be sorted This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of Community objects representing the communities whose unique IDs are in communityIds_
    
    Throws:
    
    InvalidCommunityException - if any of the unique IDs in communityIds_ is invalid
    
    ServiceException - if any system-level error occurs.
  - getCommunitiesForUser
```
@Deprecated
Community[] getCommunitiesForUser()
                                       throws InvalidUserException,
                                              InvalidCommunityException
```
    Deprecated. use getCommunitiesForUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of Community objects which contain Document objects to which the current User has access. Users will only be able to see those Document objects to which they have at least read-only access.
    
    Returns:
    
    An array of Community objects representing the communities which contain documents to which the current user has access
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if one or more of the communities returned no longer exist
    
    ServiceException - if any system-level error occurs
  - getCommunitiesForUserPaging
```
ResultPage getCommunitiesForUserPaging(int startIndex_,
                                       int batchSize_,
                                       java.lang.Integer sortProperty_,
                                       java.lang.Integer sortOrder_)
                                throws InvalidUserException,
                                       InvalidCommunityException
```
    Deprecated.
    
    Retrieves the list of Community objects which contain Document objects to which the current User has access Users will only be able to see those Document objects to which they have at least read-only access.
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of Community objects representing the communities which contain documents to which the current User has access
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if one or more of the communities returned no longer exist
    
    ServiceException - if any system-level error occurs
  - getAdministratableCommunitiesForUser
```
@Deprecated
Community[] getAdministratableCommunitiesForUser()
                                                      throws InvalidUserException,
                                                             InvalidCommunityException
```
    Deprecated. use getAdministratableCommunitiesForUserPaging(int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of Community objects of which the current User is an administrator.
    
    Returns:
    
    An array of Community objects representing the communities of which the current User is an administrator.
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if one or more of the communities returned no longer exist
    
    ServiceException - if any system-level error occurs.
  - getAdministratableCommunitiesForUserPaging
```
ResultPage getAdministratableCommunitiesForUserPaging(int startIndex_,
                                                      int batchSize_,
                                                      java.lang.Integer sortProperty_,
                                                      java.lang.Integer sortOrder_)
                                               throws InvalidUserException,
                                                      InvalidCommunityException
```
    Deprecated.
    
    Retrieves the list of Community objects of which the current User is an administrator.
    
    Parameters:
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of Community objects representing the communities of which the current User is an administrator.
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if one or more of the communities returned no longer exist
    
    ServiceException - if any system-level error occurs.
  - getRootCommunities
```
@Deprecated
Community[] getRootCommunities()
                                    throws InvalidUserException,
                                           InvalidKnowledgeCenterException,
                                           InvalidCommunityException
```
    Deprecated. use getRootCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of Community objects which are root communities NOTE:The returned list will be sorted first by ID, and then by user status in the order: Community.USER_STATUS_SUBSCRIBED, Community.USER_STATUS_PENDING, Community.USER_STATUS_UNSUBSCRIBED
    
    Returns:
    
    An array of Community objects representing the communities which are root communities.
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if any of the root communities to be returned contains an invalid KnowledgeCenter
    
    InvalidCommunityException - if any of the communities does not exist
    
    ServiceException - if any system-level error occurs
  - getRootCommunitiesPaging
```
ResultPage getRootCommunitiesPaging(int startIndex_,
                                    int batchSize_,
                                    java.lang.Integer sortProperty_,
                                    java.lang.Integer sortOrder_)
                             throws InvalidUserException,
                                    InvalidKnowledgeCenterException,
                                    InvalidCommunityException
```
    Deprecated.
    
    Retrieves the list of Community objects which are root communities NOTE: The returned list will be sorted first by sortProperty_, and then by user status in the order: Community.USER_STATUS_SUBSCRIBED, Community.USER_STATUS_PENDING, Community.USER_STATUS_UNSUBSCRIBED
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of Community objects representing the communities which are root communities.
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if any of the root communities to be returned contains an invalid KnowledgeCenter
    
    InvalidCommunityException - if any of the comunities does not exist
    
    ServiceException - if any system-level error occurs
  - updateCommunity
```
void updateCommunity(Community community_)
              throws InvalidCommunityException,
                     RecursiveRelationshipException
```
    Deprecated.
    
    Updates a Community
    
    Parameters:
    
    community_ - A Community object which should contain all of the information required to update a valid community. Minimum required fields: name,description, id. The rest of the fields are ignored.
    
    Throws:
    
    InvalidCommunityException - if the community is invalid or does not exist
    
    RecursiveRelationshipException - if the parent ID of the community is the same as the ID of the community
    
    ServiceException - if any system-level error occurs
  - updateCommunities
```
void updateCommunities(Community[] communities_)
                throws InvalidCommunityException,
                       RecursiveRelationshipException
```
    Deprecated.
    
    Updates the information stored about a list of Community objects
    
    Parameters:
    
    communities_ - a list of Community objects which should contain all of the information required to update a valid community. Minimum required fields: name, description, id. The rest of the fields are ignored.
    
    Throws:
    
    InvalidCommunityException - if any of the communities specified in communities_ is invalid or does not exist
    
    RecursiveRelationshipException - if the parent ID of any of the communities is the same as the ID for that community
    
    ServiceException - if any system-level error occurs
  - getInactiveCommunities
```
@Deprecated
Community[] getInactiveCommunities()
```
    Deprecated. use getInactiveCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of inactive Community objects
    
    Returns:
    
    An array of Community objects representing all inactive communities
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getInactiveCommunitiesPaging
```
ResultPage getInactiveCommunitiesPaging(int startIndex_,
                                        int batchSize_,
                                        java.lang.Integer sortProperty_,
                                        java.lang.Integer sortOrder_)
```
    Deprecated.
    
    Retrieves the list of inactive Community objects
    
    Parameters:
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of Community objects representing all inactive communities
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getChildCommunities
```
@Deprecated
Community[] getChildCommunities(java.lang.Long communityId_,
                                            java.lang.Integer sortOrder_,
                                            java.lang.String sortColumn_)
                                     throws InvalidUserException,
                                            InvalidCommunityException,
                                            InvalidKnowledgeCenterException
```
    Deprecated. use getChildCommunitiesPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of Community objects which are direct children of the specified parent Community. NOTE: The returned list will be sorted first by sortColumn_, and then by user status in the order: Community.USER_STATUS_SUBSCRIBED, Community.USER_STATUS_PENDING, Community.USER_STATUS_UNSUBSCRIBED
    
    Parameters:
    
    communityId_ - the unique ID of the parent Community
    
    sortOrder_ - The order in which to sort the returned list of communities. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    sortColumn_ - The field of the Community by which to sort the returned list of communities. This is one of the SORT_COLUMN_XXX constants in Community
    
    Returns:
    
    An array of Community objects representing those communities which are direct children of the specified community
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if the comunity does not exist
    
    InvalidKnowledgeCenterException - if one or more of the comunities to be returned contains a KnowledgeCenter which does not exist
    
    ServiceException - if any system-level error occurs
  - getChildCommunitiesPaging
```
ResultPage getChildCommunitiesPaging(java.lang.Long communityId_,
                                     int startIndex_,
                                     int batchSize_,
                                     java.lang.Integer sortProperty_,
                                     java.lang.Integer sortOrder_)
                              throws InvalidUserException,
                                     InvalidCommunityException,
                                     InvalidKnowledgeCenterException
```
    Deprecated.
    
    Retrieves the list of Community objects which are direct children of the specified parent Community. NOTE: The returned list will be sorted first by sortProperty_, and then by user status in the order: Community.USER_STATUS_SUBSCRIBED, Community.USER_STATUS_PENDING, Community.USER_STATUS_UNSUBSCRIBED
    
    Parameters:
    
    communityId_ - the unique ID of the parent Community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the results. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    a ResultPage containing an array of Community objects representing those communities which are direct children of the specified community
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if the comunity does not exist
    
    InvalidKnowledgeCenterException - if one or more of the comunities to be returned contains a KnowledgeCenter which does not exist
    
    ServiceException - if any system-level error occurs
  - getChildKnowledgeCenters
```
@Deprecated
KnowledgeCenter[] getChildKnowledgeCenters(java.lang.Long communityId_,
                                                       java.lang.Integer sortOrder_,
                                                       java.lang.String sortColumn_)
                                                throws InvalidUserException,
                                                       InvalidKnowledgeCenterException,
                                                       InvalidCommunityException
```
    Deprecated. use getChildKnowledgeCentersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of KnowledgeCenter objects which are direct children of the specified parent Community NOTE: The returned list will be sorted first by sortColumn_, and then by user status in the order: KnowledgeCenter.USER_STATUS_SUBSCRIBED, KnowledgeCenter.USER_STATUS_PENDING, KnowledgeCenter.USER_STATUS_UNSUBSCRIBED
    
    Parameters:
    
    communityId_ - the unique ID of the parent community
    
    sortOrder_ - the order in which to sort the returned list of knowledge centers. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    sortColumn_ - The field of the KnowledgeCenter by which to sort the returned list of knowledge centers. This is one of the SORT_COLUMN_XXX constants in KnowledgeCenter.
    
    Returns:
    
    a list of KnowledgeCenter objects representing those knowledge centers which are direct children of the community specified by communityId_
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if one or more of the knowledge centers to be returned does not exist
    
    InvalidCommunityException - of the Community does not exist
    
    ServiceException - if any system-level error occurs
  - getChildKnowledgeCentersPaging
```
ResultPage getChildKnowledgeCentersPaging(java.lang.Long communityId_,
                                          int startIndex_,
                                          int batchSize_,
                                          java.lang.Integer sortProperty_,
                                          java.lang.Integer sortOrder_)
                                   throws InvalidUserException,
                                          InvalidKnowledgeCenterException,
                                          InvalidCommunityException
```
    Deprecated.
    
    Retrieves the list of KnowledgeCenter objects which are direct children of the specified parent Community NOTE: The returned list will be sorted first by sortProperty_, and then by user status in the order: KnowledgeCenter.USER_STATUS_SUBSCRIBED, KnowledgeCenter.USER_STATUS_PENDING, KnowledgeCenter.USER_STATUS_UNSUBSCRIBED
    
    Parameters:
    
    communityId_ - the unique ID of the parent community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the SORT_KNOWLEDGECENTER_PROPERTY_XXX constants in KnowledgeCenterService.
    
    sortOrder_ - The order in which to sort the returned communities This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    a ResultPage containing the list of KnowledgeCenter objects representing those knowledge centers which are direct children of the specified community
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if one or more of the knowledge centers to be returned does not exist
    
    InvalidCommunityException - if the Community does not exist
    
    ServiceException - if any system-level error occurs
  - isCommunityEmpty
```
boolean isCommunityEmpty(java.lang.Long communityId_)
                  throws InvalidCommunityException
```
    Deprecated.
    
    Checks whether a community contains children (sub-communities, knowledge centers, folders or documents).
    
    Parameters:
    
    communityId_ - the unique ID of the community to check
    
    Returns:
    
    true if the community is empty; false otherwise
    
    Throws:
    
    InvalidCommunityException - if the community specified by communityId_ is invalid
    
    ServiceException - if any system-level error occurs
  - getFavoriteCommunities
```
@Deprecated
Community[] getFavoriteCommunities(java.lang.Integer sortOrder_,
                                               java.lang.String sortColumn_)
                                        throws InvalidUserException,
                                               InvalidCommunityException,
                                               InvalidKnowledgeCenterException
```
    Deprecated. use getFavoriteCommunitiesPaging(int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the list of Community objects which have been tagged as favorites by the user
    
    Parameters:
    
    sortOrder_ - The order in which to sort the returned list of communities. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    sortColumn_ - the field of the Community by which to sort the returned list of communities. This is one of the SORT_COLUMN_XXX constants in Community.
    
    Returns:
    
    An array of Community objects representing those communities which are in the user's list of favorite communities
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if one or more of the comunities do not exist
    
    InvalidKnowledgeCenterException - if any of the communities to be returned contains an invalid KnowledgeCenter
    
    ServiceException - if any system-level error occurs
  - getFavoriteCommunitiesPaging
```
ResultPage getFavoriteCommunitiesPaging(int startIndex_,
                                        int batchSize_,
                                        java.lang.Integer sortProperty_,
                                        java.lang.Integer sortOrder_)
                                 throws InvalidUserException,
                                        InvalidCommunityException,
                                        InvalidKnowledgeCenterException
```
    Deprecated.
    
    Retrieves the list of Community objects which have been tagged as favorites by the user
    
    Parameters:
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the returned communities This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing the list of Community objects representing those communities which are in the user's list of favorite communities
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if one or more of the comunities do not exist
    
    InvalidKnowledgeCenterException - if any of the communities to be returned contains an invalid KnowledgeCenter
    
    ServiceException - if any system-level error occurs
  - addCommunityToFavorites
```
void addCommunityToFavorites(java.lang.Long communityId_)
                      throws InvalidUserException,
                             InvalidCommunityException,
                             InvalidKnowledgeCenterException
```
    Deprecated.
    
    Adds a Community to the user's list of favorites
    
    Parameters:
    
    communityId_ - the unique ID of the community to be added
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if communityId_ does not correspond to a community
    
    InvalidKnowledgeCenterException - if the community to be added contains an invalid KnowledgeCenter
    
    ServiceException - if any system-level error occurs
  - addCommunitiesToFavorites
```
void addCommunitiesToFavorites(java.lang.Long[] communityIds_)
                        throws InvalidUserException,
                               InvalidCommunityException,
                               InvalidKnowledgeCenterException,
                               InvalidDataFormatException
```
    Deprecated.
    
    Adds multiple Community objects to the user's list of favorites
    
    Parameters:
    
    communityIds_ - an array containing the unique IDs of the communities to be added as favorites
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if one or more of the unique IDs in communityIds_ does not correspond to a community
    
    InvalidKnowledgeCenterException - if any of the communities to be added contains an invalid KnowledgeCenter
    
    InvalidDataFormatException - if communityIds_ is null
    
    ServiceException - if any system-level error occurs
  - removeCommunityFromFavorites
```
void removeCommunityFromFavorites(java.lang.Long communityId_)
                           throws InvalidUserException,
                                  InvalidCommunityException,
                                  InvalidKnowledgeCenterException
```
    Deprecated.
    
    Removes a Community from the user's favorites list
    
    Parameters:
    
    communityId_ - the unique ID of the community to be removed
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if the community does not exist
    
    InvalidKnowledgeCenterException - if the community to be removed contains an invalid KnowledgeCenter
    
    ServiceException - if any system-level error occurs
  - removeCommunitiesFromFavorites
```
void removeCommunitiesFromFavorites(java.lang.Long[] communityIds_)
                             throws InvalidUserException,
                                    InvalidCommunityException,
                                    InvalidKnowledgeCenterException,
                                    InvalidDataFormatException
```
    Deprecated.
    
    Removes multiple Community objects from the user's favorites list
    
    Parameters:
    
    communityIds_ - an array containing the unique IDs of the communities to be removed from favorites
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if one or more of the unique IDs in communityIds_ does not exist
    
    InvalidKnowledgeCenterException - if any of the communities to be removed contains an invalid KnowledgeCenter
    
    InvalidDataFormatException - if communityIds_ is null
    
    ServiceException - if any system-level error occurs
  - getFullTree
```
MenuTree[] getFullTree()
                throws InvalidUserException,
                       InvalidKnowledgeCenterException
```
    Deprecated.
    
    Get a list of MenuTree objects for construction of the collaboration navigation tree
    
    Returns:
    
    An array of MenuTree objects
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if one or more of the KnowledgeCenter objects represented by the MenuTree object does not exist
    
    ServiceException - if any system-level error occurs
  - getFullTreePaging
```
ResultPage getFullTreePaging(int startIndex_,
                             int batchSize_,
                             java.lang.Integer sortProperty_,
                             java.lang.Integer sortOrder_)
                      throws InvalidUserException,
                             InvalidKnowledgeCenterException
```
    Deprecated.
    
    Get a list of MenuTree objects for construction of the collaboration navigation tree
    
    Parameters:
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the SORT_MENUTREE_PROPERTY_XXX constants
    
    sortOrder_ - The order in which to sort the MenuTree This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing an array of MenuTree objects
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidKnowledgeCenterException - if one or more of the KnowledgeCenter objects represented by the MenuTree object does not exist
    
    ServiceException - if any system-level error occurs
  - setRoleMapForCommunity
```
void setRoleMapForCommunity(java.lang.Long communityId_,
                            CollaborationRoleMap crm_)
                     throws InvalidUserException,
                            InvalidCommunityException,
                            PrivilegeException
```
    Deprecated.
    
    Set the CollaborationRoleMap object for a given Community. It is necessary to set the role map for a community before any methods which require certain privileges can be called (simply setting the permissions through the Community is insufficient).
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    crm_ - The CollaborationRoleMap object which contains the users and groups in each role to set (overwrite)
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Community does not exist
    
    PrivilegeException - if the User does not have the rights to set the rolemap
    
    ServiceException - if any system-level error occurs
  - getRoleMapForCommunity
```
CollaborationRoleMap getRoleMapForCommunity(java.lang.Long communityId_)
```
    Deprecated.
    
    Retrieves the CollaborationRoleMap object for a given Community
    
    Parameters:
    
    communityId_ - The unique ID for a Community
    
    Returns:
    
    CollaborationRoleMap object which contains the users and groups in each role
    
    Throws:
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForCommunity
```
@Deprecated
Document[] getFeaturedDocumentsForCommunity(java.lang.Long communityId_)
                                                 throws InvalidCommunityException,
                                                        InvalidDocumentException,
                                                        PrivilegeException
```
    Deprecated. use getFeaturedDocumentsForCommunityPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the featured Document objects for a given Community (and its subcommunities).
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    Returns:
    
    An array of Document objects representing the featured Document objects for this Community (and its subcommunities)
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the featured Document objects to be returned does not exist
    
    ServiceException - if any system-level error occurs
    
    PrivilegeException
  - getFeaturedDocumentsForCommunityPaging
```
ResultPage getFeaturedDocumentsForCommunityPaging(java.lang.Long communityId_,
                                                  int startIndex_,
                                                  int batchSize_,
                                                  java.lang.Integer sortProperty_,
                                                  java.lang.Integer sortOrder_)
                                           throws InvalidCommunityException,
                                                  InvalidDocumentException
```
    Deprecated.
    
    Retrieves the featured Document objects for a given Community (and its subcommunities)
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This will be one of the SORT_DOCUMENT_PROPERTY_XXX constants in DocumentService
    
    sortOrder_ - The order in which to sort the Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    a ResultPage containing an array of Document objects representing the featured Document objects for this Community (and its subcommunities)
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the featured Document objects to be returned does not exist
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForCommunityForUser
```
@Deprecated
Document[] getFeaturedDocumentsForCommunityForUser(java.lang.Long communityId_)
                                                        throws InvalidUserException,
                                                               InvalidCommunityException,
                                                               InvalidDocumentException
```
    Deprecated. use getFeaturedDocumentsForCommunityForUserPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the featured Document objects for a given Community and its subcommunities that the current User can access. Users will only be able to see those Document objects to which they have at least read-only access.
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    Returns:
    
    An array of Document objects representing the featured documents for this Community and its subcommunities that the current user can access
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Comunity does not exist
    
    InvalidDocumentException - if any of the Document objects to be returned is invalid
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForCommunityForUserPaging
```
ResultPage getFeaturedDocumentsForCommunityForUserPaging(java.lang.Long communityId_,
                                                         int startIndex_,
                                                         int batchSize_,
                                                         java.lang.Integer sortProperty_,
                                                         java.lang.Integer sortOrder_)
                                                  throws InvalidUserException,
                                                         InvalidCommunityException,
                                                         InvalidDocumentException
```
    Deprecated.
    
    Retrieves the featured Document objects for a given Community and its subcommunities that the current User can access. Users will only be able to see those Document objects to which they have at least read-only access.
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This will be one of the SORT_DOCUMENT_PROPERTY_XXX constants in DocumentService
    
    sortOrder_ - This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing the list of Document objects representing the featured documents for this Community and its subcommunities that the current User can access.
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the Document objects to be returned is invalid
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForTopLevelCommunity
```
@Deprecated
Document[] getFeaturedDocumentsForTopLevelCommunity(java.lang.Long communityId_)
                                                         throws InvalidCommunityException,
                                                                InvalidDocumentException
```
    Deprecated. use getFeaturedDocumentsForTopLevelCommunityPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the featured documents for a given Community (but not its subcommunities)
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    Returns:
    
    An array of Document objects representing the featured Document objects for this Community
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the featured Document objects to be returned does not exist
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForTopLevelCommunityPaging
```
ResultPage getFeaturedDocumentsForTopLevelCommunityPaging(java.lang.Long communityId_,
                                                          int startIndex_,
                                                          int batchSize_,
                                                          java.lang.Integer sortProperty_,
                                                          java.lang.Integer sortOrder_)
                                                   throws InvalidCommunityException,
                                                          InvalidDocumentException
```
    Deprecated.
    
    Retrieves the featured documents for a given Community (but not its subcommunities)
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This will be one of the SORT_DOCUMENT_PROPERTY_XXX constants in DocumentService
    
    sortOrder_ - The order in which to sort the Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    a ResultPage containing an array of Document objects representing the featured Document objects for this Community
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the featured Document objects to be returned does not exist
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForTopLevelCommunityForUser
```
@Deprecated
Document[] getFeaturedDocumentsForTopLevelCommunityForUser(java.lang.Long communityId_)
                                                                throws InvalidUserException,
                                                                       InvalidCommunityException,
                                                                       InvalidDocumentException
```
    Deprecated. use getFeaturedDocumentsForTopLevelCommunityForUserPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer) instead
    
    Retrieves the featured documents for a given Community (but not its subcommunities) that the current user can access. Users will only be able to see those Document objects to which they have at least read-only access.
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    Returns:
    
    An array of Document objects representing the featured documents for this Community that the current user can access
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Comunity does not exist
    
    InvalidDocumentException - if any of the Document objects to be returned is invalid
    
    ServiceException - if any system-level error occurs
  - getFeaturedDocumentsForTopLevelCommunityForUserPaging
```
ResultPage getFeaturedDocumentsForTopLevelCommunityForUserPaging(java.lang.Long communityId_,
                                                                 int startIndex_,
                                                                 int batchSize_,
                                                                 java.lang.Integer sortProperty_,
                                                                 java.lang.Integer sortOrder_)
                                                          throws InvalidUserException,
                                                                 InvalidCommunityException,
                                                                 InvalidDocumentException
```
    Deprecated.
    
    Retrieves the featured Document objects for a given Community (but not its subcommunities) that the current user can access. Users will only be able to see those Document objects to which they have at least read-only access.
    
    Parameters:
    
    communityId_ - the unique ID for a Community
    
    startIndex_ - The index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - The number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This will be one of the SORT_DOCUMENT_PROPERTY_XXX constants in DocumentService
    
    sortOrder_ - This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    A ResultPage containing the list of Document objects representing the featured documents for this Community that the current User can access
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidDocumentException - if any of the Document objects to be returned is invalid
    
    ServiceException - if any system-level error occurs
  - setFeaturedDocumentForCommunity
```
void setFeaturedDocumentForCommunity(java.lang.Long documentId_)
                              throws InvalidCommunityException,
                                     InvalidDocumentException
```
    Deprecated.
    
    Set a Document to be 'featured' for the Community in which the Document currently resides.
    
    Parameters:
    
    documentId_ - the unique ID for a Document
    
    Throws:
    
    InvalidCommunityException - if the Community in which the Document resides is invalid
    
    InvalidDocumentException - if the Document is invalid
    
    ServiceException - if any system-level error occurs
  - setFeaturedDocumentsForCommunity
```
void setFeaturedDocumentsForCommunity(java.lang.Long[] documentIds_)
                               throws InvalidCommunityException,
                                      InvalidDocumentException
```
    Deprecated.
    
    Set a list of Document objects to be 'featured' for the Community in which they currently reside
    
    Parameters:
    
    documentIds_ - An array of unique IDs for the Document objects
    
    Throws:
    
    InvalidCommunityException - if the Community in which any of the Document objects reside is invalid
    
    InvalidDocumentException - if any of the Document objects is invalid
    
    ServiceException - if any system-level error occurs
  - removeFeaturedDocumentFromCommunity
```
void removeFeaturedDocumentFromCommunity(java.lang.Long documentId_)
                                  throws InvalidDocumentException,
                                         InvalidCommunityException
```
    Deprecated.
    
    Unfeature a Document for the Community in which it currently resides
    
    Parameters:
    
    documentId_ - the unique ID of the Document
    
    Throws:
    
    InvalidDocumentException - if the Document does not exist
    
    InvalidCommuntyException - if the Community which contains the Document does not exist
    
    ServiceException - if any system-level error occurs
    
    InvalidCommunityException
  - removeFeaturedDocumentsFromCommunity
```
void removeFeaturedDocumentsFromCommunity(java.lang.Long[] documentIds_)
                                   throws InvalidDocumentException,
                                          InvalidCommunityException
```
    Deprecated.
    
    Unfeature a list of Document objects for the Community in which they currently reside
    
    Parameters:
    
    documentIds_ - An array of unique IDs for the Document objects
    
    Throws:
    
    InvalidDocumentException - if any of the Document objects does not exist
    
    InvalidCommuntyException - if the Community which contains any of the Document objects does not exist
    
    ServiceException - if any system-level error occurs
    
    InvalidCommunityException
  - getInheritedAdministrators
```
java.lang.String[] getInheritedAdministrators(java.lang.Long communityId_)
                                       throws InvalidCommunityException
```
    Deprecated.
    
    Get the inherited administrators for a Community. Community.getAdministrators() does not return inherited administrators
    
    Parameters:
    
    communityId_ - the unique ID for the Community
    
    Returns:
    
    An array of usernames representing the inherited administrators for the Community
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    ServiceException - if any system-level error occurs
  - getInheritedAdministratorGroups
```
java.lang.Long[] getInheritedAdministratorGroups(java.lang.Long communityId_)
                                          throws InvalidCommunityException
```
    Deprecated.
    
    Get the inherited administrator groups for a Community. Community.getAdministratorGroups() does not return inherited group administrators
    
    Parameters:
    
    communityId_ - the unique ID for the Community
    
    Returns:
    
    An array of group IDs representing the inherited group administrators for the Community
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    ServiceException - if any system-level error occurs
  - reactivateCommunity
```
void reactivateCommunity(java.lang.Long communityId_)
                  throws InvalidCommunityException,
                         InvalidOperationException
```
    Deprecated.
    
    Reactivate a Community. NOTE: This method does not currently check whether the user has permission to reactivate the Community
    
    Parameters:
    
    communityId_ - the unique ID for the Community
    
    Throws:
    
    InvalidCommunityException - if the Community does not exist
    
    InvalidOperationException - if the Community has parent communities which are still inactive. These must be reactivated first.
    
    ServiceException - if any system-level error occurs
  - canUserAdministrateCommunity
```
boolean canUserAdministrateCommunity(java.lang.Long communityId_)
                              throws InvalidUserException,
                                     InvalidCommunityException
```
    Deprecated.
    
    Returns true if the current User is an administrator of the Community
    
    Parameters:
    
    communityId_ - the unique ID for the Community
    
    Returns:
    
    true if the current User is an administrator of the Community
    
    Throws:
    
    InvalidUserException - if the user does not exist
    
    InvalidCommunityException - if communityId_ does not correspond to a valid Community
    
    ServiceException - if any system-level error occurs
  - canGroupAdministrateCommunity
```
boolean canGroupAdministrateCommunity(java.lang.Long groupId_,
                                      java.lang.Long communityId_)
                               throws InvalidCommunityException
```
    Deprecated.
    
    Returns true if the specified Group is an administrator of the Community
    
    Parameters:
    
    groupId_ - the unique ID for the Group
    
    communityId_ - the unique ID for the Community
    
    Returns:
    
    true if the Group can administer the Community
    
    Throws:
    
    InvalidCommunityException - if communityId_ does not correspond to a valid Community
    
    ServiceException - if any system-level error occurs
  - getVisibleChildrenOfCommunity
```
java.lang.Integer[] getVisibleChildrenOfCommunity(java.lang.Long[] communityIds_)
                                           throws InvalidUserException,
                                                  InvalidKnowledgeCenterException,
                                                  InvalidCommunityException
```
    Deprecated.
    
    Retrieve visible children of a Community. This call is used to populate a Community object's children in a hierarchy.
    
    Parameters:
    
    communityIds_ - an array of unique ids which each correspond to a Community.
    
    Returns:
    
    an Integer array of children in each Community where 0=none, 1=community, 2=kc, 3=kc and community
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidKnowledgeCenterException - if any of the Community objects contains an invalid KnowledgeCenter
    
    InvalidCommunityException - if any of the Community objects is invalid
    
    ServiceException - if any system-level error occurs
  - getCommunitiesList
```
ResultList getCommunitiesList(java.lang.Long[] ids_)
                       throws InvalidUserException,
                              InvalidDataFormatException
```
    Deprecated.
    
    Get the Community objects by the requested IDs.
    
    Parameters:
    
    ids_ - IDs of Community objects to retrieve.
    
    Returns:
    
    ResultList containing an array of Community objects which correspond to the ids_ passed in.
    Also contains result codes for each ID. The result code will be one of CODE_XXX or COLLAB_CODE_XXX in ResultList.
    
    Throws:
    
    InvalidUserException - if the current user does not exist
    
    InvalidDataFormatException - if ids is null
  - searchCommunitiesPaging
```
ResultPage searchCommunitiesPaging(java.lang.String searchterm_,
                                   int startIndex_,
                                   int batchSize_,
                                   java.lang.Integer sortProperty_,
                                   java.lang.Integer sortOrder_)
                            throws InvalidUserException,
                                   InvalidCommunityException
```
    Deprecated.
    
    Get the Community objects whose names match searchterm_.
    
    Parameters:
    
    searchterm_ - a term for which to search in the names of communities
    
    startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
    
    batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.
    
    sortProperty_ - The property by which the results will be sorted. This is one of the Community.SORT_BY_XXX constants
    
    sortOrder_ - The order in which to sort the returned communities This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
    
    Returns:
    
    a list of Community
    
    Throws:
    
    InvalidUserException - if the current user does not exist
    
    InvalidCommunityException - if any of the communities is invalid
  - getSystemCommunityId
```
@Deprecated
java.lang.Long getSystemCommunityId(java.lang.String name_)
                                         throws InvalidCommunityException
```
    Deprecated. use ContentService.getIdByUuid(String) and getCommunityIdForContentId(Long)
    
    This is a small wrapper on Content's getSystemId, but returns the content id as a document id.
    
    Parameters:
    
    name - A case-insensitive system name.
    
    Returns:
    
    the id of the community mapped to that name.
    
    Throws:
    
    InvalidCommunityException - if the string is not recognized.
  - setSystemCommunityId
```
@Deprecated
void setSystemCommunityId(java.lang.String name_,
                                      java.lang.Long id_)
                               throws InvalidCommunityException
```
    Deprecated. use createCommunity(Community) with a pre-populated UUID
    
    Stores and associates the specified id value with the specified name key.
    
    Parameters:
    
    name - A case-insensitive system name.
    
    id - The community id.
    
    Throws:
    
    InvalidCommunityException - if the string is not recognized.
  - suggest
```
java.lang.String suggest(java.lang.String query_,
                         int maxItems_,
                         SuggestParam[] params_,
                         java.lang.Boolean groupResults_)
```
    Deprecated.
    
    Parameters:
    
    query -
    
    maxItems -
    
    params - list of information on what is being suggested and what format the results should be in. valid types are communities.
    
    groupResults - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.
    
    Returns:
    
    a JSON formatted string
  - suggest
```
java.lang.String suggest(java.lang.String query_,
                         int maxItems_,
                         SuggestParam[] params_,
                         java.lang.Boolean groupResults_,
                         java.lang.Long[] allowList)
```
    Deprecated.
    
    Parameters:
    
    query -
    
    maxItems -
    
    params - list of information on what is being suggested and what format the results should be in. valid types are communities.
    
    groupResults - if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.
    
    allowList - list of IDs that will be automatically added to returned results, filtered by query. Ignored if null or empty.
    
    Returns:
    
    a JSON formatted string
  - getContentIdForCommunityId
```
java.lang.Long getContentIdForCommunityId(java.lang.Long id_)
```
    Deprecated.
    
    Converts a community id into a content id. Note that the id can only be different for migrated KDB's existing prior AE 5.5 (previous Rules feature). Deployments after 5.5, the community id and the content id will be the same
    
    Parameters:
    
    id - The community id to convert
    
    Returns:
    
    The content id
  - getContentIdsForCommunityIds
```
java.lang.Long[] getContentIdsForCommunityIds(java.lang.Long[] ids_)
```
    Deprecated.
    
    Converts an array of community id's into an array of content id's. Note that the id can only be different for migrated KDB's existing prior AE 5.5 (previous Rules feature). Deployments after 5.5, the community id and the content id will be the same
    
    Parameters:
    
    id - The array of community ids to convert
    
    Returns:
    
    An array of content ids
  - getCommunityIdForContentId
```
java.lang.Long getCommunityIdForContentId(java.lang.Long id_)
```
    Deprecated.
    
    Converts a content id into a community id. Note that the id can only be different for migrated KDB's existing prior AE 5.5 (previous Rules feature). Deployments after 5.5, the community id and the content id will be the same
    
    Parameters:
    
    id - The content id to convert
    
    Returns:
    
    The community id
  - getCommunityIdsForContentIds
```
java.lang.Long[] getCommunityIdsForContentIds(java.lang.Long[] id_)
```
    Deprecated.
    
    Converts an array of content id's into an array of community id's. Note that the id can only be different for migrated KDB's existing prior AE 5.5 (previous Rules feature). Deployments after 5.5, the community id and the content id will be the same
    
    Parameters:
    
    id - The array of content ids to convert
    
    Returns:
    
    An array of community ids
  - getAccessLevelForCommunity
```
int getAccessLevelForCommunity(java.lang.Long cid_)
                        throws InvalidUserException,
                               InvalidCommunityException
```
    Deprecated.
    
    Retrieves the Access Level for a community
    
    Parameters:
    
    cid_ - the unique ID of the community
    
    Returns:
    
    int see Community for valid return values
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Comunity does not exist
  - getAccessLevelForCommunities
```
int[] getAccessLevelForCommunities(java.lang.Long[] cids_)
                            throws InvalidUserException,
                                   InvalidCommunityException
```
    Deprecated.
    
    Retrieves the Access Levels for a list of communities
    
    Parameters:
    
    cids_ - a list of unique IDs of the communities
    
    Returns:
    
    int[] see Community for valid return values
    
    Throws:
    
    InvalidUserException - if the User does not exist
    
    InvalidCommunityException - if the Comunity does not exist

Interface CommunityService

Field Summary

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

Method Summary

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

Field Detail

createCommunity$UPDATES

createCommunities$UPDATES

deleteCommunity$UPDATES

getCommunity$UPDATES

getCommunities$UPDATES

getCommunitiesPaging$UPDATES

getCommunitiesForUser$UPDATES

getCommunitiesForUserPaging$UPDATES

getAdministratableCommunitiesForUser$UPDATES

getAdministratableCommunitiesForUserPaging$UPDATES

getRootCommunities$UPDATES

getRootCommunitiesPaging$UPDATES

updateCommunity$UPDATES

updateCommunities$UPDATES

getInactiveCommunities$UPDATES

getInactiveCommunitiesPaging$UPDATES

getChildCommunities$UPDATES

getChildCommunitiesPaging$UPDATES

getChildKnowledgeCenters$UPDATES

getChildKnowledgeCentersPaging$UPDATES

isCommunityEmpty$UPDATES

getFavoriteCommunities$UPDATES

getFavoriteCommunitiesPaging$UPDATES

addCommunityToFavorites$UPDATES

addCommunitiesToFavorites$UPDATES

removeCommunityFromFavorites$UPDATES

removeCommunitiesFromFavorites$UPDATES

getFullTree$UPDATES

getFullTreePaging$UPDATES

setRoleMapForCommunity$UPDATES

getRoleMapForCommunity$UPDATES

getFeaturedDocumentsForCommunity$UPDATES

getFeaturedDocumentsForCommunityPaging$UPDATES

getFeaturedDocumentsForCommunityForUser$UPDATES

getFeaturedDocumentsForCommunityForUserPaging$UPDATES

getFeaturedDocumentsForTopLevelCommunity$UPDATES

getFeaturedDocumentsForTopLevelCommunityPaging$UPDATES

getFeaturedDocumentsForTopLevelCommunityForUser$UPDATES

getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATES

setFeaturedDocumentForCommunity$UPDATES

setFeaturedDocumentsForCommunity$UPDATES

removeFeaturedDocumentFromCommunity$UPDATES

removeFeaturedDocumentsFromCommunity$UPDATES

getInheritedAdministrators$UPDATES

getInheritedAdministratorGroups$UPDATES

reactivateCommunity$UPDATES

canUserAdministrateCommunity$UPDATES

canGroupAdministrateCommunity$UPDATES

getVisibleChildrenOfCommunity$UPDATES

getCommunitiesList$UPDATES

searchCommunitiesPaging$UPDATES

getSystemCommunityId$UPDATES

setSystemCommunityId$UPDATES

suggest$UPDATES

getContentIdForCommunityId$UPDATES

getContentIdsForCommunityIds$UPDATES

getCommunityIdForContentId$UPDATES

getCommunityIdsForContentIds$UPDATES

getAccessLevelForCommunity$UPDATES

getAccessLevelForCommunities$UPDATES

Method Detail

createCommunity

createCommunities

deleteCommunity

getCommunity

getCommunities

getCommunitiesPaging

getCommunitiesForUser

getCommunitiesForUserPaging

getAdministratableCommunitiesForUser

getAdministratableCommunitiesForUserPaging

getRootCommunities

getRootCommunitiesPaging

updateCommunity