Interface CommunityService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addCommunitiesToFavorites
(Long[] communityIds_) Deprecated.Adds multipleCommunity
objects to the user's list of favoritesvoid
addCommunityToFavorites
(Long communityId_) Deprecated.Adds aCommunity
to the user's list of favoritesboolean
canGroupAdministrateCommunity
(Long groupId_, Long communityId_) Deprecated.Returnstrue
if the specifiedGroup
is an administrator of theCommunity
boolean
canUserAdministrateCommunity
(Long communityId_) Deprecated.Long[]
createCommunities
(Community[] communities_) Deprecated.CreatesCommunity
objects in bulk in the collaboration applicationcreateCommunity
(Community community_) Deprecated.Creates a newCommunity
in the collaboration applicationvoid
deleteCommunity
(Long communityId_) Deprecated.Deletes the specifiedCommunity
int[]
getAccessLevelForCommunities
(Long[] cids_) Deprecated.Retrieves the Access Levels for a list of communitiesint
Deprecated.Retrieves the Access Level for a communityDeprecated.getAdministratableCommunitiesForUserPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list ofCommunity
objects of which the currentUser
is an administrator.getChildCommunities
(Long communityId_, Integer sortOrder_, String sortColumn_) Deprecated.getChildCommunitiesPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list ofCommunity
objects which are direct children of the specified parentCommunity
.getChildKnowledgeCenters
(Long communityId_, Integer sortOrder_, String sortColumn_) Deprecated.getChildKnowledgeCentersPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list ofKnowledgeCenter
objects which are direct children of the specified parentCommunity
NOTE: The returned list will be sorted first bysortProperty_
, and then by user status in the order:KnowledgeCenter.USER_STATUS_SUBSCRIBED
,KnowledgeCenter.USER_STATUS_PENDING
,KnowledgeCenter.USER_STATUS_UNSUBSCRIBED
getCommunities
(Long[] communityIds_) Deprecated.Deprecated.getCommunitiesForUserPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.getCommunitiesList
(Long[] ids_) Deprecated.Get theCommunity
objects by the requested IDs.getCommunitiesPaging
(Long[] communityIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves a list ofCommunity
objects from their IDsgetCommunity
(Long communityId_) Deprecated.Retrieves aCommunity
Deprecated.Converts a content id into a community id.Long[]
getCommunityIdsForContentIds
(Long[] id_) Deprecated.Converts an array of content id's into an array of community id's.Deprecated.Converts a community id into a content id.Long[]
getContentIdsForCommunityIds
(Long[] ids_) Deprecated.Converts an array of community id's into an array of content id's.getFavoriteCommunities
(Integer sortOrder_, String sortColumn_) Deprecated.getFavoriteCommunitiesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list ofCommunity
objects which have been tagged as favorites by the userDocument[]
getFeaturedDocumentsForCommunity
(Long communityId_) Document[]
getFeaturedDocumentsForCommunityForUser
(Long communityId_) getFeaturedDocumentsForCommunityForUserPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the featuredDocument
objects for a givenCommunity
and its subcommunities that the currentUser
can access.getFeaturedDocumentsForCommunityPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Document[]
getFeaturedDocumentsForTopLevelCommunity
(Long communityId_) Document[]
getFeaturedDocumentsForTopLevelCommunityForUser
(Long communityId_) getFeaturedDocumentsForTopLevelCommunityForUserPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.getFeaturedDocumentsForTopLevelCommunityPaging
(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the featured documents for a given Community (but not its subcommunities)MenuTree[]
Deprecated.Get a list ofMenuTree
objects for construction of the collaboration navigation treegetFullTreePaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get a list ofMenuTree
objects for construction of the collaboration navigation treeDeprecated.getInactiveCommunitiesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list of inactiveCommunity
objectsLong[]
getInheritedAdministratorGroups
(Long communityId_) Deprecated.Get the inherited administrator groups for aCommunity
.String[]
getInheritedAdministrators
(Long communityId_) Deprecated.Get the inherited administrators for aCommunity
.getRoleMapForCommunity
(Long communityId_) Deprecated.Retrieves theCollaborationRoleMap
object for a givenCommunity
Deprecated.getRootCommunitiesPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list ofCommunity
objects which are root communities NOTE: The returned list will be sorted first bysortProperty_
, and then by user status in the order:Community.USER_STATUS_SUBSCRIBED
,Community.USER_STATUS_PENDING
,Community.USER_STATUS_UNSUBSCRIBED
getSystemCommunityId
(String name_) Deprecated.Integer[]
getVisibleChildrenOfCommunity
(Long[] communityIds_) Deprecated.Retrieve visible children of aCommunity
.boolean
isCommunityEmpty
(Long communityId_) Deprecated.Checks whether a community contains children (sub-communities, knowledge centers, folders or documents).void
reactivateCommunity
(Long communityId_) Deprecated.Reactivate aCommunity
.void
removeCommunitiesFromFavorites
(Long[] communityIds_) Deprecated.Removes multipleCommunity
objects from the user's favorites listvoid
removeCommunityFromFavorites
(Long communityId_) Deprecated.Removes aCommunity
from the user's favorites listvoid
removeFeaturedDocumentFromCommunity
(Long documentId_) void
removeFeaturedDocumentsFromCommunity
(Long[] documentIds_) searchCommunitiesPaging
(String searchterm_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get theCommunity
objects whose names matchsearchterm_
.void
setFeaturedDocumentForCommunity
(Long documentId_) Deprecated.void
setFeaturedDocumentsForCommunity
(Long[] documentIds_) Deprecated.void
setRoleMapForCommunity
(Long communityId_, CollaborationRoleMap crm_) Deprecated.Set theCollaborationRoleMap
object for a givenCommunity
.void
setSystemCommunityId
(String name_, Long id_) Deprecated.usecreateCommunity(Community)
with a pre-populated UUIDsuggest
(String query_, int maxItems_, SuggestParam[] params_, Boolean groupResults_) Deprecated.suggest
(String query_, int maxItems_, SuggestParam[] params_, Boolean groupResults_, Long[] allowList) Deprecated.void
updateCommunities
(Community[] communities_) Deprecated.Updates the information stored about a list ofCommunity
objectsvoid
updateCommunity
(Community community_) Deprecated.Updates aCommunity
Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
createCommunity$UPDATES
static final boolean createCommunity$UPDATESDeprecated.- See Also:
-
createCommunities$UPDATES
static final boolean createCommunities$UPDATESDeprecated.- See Also:
-
deleteCommunity$UPDATES
static final boolean deleteCommunity$UPDATESDeprecated.- See Also:
-
getCommunity$UPDATES
static final boolean getCommunity$UPDATESDeprecated.- See Also:
-
getCommunities$UPDATES
static final boolean getCommunities$UPDATESDeprecated.- See Also:
-
getCommunitiesPaging$UPDATES
static final boolean getCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getCommunitiesForUser$UPDATES
static final boolean getCommunitiesForUser$UPDATESDeprecated.- See Also:
-
getCommunitiesForUserPaging$UPDATES
static final boolean getCommunitiesForUserPaging$UPDATESDeprecated.- See Also:
-
getAdministratableCommunitiesForUser$UPDATES
static final boolean getAdministratableCommunitiesForUser$UPDATESDeprecated.- See Also:
-
getAdministratableCommunitiesForUserPaging$UPDATES
static final boolean getAdministratableCommunitiesForUserPaging$UPDATESDeprecated.- See Also:
-
getRootCommunities$UPDATES
static final boolean getRootCommunities$UPDATESDeprecated.- See Also:
-
getRootCommunitiesPaging$UPDATES
static final boolean getRootCommunitiesPaging$UPDATESDeprecated.- See Also:
-
updateCommunity$UPDATES
static final boolean updateCommunity$UPDATESDeprecated.- See Also:
-
updateCommunities$UPDATES
static final boolean updateCommunities$UPDATESDeprecated.- See Also:
-
getInactiveCommunities$UPDATES
static final boolean getInactiveCommunities$UPDATESDeprecated.- See Also:
-
getInactiveCommunitiesPaging$UPDATES
static final boolean getInactiveCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getChildCommunities$UPDATES
static final boolean getChildCommunities$UPDATESDeprecated.- See Also:
-
getChildCommunitiesPaging$UPDATES
static final boolean getChildCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getChildKnowledgeCenters$UPDATES
static final boolean getChildKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getChildKnowledgeCentersPaging$UPDATES
static final boolean getChildKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
isCommunityEmpty$UPDATES
static final boolean isCommunityEmpty$UPDATESDeprecated.- See Also:
-
getFavoriteCommunities$UPDATES
static final boolean getFavoriteCommunities$UPDATESDeprecated.- See Also:
-
getFavoriteCommunitiesPaging$UPDATES
static final boolean getFavoriteCommunitiesPaging$UPDATESDeprecated.- See Also:
-
addCommunityToFavorites$UPDATES
static final boolean addCommunityToFavorites$UPDATESDeprecated.- See Also:
-
addCommunitiesToFavorites$UPDATES
static final boolean addCommunitiesToFavorites$UPDATESDeprecated.- See Also:
-
removeCommunityFromFavorites$UPDATES
static final boolean removeCommunityFromFavorites$UPDATESDeprecated.- See Also:
-
removeCommunitiesFromFavorites$UPDATES
static final boolean removeCommunitiesFromFavorites$UPDATESDeprecated.- See Also:
-
getFullTree$UPDATES
static final boolean getFullTree$UPDATESDeprecated.- See Also:
-
getFullTreePaging$UPDATES
static final boolean getFullTreePaging$UPDATESDeprecated.- See Also:
-
setRoleMapForCommunity$UPDATES
static final boolean setRoleMapForCommunity$UPDATESDeprecated.- See Also:
-
getRoleMapForCommunity$UPDATES
static final boolean getRoleMapForCommunity$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForCommunity$UPDATES
static final boolean getFeaturedDocumentsForCommunity$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForCommunityPaging$UPDATES
static final boolean getFeaturedDocumentsForCommunityPaging$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForCommunityForUser$UPDATES
static final boolean getFeaturedDocumentsForCommunityForUser$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForCommunityForUserPaging$UPDATES
static final boolean getFeaturedDocumentsForCommunityForUserPaging$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForTopLevelCommunity$UPDATES
static final boolean getFeaturedDocumentsForTopLevelCommunity$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForTopLevelCommunityPaging$UPDATES
static final boolean getFeaturedDocumentsForTopLevelCommunityPaging$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForTopLevelCommunityForUser$UPDATES
static final boolean getFeaturedDocumentsForTopLevelCommunityForUser$UPDATESDeprecated.- See Also:
-
getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATES
static final boolean getFeaturedDocumentsForTopLevelCommunityForUserPaging$UPDATESDeprecated.- See Also:
-
setFeaturedDocumentForCommunity$UPDATES
static final boolean setFeaturedDocumentForCommunity$UPDATESDeprecated.- See Also:
-
setFeaturedDocumentsForCommunity$UPDATES
static final boolean setFeaturedDocumentsForCommunity$UPDATESDeprecated.- See Also:
-
removeFeaturedDocumentFromCommunity$UPDATES
static final boolean removeFeaturedDocumentFromCommunity$UPDATESDeprecated.- See Also:
-
removeFeaturedDocumentsFromCommunity$UPDATES
static final boolean removeFeaturedDocumentsFromCommunity$UPDATESDeprecated.- See Also:
-
getInheritedAdministrators$UPDATES
static final boolean getInheritedAdministrators$UPDATESDeprecated.- See Also:
-
getInheritedAdministratorGroups$UPDATES
static final boolean getInheritedAdministratorGroups$UPDATESDeprecated.- See Also:
-
reactivateCommunity$UPDATES
static final boolean reactivateCommunity$UPDATESDeprecated.- See Also:
-
canUserAdministrateCommunity$UPDATES
static final boolean canUserAdministrateCommunity$UPDATESDeprecated.- See Also:
-
canGroupAdministrateCommunity$UPDATES
static final boolean canGroupAdministrateCommunity$UPDATESDeprecated.- See Also:
-
getVisibleChildrenOfCommunity$UPDATES
static final boolean getVisibleChildrenOfCommunity$UPDATESDeprecated.- See Also:
-
getCommunitiesList$UPDATES
static final boolean getCommunitiesList$UPDATESDeprecated.- See Also:
-
searchCommunitiesPaging$UPDATES
static final boolean searchCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getSystemCommunityId$UPDATES
static final boolean getSystemCommunityId$UPDATESDeprecated.- See Also:
-
setSystemCommunityId$UPDATES
static final boolean setSystemCommunityId$UPDATESDeprecated.- See Also:
-
suggest$UPDATES
static final boolean suggest$UPDATESDeprecated.- See Also:
-
getContentIdForCommunityId$UPDATES
static final boolean getContentIdForCommunityId$UPDATESDeprecated.- See Also:
-
getContentIdsForCommunityIds$UPDATES
static final boolean getContentIdsForCommunityIds$UPDATESDeprecated.- See Also:
-
getCommunityIdForContentId$UPDATES
static final boolean getCommunityIdForContentId$UPDATESDeprecated.- See Also:
-
getCommunityIdsForContentIds$UPDATES
static final boolean getCommunityIdsForContentIds$UPDATESDeprecated.- See Also:
-
getAccessLevelForCommunity$UPDATES
static final boolean getAccessLevelForCommunity$UPDATESDeprecated.- See Also:
-
getAccessLevelForCommunities$UPDATES
static final boolean getAccessLevelForCommunities$UPDATESDeprecated.- See Also:
-
-
Method Details
-
createCommunity
Deprecated.Creates a newCommunity
in the collaboration application- Parameters:
community_
- ACommunity
object which should contain all of the information required to create a validCommunity
. Minimum required fields:name
,description
- Returns:
- The unique ID of the newly created
Community
- Throws:
InvalidUserException
- if the current user does not existInvalidCommunityException
- if the parent ID of theCommunity
specifies aCommunity
that does not existServiceException
- if any system-level error occurs
-
createCommunities
Long[] createCommunities(Community[] communities_) throws InvalidUserException, InvalidCommunityException Deprecated.CreatesCommunity
objects in bulk in the collaboration application- Parameters:
communities_
- An array ofCommunity
objects, each of which should contain all of the information required to create a validCommunity
. Minimum required fields:name
,description
- Returns:
- The unique IDs of the newly created
Community
objects - Throws:
InvalidUserException
- if the current user does not existInvalidCommunityException
- if the parent ID of any of theCommunity
objects specifies aCommunity
that does not existServiceException
- if any system-level error occurs
-
deleteCommunity
Deprecated.Deletes the specifiedCommunity
- Parameters:
communityId_
- the unique ID of theCommunity
to be deleted- Throws:
InvalidCommunityException
- if noCommunity
exists with the unique IDcommunityId_
NotEmptyException
- if theCommunity
contains children (either otherCommunity
objects orKnowledgeCenter
objects) and therefore cannot be deleted.ServiceException
- if any system-level error occurs
-
getCommunity
Deprecated.Retrieves aCommunity
- Parameters:
communityId_
- The unique ID of theCommunity
to be retrieved- Returns:
- A
Community
object representing the community with unique IDcommunityId_
- Throws:
InvalidCommunityException
- if noCommunity
exists with the unique IDcommunityId_
.ServiceException
- if any system-level error occurs
-
getCommunities
Deprecated.Retrieves a list ofCommunity
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 incommunityIds_
- Throws:
InvalidCommunityException
- if any of the unique IDs incommunityIds_
is invalidServiceException
- if any system-level error occurs
-
getCommunitiesPaging
ResultPage getCommunitiesPaging(Long[] communityIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException Deprecated.Retrieves a list ofCommunity
objects from their IDs- Parameters:
communityIds_
- an array of unique IDs of the communities to be retrievedstartIndex_
- 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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofCommunity
objects representing the communities whose unique IDs are incommunityIds_
- Throws:
InvalidCommunityException
- if any of the unique IDs incommunityIds_
is invalidServiceException
- if any system-level error occurs.
-
getCommunitiesForUser
@Deprecated Community[] getCommunitiesForUser() throws InvalidUserException, InvalidCommunityExceptionDeprecated.Retrieves the list ofCommunity
objects which containDocument
objects to which the currentUser
has access. Users will only be able to see thoseDocument
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 theUser
does not existInvalidCommunityException
- if one or more of the communities returned no longer existServiceException
- if any system-level error occurs
-
getCommunitiesForUserPaging
ResultPage getCommunitiesForUserPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Deprecated.Retrieves the list ofCommunity
objects which containDocument
objects to which the currentUser
has access Users will only be able to see thoseDocument
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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofCommunity
objects representing the communities which contain documents to which the currentUser
has access - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if one or more of the communities returned no longer existServiceException
- if any system-level error occurs
-
getAdministratableCommunitiesForUser
@Deprecated Community[] getAdministratableCommunitiesForUser() throws InvalidUserException, InvalidCommunityExceptionDeprecated.Retrieves the list ofCommunity
objects of which the currentUser
is an administrator.- Returns:
- An array of
Community
objects representing the communities of which the currentUser
is an administrator. - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if one or more of the communities returned no longer existServiceException
- if any system-level error occurs.
-
getAdministratableCommunitiesForUserPaging
ResultPage getAdministratableCommunitiesForUserPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Deprecated.Retrieves the list ofCommunity
objects of which the currentUser
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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofCommunity
objects representing the communities of which the currentUser
is an administrator. - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if one or more of the communities returned no longer existServiceException
- if any system-level error occurs.
-
getRootCommunities
@Deprecated Community[] getRootCommunities() throws InvalidUserException, InvalidKnowledgeCenterException, InvalidCommunityExceptionDeprecated.Retrieves the list ofCommunity
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 existInvalidKnowledgeCenterException
- if any of the root communities to be returned contains an invalidKnowledgeCenter
InvalidCommunityException
- if any of the communities does not existServiceException
- if any system-level error occurs
-
getRootCommunitiesPaging
ResultPage getRootCommunitiesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidCommunityException Deprecated.Retrieves the list ofCommunity
objects which are root communities NOTE: The returned list will be sorted first bysortProperty_
, 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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofCommunity
objects representing the communities which are root communities. - Throws:
InvalidUserException
- if the user does not existInvalidKnowledgeCenterException
- if any of the root communities to be returned contains an invalidKnowledgeCenter
InvalidCommunityException
- if any of the comunities does not existServiceException
- if any system-level error occurs
-
updateCommunity
void updateCommunity(Community community_) throws InvalidCommunityException, RecursiveRelationshipException Deprecated.Updates aCommunity
- Parameters:
community_
- ACommunity
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 existRecursiveRelationshipException
- if the parent ID of the community is the same as the ID of the communityServiceException
- if any system-level error occurs
-
updateCommunities
void updateCommunities(Community[] communities_) throws InvalidCommunityException, RecursiveRelationshipException Deprecated.Updates the information stored about a list ofCommunity
objects- Parameters:
communities_
- a list ofCommunity
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 incommunities_
is invalid or does not existRecursiveRelationshipException
- if the parent ID of any of the communities is the same as the ID for that communityServiceException
- if any system-level error occurs
-
getInactiveCommunities
Deprecated.Retrieves the list of inactiveCommunity
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_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the list of inactiveCommunity
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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofCommunity
objects representing all inactive communities - Throws:
ServiceException
- if any system-level error occurs
-
getChildCommunities
@Deprecated Community[] getChildCommunities(Long communityId_, Integer sortOrder_, String sortColumn_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Retrieves the list ofCommunity
objects which are direct children of the specified parentCommunity
. NOTE: The returned list will be sorted first bysortColumn_
, 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 parentCommunity
sortOrder_
- The order in which to sort the returned list of communities. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- The field of theCommunity
by which to sort the returned list of communities. This is one of theSORT_COLUMN_XXX
constants inCommunity
- Returns:
- An array of
Community
objects representing those communities which are direct children of the specified community - Throws:
InvalidUserException
- if the user does not existInvalidCommunityException
- if the comunity does not existInvalidKnowledgeCenterException
- if one or more of the comunities to be returned contains aKnowledgeCenter
which does not existServiceException
- if any system-level error occurs
-
getChildCommunitiesPaging
ResultPage getChildCommunitiesPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Retrieves the list ofCommunity
objects which are direct children of the specified parentCommunity
. NOTE: The returned list will be sorted first bysortProperty_
, 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 parentCommunity
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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the results. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.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 existInvalidCommunityException
- if the comunity does not existInvalidKnowledgeCenterException
- if one or more of the comunities to be returned contains aKnowledgeCenter
which does not existServiceException
- if any system-level error occurs
-
getChildKnowledgeCenters
@Deprecated KnowledgeCenter[] getChildKnowledgeCenters(Long communityId_, Integer sortOrder_, String sortColumn_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidCommunityException Deprecated.Retrieves the list ofKnowledgeCenter
objects which are direct children of the specified parentCommunity
NOTE: The returned list will be sorted first bysortColumn_
, 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 communitysortOrder_
- the order in which to sort the returned list of knowledge centers. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- The field of theKnowledgeCenter
by which to sort the returned list of knowledge centers. This is one of theSORT_COLUMN_XXX
constants inKnowledgeCenter
.- Returns:
- a list of
KnowledgeCenter
objects representing those knowledge centers which are direct children of the community specified bycommunityId_
- Throws:
InvalidUserException
- if the user does not existInvalidKnowledgeCenterException
- if one or more of the knowledge centers to be returned does not existInvalidCommunityException
- of theCommunity
does not existServiceException
- if any system-level error occurs
-
getChildKnowledgeCentersPaging
ResultPage getChildKnowledgeCentersPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidCommunityException Deprecated.Retrieves the list ofKnowledgeCenter
objects which are direct children of the specified parentCommunity
NOTE: The returned list will be sorted first bysortProperty_
, 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 communitystartIndex_
- 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. UseConstants.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 theSORT_KNOWLEDGECENTER_PROPERTY_XXX
constants inKnowledgeCenterService
.sortOrder_
- The order in which to sort the returned communities This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.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 existInvalidKnowledgeCenterException
- if one or more of the knowledge centers to be returned does not existInvalidCommunityException
- if theCommunity
does not existServiceException
- if any system-level error occurs
-
isCommunityEmpty
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 bycommunityId_
is invalidServiceException
- if any system-level error occurs
-
getFavoriteCommunities
@Deprecated Community[] getFavoriteCommunities(Integer sortOrder_, String sortColumn_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Retrieves the list ofCommunity
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 eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the field of theCommunity
by which to sort the returned list of communities. This is one of theSORT_COLUMN_XXX
constants inCommunity
.- 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 existInvalidCommunityException
- if one or more of the comunities do not existInvalidKnowledgeCenterException
- if any of the communities to be returned contains an invalidKnowledgeCenter
ServiceException
- if any system-level error occurs
-
getFavoriteCommunitiesPaging
ResultPage getFavoriteCommunitiesPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Retrieves the list ofCommunity
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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the returned communities This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing the list ofCommunity
objects representing those communities which are in the user's list of favorite communities - Throws:
InvalidUserException
- if the user does not existInvalidCommunityException
- if one or more of the comunities do not existInvalidKnowledgeCenterException
- if any of the communities to be returned contains an invalidKnowledgeCenter
ServiceException
- if any system-level error occurs
-
addCommunityToFavorites
void addCommunityToFavorites(Long communityId_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Adds aCommunity
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 existInvalidCommunityException
- ifcommunityId_
does not correspond to a communityInvalidKnowledgeCenterException
- if the community to be added contains an invalidKnowledgeCenter
ServiceException
- if any system-level error occurs
-
addCommunitiesToFavorites
void addCommunitiesToFavorites(Long[] communityIds_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException, InvalidDataFormatException Deprecated.Adds multipleCommunity
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 existInvalidCommunityException
- if one or more of the unique IDs incommunityIds_
does not correspond to a communityInvalidKnowledgeCenterException
- if any of the communities to be added contains an invalidKnowledgeCenter
InvalidDataFormatException
- if communityIds_ is nullServiceException
- if any system-level error occurs
-
removeCommunityFromFavorites
void removeCommunityFromFavorites(Long communityId_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException Deprecated.Removes aCommunity
from the user's favorites list- Parameters:
communityId_
- the unique ID of the community to be removed- Throws:
InvalidUserException
- if the user does not existInvalidCommunityException
- if the community does not existInvalidKnowledgeCenterException
- if the community to be removed contains an invalidKnowledgeCenter
ServiceException
- if any system-level error occurs
-
removeCommunitiesFromFavorites
void removeCommunitiesFromFavorites(Long[] communityIds_) throws InvalidUserException, InvalidCommunityException, InvalidKnowledgeCenterException, InvalidDataFormatException Deprecated.Removes multipleCommunity
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 existInvalidCommunityException
- if one or more of the unique IDs incommunityIds_
does not existInvalidKnowledgeCenterException
- if any of the communities to be removed contains an invalidKnowledgeCenter
InvalidDataFormatException
- if communityIds_ is nullServiceException
- if any system-level error occurs
-
getFullTree
Deprecated.Get a list ofMenuTree
objects for construction of the collaboration navigation tree- Returns:
- An array of
MenuTree
objects - Throws:
InvalidUserException
- if the user does not existInvalidKnowledgeCenterException
- if one or more of theKnowledgeCenter
objects represented by theMenuTree
object does not existServiceException
- if any system-level error occurs
-
getFullTreePaging
ResultPage getFullTreePaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Get a list ofMenuTree
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. UseConstants.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 theSORT_MENUTREE_PROPERTY_XXX
constantssortOrder_
- The order in which to sort theMenuTree
This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing an array ofMenuTree
objects - Throws:
InvalidUserException
- if the user does not existInvalidKnowledgeCenterException
- if one or more of theKnowledgeCenter
objects represented by theMenuTree
object does not existServiceException
- if any system-level error occurs
-
setRoleMapForCommunity
void setRoleMapForCommunity(Long communityId_, CollaborationRoleMap crm_) throws InvalidUserException, InvalidCommunityException, PrivilegeException Deprecated.Set theCollaborationRoleMap
object for a givenCommunity
. 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 theCommunity
is insufficient).- Parameters:
communityId_
- the unique ID for aCommunity
crm_
- TheCollaborationRoleMap
object which contains the users and groups in each role to set (overwrite)- Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if theCommunity
does not existPrivilegeException
- if theUser
does not have the rights to set the rolemapServiceException
- if any system-level error occurs
-
getRoleMapForCommunity
Deprecated.Retrieves theCollaborationRoleMap
object for a givenCommunity
- Parameters:
communityId_
- The unique ID for aCommunity
- Returns:
CollaborationRoleMap
object which contains the users and groups in each role- Throws:
ServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForCommunity
@Deprecated Document[] getFeaturedDocumentsForCommunity(Long communityId_) throws InvalidCommunityException, InvalidDocumentException, PrivilegeException Deprecated.- Parameters:
communityId_
- the unique ID for aCommunity
- Returns:
- An array of
Document
objects representing the featuredDocument
objects for thisCommunity
(and its subcommunities) - Throws:
InvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of the featuredDocument
objects to be returned does not existServiceException
- if any system-level error occursPrivilegeException
-
getFeaturedDocumentsForCommunityPaging
ResultPage getFeaturedDocumentsForCommunityPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException, InvalidDocumentException Deprecated.- Parameters:
communityId_
- the unique ID for aCommunity
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. UseConstants.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 theSORT_DOCUMENT_PROPERTY_XXX
constants inDocumentService
sortOrder_
- The order in which to sort theDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing an array of
Document
objects representing the featuredDocument
objects for thisCommunity
(and its subcommunities) - Throws:
InvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of the featuredDocument
objects to be returned does not existServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForCommunityForUser
@Deprecated Document[] getFeaturedDocumentsForCommunityForUser(Long communityId_) throws InvalidUserException, InvalidCommunityException, InvalidDocumentException Deprecated.Retrieves the featuredDocument
objects for a givenCommunity
and its subcommunities that the currentUser
can access. Users will only be able to see thoseDocument
objects to which they have at least read-only access.- Parameters:
communityId_
- the unique ID for aCommunity
- Returns:
- An array of
Document
objects representing the featured documents for thisCommunity
and its subcommunities that the current user can access - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if theComunity
does not existInvalidDocumentException
- if any of theDocument
objects to be returned is invalidServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForCommunityForUserPaging
ResultPage getFeaturedDocumentsForCommunityForUserPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException, InvalidDocumentException Deprecated.Retrieves the featuredDocument
objects for a givenCommunity
and its subcommunities that the currentUser
can access. Users will only be able to see thoseDocument
objects to which they have at least read-only access.- Parameters:
communityId_
- the unique ID for aCommunity
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. UseConstants.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 theSORT_DOCUMENT_PROPERTY_XXX
constants inDocumentService
sortOrder_
- This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing the list ofDocument
objects representing the featured documents for thisCommunity
and its subcommunities that the currentUser
can access. - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of theDocument
objects to be returned is invalidServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForTopLevelCommunity
@Deprecated Document[] getFeaturedDocumentsForTopLevelCommunity(Long communityId_) throws InvalidCommunityException, InvalidDocumentException Deprecated.Retrieves the featured documents for a givenCommunity
(but not its subcommunities)- Parameters:
communityId_
- the unique ID for aCommunity
- Returns:
- An array of
Document
objects representing the featuredDocument
objects for thisCommunity
- Throws:
InvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of the featuredDocument
objects to be returned does not existServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForTopLevelCommunityPaging
ResultPage getFeaturedDocumentsForTopLevelCommunityPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException, InvalidDocumentException Deprecated.Retrieves the featured documents for a given Community (but not its subcommunities)- Parameters:
communityId_
- the unique ID for aCommunity
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. UseConstants.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 theSORT_DOCUMENT_PROPERTY_XXX
constants inDocumentService
sortOrder_
- The order in which to sort theDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing an array of
Document
objects representing the featuredDocument
objects for thisCommunity
- Throws:
InvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of the featuredDocument
objects to be returned does not existServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForTopLevelCommunityForUser
@Deprecated Document[] getFeaturedDocumentsForTopLevelCommunityForUser(Long communityId_) throws InvalidUserException, InvalidCommunityException, InvalidDocumentException Deprecated.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 thoseDocument
objects to which they have at least read-only access.- Parameters:
communityId_
- the unique ID for aCommunity
- Returns:
- An array of
Document
objects representing the featured documents for thisCommunity
that the current user can access - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if theComunity
does not existInvalidDocumentException
- if any of theDocument
objects to be returned is invalidServiceException
- if any system-level error occurs
-
getFeaturedDocumentsForTopLevelCommunityForUserPaging
ResultPage getFeaturedDocumentsForTopLevelCommunityForUserPaging(Long communityId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException, InvalidDocumentException Deprecated.Retrieves the featuredDocument
objects for a givenCommunity
(but not its subcommunities) that the current user can access. Users will only be able to see thoseDocument
objects to which they have at least read-only access.- Parameters:
communityId_
- the unique ID for aCommunity
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. UseConstants.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 theSORT_DOCUMENT_PROPERTY_XXX
constants inDocumentService
sortOrder_
- This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- A
ResultPage
containing the list ofDocument
objects representing the featured documents for thisCommunity
that the currentUser
can access - Throws:
InvalidUserException
- if theUser
does not existInvalidCommunityException
- if theCommunity
does not existInvalidDocumentException
- if any of theDocument
objects to be returned is invalidServiceException
- if any system-level error occurs
-
setFeaturedDocumentForCommunity
void setFeaturedDocumentForCommunity(Long documentId_) throws InvalidCommunityException, InvalidDocumentException Deprecated.- Parameters:
documentId_
- the unique ID for aDocument
- Throws:
InvalidCommunityException
- if theCommunity
in which theDocument
resides is invalidInvalidDocumentException
- if theDocument
is invalidServiceException
- if any system-level error occurs
-
setFeaturedDocumentsForCommunity
void setFeaturedDocumentsForCommunity(Long[] documentIds_) throws InvalidCommunityException, InvalidDocumentException Deprecated.- Parameters:
documentIds_
- An array of unique IDs for theDocument
objects- Throws:
InvalidCommunityException
- if theCommunity
in which any of theDocument
objects reside is invalidInvalidDocumentException
- if any of theDocument
objects is invalidServiceException
- if any system-level error occurs
-
removeFeaturedDocumentFromCommunity
void removeFeaturedDocumentFromCommunity(Long documentId_) throws InvalidDocumentException, InvalidCommunityException Deprecated.- Parameters:
documentId_
- the unique ID of theDocument
- Throws:
InvalidDocumentException
- if theDocument
does not existInvalidCommuntyException
- if theCommunity
which contains theDocument
does not existServiceException
- if any system-level error occursInvalidCommunityException
-
removeFeaturedDocumentsFromCommunity
void removeFeaturedDocumentsFromCommunity(Long[] documentIds_) throws InvalidDocumentException, InvalidCommunityException Deprecated.- Parameters:
documentIds_
- An array of unique IDs for theDocument
objects- Throws:
InvalidDocumentException
- if any of theDocument
objects does not existInvalidCommuntyException
- if theCommunity
which contains any of theDocument
objects does not existServiceException
- if any system-level error occursInvalidCommunityException
-
getInheritedAdministrators
Deprecated.Get the inherited administrators for aCommunity
.Community.getAdministrators()
does not return inherited administrators- Parameters:
communityId_
- the unique ID for theCommunity
- Returns:
- An array of usernames representing the inherited administrators for
the
Community
- Throws:
InvalidCommunityException
- if theCommunity
does not existServiceException
- if any system-level error occurs
-
getInheritedAdministratorGroups
Deprecated.Get the inherited administrator groups for aCommunity
.Community.getAdministratorGroups()
does not return inherited group administrators- Parameters:
communityId_
- the unique ID for theCommunity
- Returns:
- An array of group IDs representing the inherited group
administrators for the
Community
- Throws:
InvalidCommunityException
- if theCommunity
does not existServiceException
- if any system-level error occurs
-
reactivateCommunity
void reactivateCommunity(Long communityId_) throws InvalidCommunityException, InvalidOperationException Deprecated.Reactivate aCommunity
. NOTE: This method does not currently check whether the user has permission to reactivate theCommunity
- Parameters:
communityId_
- the unique ID for theCommunity
- Throws:
InvalidCommunityException
- if theCommunity
does not existInvalidOperationException
- if theCommunity
has parent communities which are still inactive. These must be reactivated first.ServiceException
- if any system-level error occurs
-
canUserAdministrateCommunity
boolean canUserAdministrateCommunity(Long communityId_) throws InvalidUserException, InvalidCommunityException Deprecated.- Parameters:
communityId_
- the unique ID for theCommunity
- Returns:
true
if the currentUser
is an administrator of theCommunity
- Throws:
InvalidUserException
- if theuser
does not existInvalidCommunityException
- ifcommunityId_
does not correspond to a validCommunity
ServiceException
- if any system-level error occurs
-
canGroupAdministrateCommunity
boolean canGroupAdministrateCommunity(Long groupId_, Long communityId_) throws InvalidCommunityException Deprecated.Returnstrue
if the specifiedGroup
is an administrator of theCommunity
- Parameters:
groupId_
- the unique ID for theGroup
communityId_
- the unique ID for theCommunity
- Returns:
true
if theGroup
can administer theCommunity
- Throws:
InvalidCommunityException
- ifcommunityId_
does not correspond to a validCommunity
ServiceException
- if any system-level error occurs
-
getVisibleChildrenOfCommunity
Integer[] getVisibleChildrenOfCommunity(Long[] communityIds_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidCommunityException Deprecated.Retrieve visible children of aCommunity
. This call is used to populate aCommunity
object's children in a hierarchy.- Parameters:
communityIds_
- an array of unique ids which each correspond to aCommunity
.- Returns:
- an
Integer
array of children in eachCommunity
where 0=none, 1=community, 2=kc, 3=kc and community - Throws:
InvalidUserException
- if theUser
does not existInvalidKnowledgeCenterException
- if any of theCommunity
objects contains an invalidKnowledgeCenter
InvalidCommunityException
- if any of theCommunity
objects is invalidServiceException
- if any system-level error occurs
-
getCommunitiesList
Deprecated.Get theCommunity
objects by the requested IDs.- Parameters:
ids_
- IDs ofCommunity
objects to retrieve.- Returns:
- ResultList containing an array of
Community
objects which correspond to theids_
passed in.
Also contains result codes for each ID. The result code will be one ofCODE_XXX
orCOLLAB_CODE_XXX
inResultList
. - Throws:
InvalidUserException
- if the current user does not existInvalidDataFormatException
- if ids is null
-
searchCommunitiesPaging
ResultPage searchCommunitiesPaging(String searchterm_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidCommunityException Deprecated.Get theCommunity
objects whose names matchsearchterm_
.- Parameters:
searchterm_
- a term for which to search in the names of communitiesstartIndex_
- 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. UseConstants.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 theCommunity.SORT_BY_XXX
constantssortOrder_
- The order in which to sort the returned communities This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a list of
Community
- Throws:
InvalidUserException
- if the current user does not existInvalidCommunityException
- if any of the communities is invalid
-
getSystemCommunityId
Deprecated.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.usecreateCommunity(Community)
with a pre-populated UUIDStores and associates the specifiedid
value with the specifiedname
key.- Parameters:
name
- A case-insensitive system name.id
- The community id.- Throws:
InvalidCommunityException
- if the string is not recognized.
-
suggest
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
String suggest(String query_, int maxItems_, SuggestParam[] params_, Boolean groupResults_, 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
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
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
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
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
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 theUser
does not existInvalidCommunityException
- if theComunity
does not exist
-
getAccessLevelForCommunities
int[] getAccessLevelForCommunities(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 theUser
does not existInvalidCommunityException
- if theComunity
does not exist
-
ContentService
instead.