Package com.appiancorp.suiteapi.collaboration

Interface KnowledgeCenterService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface KnowledgeCenterService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
Use the class ContentService instead.
This interface provides services for other applications using methods related to collaboration knowledge centers

Knowledge centers may be private or public (see KnowledgeCenter.getType()). Public knowledge centers are those that are housed within collaboration Communitys; unless they are not searchable, they will be visible to any user who views their parent community. Private knowledge centers are not housed within communities, and so are not generally available to anyone who access the collaboration application.

Knowledge centers also have security settings attached to them. A knowledge center's searchability (see KnowledgeCenter.isIsSearchable()) determines whether the knowledge center will show up in user searches, and, similarly, whether a user who does not have access to the knowledge center will be able to see the knowledge center if he views the contents of the community that contains the knowledge center. Another knowledge center security setting determines whether changes to the knowledge center (creation or deletion of folders, documents and document versions) require the approval of one of the knowledge center administrators, or whether these changes can be posted without approval (see KnowledgeCenter.isChangesRequireApproval()). The final security setting determines whether users who apply for access to a knowledge center are automatically approved for read-only access, or whether their access request must be viewed and approved by one of the knowledge center administrators (see KnowledgeCenter.isAutoApproveForReadOnlyAccess()).

The role map of a knowledge center determines which users and groups have access to the knowledge center, and the level of access (permissions) that these users and groups possess. The access levels are administrator, editor and read-only. Readers may only view material but may not add new content; editors may view material and also add content; administrators have full control over the knowledge center, which enables them to, among other things, delete the knowledge center, change security settings and approve access requests (see KnowledgeCenter.getAccessLevel()).

Users may choose to "subscribe" to a knowledge center. In so doing, documents added to folders within the knowledge center will appear in the user's "New In Subscriptions" list. Note that a user may have access to a knowledge center without being subscribed to the knowledge center.

Knowledge centers house collaboration Folders. Folders may inherit permissions from their parent knowledge center, or may define permissions of their own.

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. The result code array is a parallel array of the passed in argument array.

See Also:

  • Field Details

    • createKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean createKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • createKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean createKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateExpirationDaysForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateExpirationDaysForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateExpirationDaysForKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateExpirationDaysForKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateForumForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateForumForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateForumForKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateForumForKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • moveKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean moveKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • moveKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean moveKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getWritableKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getWritableKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getWritableKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getWritableKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getWritableFoldersForKnowledgeCenterPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getWritableFoldersForKnowledgeCenterPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAdministratableKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAdministratableKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForGroup$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForGroup$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForGroupPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForGroupPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForGroups$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForGroups$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForGroupsPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForGroupsPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForCommunity$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForCommunity$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForCommunityPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForCommunityPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForCommunities$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForCommunities$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersForCommunitiesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersForCommunitiesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPersonalKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPersonalKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPersonalKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPersonalKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscribedKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscribedKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • subscribeKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean subscribeKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • subscribeKnowledgeCenterWithNote$UPDATES

      @Deprecated(forRemoval=true) static final boolean subscribeKnowledgeCenterWithNote$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • subscribeKnowledgeCentersWithNote$UPDATES

      @Deprecated(forRemoval=true) static final boolean subscribeKnowledgeCentersWithNote$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • subscribeKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean subscribeKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unsubscribeKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean unsubscribeKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • unsubscribeKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean unsubscribeKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSubscriptionRequests$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSubscriptionRequests$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • rejectSubscriptions$UPDATES

      @Deprecated(forRemoval=true) static final boolean rejectSubscriptions$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAllFoldersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAllFoldersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAllFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAllFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRootFolders$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRootFolders$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRootFoldersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRootFoldersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFoldersRequiringApproval$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFoldersRequiringApproval$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFoldersRequiringApprovalPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFoldersRequiringApprovalPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDocumentsRequiringApproval$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDocumentsRequiringApproval$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDocumentsRequiringApprovalPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDocumentsRequiringApprovalPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getVersionsRequiringApproval$UPDATES

      @Deprecated(forRemoval=true) static final boolean getVersionsRequiringApproval$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getVersionsRequiringApprovalPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getVersionsRequiringApprovalPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getExpiredDocuments$UPDATES

      @Deprecated(forRemoval=true) static final boolean getExpiredDocuments$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getExpiredDocumentsPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getExpiredDocumentsPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • notifyExpiredDocuments$UPDATES

      @Deprecated(forRemoval=true) static final boolean notifyExpiredDocuments$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • notifyExpiredDocumentsForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean notifyExpiredDocumentsForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • isKnowledgeCenterEmpty$UPDATES

      @Deprecated(forRemoval=true) static final boolean isKnowledgeCenterEmpty$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getParentCommunities$UPDATES

      @Deprecated(forRemoval=true) static final boolean getParentCommunities$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getParentCommunitiesPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getParentCommunitiesPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFavoriteKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFavoriteKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFavoriteKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFavoriteKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • addKnowledgeCenterToFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean addKnowledgeCenterToFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • addKnowledgeCentersToFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean addKnowledgeCentersToFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • removeKnowledgeCenterFromFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean removeKnowledgeCenterFromFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • removeKnowledgeCentersFromFavorites$UPDATES

      @Deprecated(forRemoval=true) static final boolean removeKnowledgeCentersFromFavorites$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getUserStatusForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean getUserStatusForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getUserStatusForKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getUserStatusForKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAccessLevelForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAccessLevelForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getAccessLevelForKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getAccessLevelForKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateRolesForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateRolesForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setRoleMapForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean setRoleMapForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getRoleMapForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean getRoleMapForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • browseKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean browseKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • browseKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean browseKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • addAdminToKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean addAdminToKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateKnowledgeCenterCreator$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateKnowledgeCenterCreator$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • searchKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean searchKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • searchKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean searchKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDescendantDocumentsOfKnowledgeCenterPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDescendantDocumentsOfKnowledgeCenterPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getDescendantDocumentsOfKnowledgeCentersPaging$UPDATES

      @Deprecated(forRemoval=true) static final boolean getDescendantDocumentsOfKnowledgeCentersPaging$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFolderTreeViewForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFolderTreeViewForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getFolderTreeViewForKnowledgeCenters$UPDATES

      @Deprecated(forRemoval=true) static final boolean getFolderTreeViewForKnowledgeCenters$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCentersList$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCentersList$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • doesPrivateKnowledgeCenterExist$UPDATES

      @Deprecated(forRemoval=true) static final boolean doesPrivateKnowledgeCenterExist$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • createPrivateKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean createPrivateKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getSystemKnowledgeCenterId$UPDATES

      @Deprecated(forRemoval=true) static final boolean getSystemKnowledgeCenterId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • setSystemKnowledgeCenterId$UPDATES

      @Deprecated(forRemoval=true) static final boolean setSystemKnowledgeCenterId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • suggest$UPDATES

      @Deprecated(forRemoval=true) static final boolean suggest$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • deleteStatisticsKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean deleteStatisticsKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getContentIdForKnowledgeCenterId$UPDATES

      @Deprecated(forRemoval=true) static final boolean getContentIdForKnowledgeCenterId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getContentIdsForKnowledgeCenterIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getContentIdsForKnowledgeCenterIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCenterIdForContentId$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCenterIdForContentId$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getKnowledgeCenterIdsForContentIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getKnowledgeCenterIdsForContentIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • updateIsSearchableForKnowledgeCenter$UPDATES

      @Deprecated(forRemoval=true) static final boolean updateIsSearchableForKnowledgeCenter$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • createKnowledgeCenter

      @Write(K_COLLAB) Long createKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidCommunityException
      Deprecated.
      Creates a new knowledge center
      Parameters:
      knowledgeCenter_ - a KnowledgeCenter object which should contain all of the information required to create a valid KnowledgeCenter. Minimum required fields: name, description, changesRequireApproval, searchable, autoApproveForReadOnlyAccess,type
      Returns:
      the unique ID of the newly created KnowledgeCenter
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      PrivilegeException - If the user does not have enough privileges to create a knowledge center under the specified CommunityId field.
      InvalidCommunityException - if this knowledge center is public, but the parent community ID specified does not correspond to a valid community
      ServiceException - if any system-level error occurs

    • createKnowledgeCenters

      @Write(K_COLLAB) Long[] createKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidCommunityException
      Deprecated.
      Creates multiple knowledge centers
      Parameters:
      knowledgeCenters_ - an array of KnowledgeCenter objects which should contain minimum information required to create a valid KnowledgeCenter. Minimum required fields: name, description, changesRequireApproval, searchable, autoApproveForReadOnlyAccess,type
      Returns:
      the unique IDs of the created knowledge centers
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      PrivilegeException - If the user does not have enough privileges to create any knowledge center under the specified CommunityId field.
      InvalidCommunityException - if any of the knowledge centers is public, but the parent community ID of the knowledge center does not correspond to a valid community
      ServiceException - if any system-level error occurs

    • updateKnowledgeCenter

      @Write(K_COLLAB) void updateKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Updates a knowledge center
      Parameters:
      knowledgeCenter_ - a KnowledgeCenter object which contains information to be updated. Minimum required fields: name, description, changesRequireApproval, isSearchable, autoApproveForReadOnlyAccess, id,creator.
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      PrivilegeException - if the User does not have rights to update the specified knowledge center
      InvalidKnowledgeCenterException - if the ID the knowledge center does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • updateKnowledgeCenters

      @Write(K_COLLAB) void updateKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Updates multiple knowledge centers
      Parameters:
      knowledgeCenters_ - a list of KnowledgeCenter objects which should contain minimum information required to update a KnowledgeCenter. Minimum required fields: name, description,changesRequireApproval, isSearchable, autoApproveForReadOnlyAccess, id, creator.
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      PrivilegeException - if the User does not have rights to update the specified knowledge centers
      InvalidKnowledgeCenterException - if the ID any of the knowledge centers does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • updateExpirationDaysForKnowledgeCenter

      @Write(K_COLLAB) void updateExpirationDaysForKnowledgeCenter(Long kcid_, Long days_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Updates the information about the number of days after which documents in the given knowledge center will expire
      Parameters:
      kcid_ - the unique ID of the knowledge center
      days_ - the number of days after which documents in the knowledge center will expire
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      PrivilegeException - if the User does not have rights to update the specified knowledge center
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs
      See Also:

    • updateExpirationDaysForKnowledgeCenters

      @Write(K_COLLAB) void updateExpirationDaysForKnowledgeCenters(Long[] kcids_, Long days_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Updates the information about the number of days after which documents in the given knowledge centers will expire
      Parameters:
      kcids_ - the uniques IDs of the knowledge centers
      days_ - the number of days after which documents in the knowledge centers will expire
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have rights to update the specified knowledge centers
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs
      See Also:

    • updateForumForKnowledgeCenter

      @Write(K_COLLAB) void updateForumForKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidKnowledgeCenterException
      Deprecated.
      Updates the forum associated with a knowledge center
      Parameters:
      knowledgeCenter_ - a KnowledgeCenter object which should contain all of the information required to update the Forum associated with KnowledeCenter. Minimum required fields: name, description,changesRequireApproval, isSearchable, autoApproveForReadOnlyAccess, id, forum. If Forum is set to null, this removes any forum associations.
      Throws:
      InvalidKnowledgeCenterException - if the ID of the knowledge center does not correspond a valid knowledge center
      ServiceException - if any system-level error occurs

    • updateForumForKnowledgeCenters

      @Write(K_COLLAB) void updateForumForKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidKnowledgeCenterException
      Deprecated.
      Updates the forums associated with knowledge centers
      Parameters:
      knowledgeCenters_ - a list of KnowledgeCenter objects containing all of the information required to update the Forums associated with the KnowledgeCenters. Minimum required fields: name, description, changesRequireApproval, isSearchable, autoApproveForReadOnlyAccess, id, forum. If Forum is set to null, this removes any forum associations.
      Throws:
      InvalidKnowledgeCenterException - if any of the IDs of the knowledge centers does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • deleteKnowledgeCenter

      @Write(K_COLLAB) void deleteKnowledgeCenter(Long kcid_) throws InvalidUserException, PrivilegeException, NotEmptyException, InvalidKnowledgeCenterException
      Deprecated.
      Deletes a given knowledge center. A knowledge center can only be deleted if it is empty (contains no folders).
      Parameters:
      kcid_ - the unique ID of the knowledge center to be deleted
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have rights to delete the specified knowledge center
      NotEmptyException - if the knowledge center contains folders
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • deleteKnowledgeCenters

      @Write(K_COLLAB) void deleteKnowledgeCenters(Long[] kcids_) throws InvalidUserException, PrivilegeException, NotEmptyException, InvalidKnowledgeCenterException
      Deprecated.
      Deletes knowledge centers. A knowledge center can only be deleted if it is empty (contains no folders).
      Parameters:
      kcids_ - an array of the unique IDs of the knowledge centers to be deleted.
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have rights to delete any of the specified knowledge centers
      NotEmptyException - if any of the the knowledge centers contains folders
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • moveKnowledgeCenter

      @Write(K_COLLAB) void moveKnowledgeCenter(Long kcid_, Long coid_) throws InvalidCommunityException, InvalidKnowledgeCenterException
      Deprecated.
      Moves the given knowledge center to the given community. This method will also update the Content Object to reflect the changes of Type and Quota. If the move succeeds, the KC will be updated to a Community KC.
      Parameters:
      kcid_ - the unique ID of the knowledge center to be moved
      coid_ - the unique ID of the community to which to move the knowledge center
      Throws:
      InvalidCommunityException - if the community ID does not correspond to a valid community
      InvalidKnowledgeCenterException - if the knowledge center ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • moveKnowledgeCenters

      @Write(K_COLLAB) void moveKnowledgeCenters(Long[] kcids_, Long coid_) throws InvalidCommunityException, InvalidKnowledgeCenterException
      Deprecated.
      Moves multiple knowledge centers to the given community. This method will also update the Content Object to reflect the changes of Type and Quota. If the move succeeds, the KCs will be updated to Community KCs.
      Parameters:
      kcids_ - an array containing the unique IDs of the knowledge centers to be moved
      coid_ - the unique ID of the community to which to move the knowledge center
      Throws:
      InvalidCommunityException - if the community ID does not correspond to a valid community
      InvalidKnowledgeCenterException - if any of the knowledge center IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getKnowledgeCenter

      @Read(K_COLLAB) KnowledgeCenter getKnowledgeCenter(Long kcid_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves the knowledge center with the given ID
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      the retrieved knowledge center
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have view privileges for this knowledge center
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getKnowledgeCenters(Long[] kcids_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      use getKnowledgeCentersPaging(Long[], int, int, Integer, Integer) instead
      Retrieves the knowledge centers with the given IDs
      Parameters:
      kcids_ - an array containing the unique IDs of the knowledge centers to be retrieved
      Returns:
      the retrieved knowledge centers
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have view privileges for any of the specified knowledge centers
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getKnowledgeCentersPaging(Long[] kcids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage contaning a list of the knowledge centers with the unique IDs specified
      Parameters:
      kcids_ - an array containing the unique IDs of the knowledge centers to be retrieved
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects for the specified IDs.
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      PrivilegeException - if the User does not have view privileges for any of knowledge center's returned
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getWritableKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getWritableKnowledgeCenters() throws InvalidUserException
      Deprecated.
      use getWritableKnowledgeCentersPaging(int, int, Integer, Integer) instead
      Retrieves the knowledge centers to which the current user has editor privileges or greater.
      Returns:
      an array of knowledge centers
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      ServiceException - if any system-level error occurs

    • getWritableKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getWritableKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Retrieves a ResultPage containing a list of the knowledge centers to which the current user has editor privileges or greater.
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter Objects.
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      ServiceException - if any system-level error occurs

    • getWritableFoldersForKnowledgeCenterPaging

      @Read(K_COLLAB) ResultPage getWritableFoldersForKnowledgeCenterPaging(Long kcId_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
      Deprecated.
      Retrieves a ResultPage containing a list of the Folder objects in the knowledge center with the given ID to which the current user has editor privileges or greater
      Parameters:
      kcId_ - the ID of the knowledge center
      startPosition_ - 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_BY_XXX constants in Folder.
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Folder objects.
      Throws:
      InvalidUserException - if the user making this call is an invalid user
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the User does not have view privileges to the specified knowledge center
      ServiceException - if any system-level error occurs

    • getAdministratableKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getAdministratableKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Retrieves a ResultPage containing a list of the knowledge centers to which the current user has administrator privileges, and to which the current user is subscribed
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForGroup

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getKnowledgeCentersForGroup(Long gid_)
      Deprecated.
      use getKnowledgeCentersForGroupPaging(Long, int, int, Integer, Integer) instead
      Retrieves the knowledge centers to which a given group has access
      Parameters:
      gid_ - the unique ID of the group
      Returns:
      a list of knowledge centers
      Throws:
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForGroupPaging

      @Read(K_COLLAB) ResultPage getKnowledgeCentersForGroupPaging(Long gid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Retrieves a ResultPage containing a list of knowledge centers to which a given group has access
      Parameters:
      gid_ - the unique ID of the group
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects.
      Throws:
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForGroups

      @Read(K_COLLAB) KnowledgeCenter[] getKnowledgeCentersForGroups(Long[] gids_)
      Deprecated.
      Retrieves the knowledge centers to which the specified groups have acccess NOTE: This method is expensive, and so its use should be limited; getKnowledgeCentersForGroupsPaging should be used instead.
      Parameters:
      gids_ - a list containing the unique IDs of the groups
      Returns:
      a list of knowledge centers to which the specified groups have access
      Throws:
      ServiceException - if any system-level error occurs deprecated use getKnowledgeCentersForGroupsPaging(Long[], int, int, Integer, Integer) instead

    • getKnowledgeCentersForGroupsPaging

      @Read(K_COLLAB) ResultPage getKnowledgeCentersForGroupsPaging(Long[] gids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_)
      Deprecated.
      Retrieves a ResultPage contaning a list of knowledge centers to which the specified groups have access
      Parameters:
      gids_ - an array containing the unique IDs of groups
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing the knowledge centers to which the specified groups have access
      Throws:
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForCommunity

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getKnowledgeCentersForCommunity(Long coid_) throws InvalidCommunityException
      Deprecated.
      use getKnowledgeCentersForCommunityPaging(Long, int, int, Integer, Integer) instead
      Retrieves the knowledge centers contained in the specified community
      Parameters:
      coid_ - the unique ID of the Community
      Returns:
      a list of knowledge centers contained within the community
      Throws:
      InvalidCommunityException - if the ID does not correspond to a valid community
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForCommunityPaging

      @Read(K_COLLAB) ResultPage getKnowledgeCentersForCommunityPaging(Long coid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException
      Deprecated.
      Retrieves a ResultPage containing the list of knowledge centers contained within a given community
      Parameters:
      coid_ - the unique ID of the community
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing the knowledge centers within a particular community
      Throws:
      InvalidCommunityException - if the ID does not correspond to a valid community
      ServiceException - if any system-level error occurs

    • getKnowledgeCentersForCommunities

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getKnowledgeCentersForCommunities(Long[] coids_) throws InvalidCommunityException
      Deprecated.
      use getKnowledgeCentersForCommunitiesPaging(Long[], int, int, Integer, Integer) instead
      Retrieves the knowledge centers contained within the given communities
      Parameters:
      coids_ - an array of unique community IDs
      Returns:
      a list of knowledge centers within the given communities
      Throws:
      InvalidComunityException - if any of the IDs does not correspond to a valid community
      ServiceException - if any system-level error occurs
      InvalidCommunityException

    • getKnowledgeCentersForCommunitiesPaging

      @Read(K_COLLAB) ResultPage getKnowledgeCentersForCommunitiesPaging(Long[] coids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException
      Deprecated.
      Retrieves a ResultPage containing a list of KnowledgeCenter objects for given Community IDs
      Parameters:
      coids_ - a list of unique Community IDs
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects representing the knowledge centers contained within the given communities
      Throws:
      InvalidCommunityException - if any of the IDs does not correspond to a valid community
      ServiceException - if any system-level error occurs

    • getPersonalKnowledgeCenters

      @Deprecated @Write(K_COLLAB) KnowledgeCenter[] getPersonalKnowledgeCenters() throws InvalidUserException
      Deprecated.
      use getPersonalKnowledgeCentersPaging(int, int, Integer, Integer) instead
      Retrieves the current user's private knowlege centers
      Returns:
      the current user's private knowledge centers
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • getPersonalKnowledgeCentersPaging

      @Write(K_COLLAB) ResultPage getPersonalKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Retrieves a ResultPage containing the current user's private knowledge centers
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing the current user's private knowledge centers.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • getSubscribedKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getSubscribedKnowledgeCenters() throws InvalidUserException
      Deprecated.
      use getSubscribedKnowledgeCentersPaging(int, int, Integer, Integer) instead
      Retrieves the knowledge centers to which the current user is subscribed
      Returns:
      the list of knowledge centers to which the current user is subscribed
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • getSubscribedKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getSubscribedKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Retrieves a ResultPage containing the list of knowledge centers to which the current user is subscribed
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing the knowledge centers to which the current user is subscribed.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • subscribeKnowledgeCenter

      @Write(K_COLLAB) String[][] subscribeKnowledgeCenter(Long kcid_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Subscribes the current user to a specified knowledge center. Returns an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an empty String array and the second index will be a String array of length 1 containing the name of the knowledge center corresponding to kcid_)
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of resulting subscribed knowledge center names
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not already have access to knowledge center and the knowledge center is not set for autoApprovalForReadOnlyAccess and the owner of knowledge center cannot administer the subscription request
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • subscribeKnowledgeCenterWithNote

      @Write(K_COLLAB) String[][] subscribeKnowledgeCenterWithNote(Long kcid_, String userNote_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Subscribes the current user to a specified knowledge center. If the subscription requires an approval from the administrator, he will receive a notification of the request along with the note given by the user. Returns an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an empty String array and the second index will be a String array of length 1 containing the name of the knowledge center corresponding to kcid_)
      Parameters:
      kcid_ - the unique ID of the knowledge center
      userNote_ - a note from the user regarding why he is requesting access
      Returns:
      an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of resulting subscribed knowledge center names
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not already have access to knowledge center and the knowledge center is not set for autoApprovalForReadOnlyAccess and the owner of knowledge center cannot administer the subscription request
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • subscribeKnowledgeCentersWithNote

      @Write(K_COLLAB) String[][] subscribeKnowledgeCentersWithNote(Long[] kcids_, String userNote_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Subscribes the current user to the specified knowledge centers. If the subscription requires an approval from the administrator, he will receive a notification of the request along with the note given by the user. Returns an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an empty String array and the second index will be a String array of length 1 containing the name of the knowledge center corresponding to kcid_)
      Parameters:
      kcids_ - array with the unique IDs of the knowledge centers.
      userNote_ - a note from the user regarding why he is requesting access
      Returns:
      an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of resulting subscribed knowledge center names
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not already have access to knowledge center and the knowledge center is not set for autoApprovalForReadOnlyAccess and the owner of knowledge center cannot administer the subscription request
      InvalidKnowledgeCenterException - if an ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • subscribeKnowledgeCenters

      @Write(K_COLLAB) String[][] subscribeKnowledgeCenters(Long[] kcids_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Subscribes the current user to multiple knowledge centers. Returns an array of length 2, the 1st index of which contains a String array of resulting pending knowledge center names and the second index of which is a String array of subscribed knowledge center names
      Parameters:
      kcids_ - an array containing the unique knowledge center IDs
      Returns:
      an array of length 2, the first index of which contains a String array of resulting pending knowledge center names and the 2nd index of which is a String array of subscribed knowledge center names
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not already have access to knowledge center and the knowledge center is not set for autoApprovalForReadOnlyAccess and the owner of knowledge center cannot administer the subscription request
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge
      ServiceException - if any system-level error occurs

    • unsubscribeKnowledgeCenter

      @Write(K_COLLAB) void unsubscribeKnowledgeCenter(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Unsubscribes the current user from the specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • unsubscribeKnowledgeCenters

      @Write(K_COLLAB) void unsubscribeKnowledgeCenters(Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Unsubscribes the current user from multiple knowledge centers
      Parameters:
      kcids_ - an array of unique knowledge center IDs
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getSubscriptionRequests

      @Read(K_COLLAB) String[] getSubscriptionRequests(Long kcid_)
      Deprecated.
      Retrieves all the requests for subscription to a specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      a list containing the usernames of the users who has requested subscription to the given knowledge center
      Throws:
      ServiceException - if any system-level error occurs

    • rejectSubscriptions

      @Write(K_COLLAB) void rejectSubscriptions(Long kcid_, String[] users_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Rejects subscriptions to a knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      users_ - a list containing the usernames of the users whose subscriptions (or subscription requests) to the given knowledge center are to be rejected
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not have rights to administer the specified knowledge center
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getAllFoldersPaging

      @Read(K_COLLAB) ResultPage getAllFoldersPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage containing all of the folders in a knowledge center (including the sub-folders of the direct child folders of the knowledge center)
      Parameters:
      kcid_ - the unique ID of the KnowledgeCenter
      startPosition_ - 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_BY_XXX constants in Folder.
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing Folder objects, representing all of the folders in the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getAllFolders

      @Deprecated @Read(K_COLLAB) Folder[] getAllFolders(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      use getAllFoldersPaging(Long, int, int, Integer, Integer) instead
      Retrieves all of the folders in a knowledge center (including the sub-folders of the direct child folders of the knowledge center)
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      a list of all folders within the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getRootFolders

      @Deprecated @Read(K_COLLAB) Folder[] getRootFolders(Long kcid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException, InvalidDocumentException, InvalidFolderException
      Deprecated.
      use getRootFoldersPaging(Long, int, int, Integer, Integer) instead
      Retrieves all of the folders that are the direct children of a given knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      sortColumn_ - the property by which the results will be sorted. This is one of the SORT_COLUMN_XXX constants in Folder.
      startIndex_ - the starting index of the first Folder to return
      scrollLength_ - the number of consecutive Folder objects to return after the first
      Returns:
      the list of root folders for the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not have view privileges for any of the folder's returned
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      InvalidDocumentException - if any of the child documents for root folders points to an invalid document
      InvalidFolderException - if any of the root folders or child folder of root folders points to an invalid folder
      ServiceException - if any system-level error occurs

    • getRootFoldersPaging

      @Read(K_COLLAB) ResultPage getRootFoldersPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage containing all of the folders that are the direct children of the given knowledge center
      Parameters:
      kcid_ - the unique ID of the KnowledgeCenter
      startPosition_ - the 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_BY_XXX constants in Folder.
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Folder objects, representing the root folders.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      PrivilegeException - if the User does not have rights to perform this operation.
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getFoldersRequiringApproval

      @Deprecated @Read(K_COLLAB) Folder[] getFoldersRequiringApproval(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      use getFoldersRequiringApprovalPaging(Long, int, int, Integer, Integer) instead
      Retrieves the folders requiring approval (for creation or deletion) for the given knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      the list of folders requiring approval for the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getFoldersRequiringApprovalPaging

      @Read(K_COLLAB) ResultPage getFoldersRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage containing a list of requiring approval (for creation or deletion) for the given knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      startPosition_ - 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_BY_XXX constants in Folder.
      sortOrder_ - the order in which to sort the returned Folder objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Folder objects, representing the folders tha require approval for the given knowledge center.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getDocumentsRequiringApproval

      @Deprecated @Read(K_COLLAB) Document[] getDocumentsRequiringApproval(Long kcid_) throws InvalidKnowledgeCenterException
      Deprecated.
      use getDocumentsRequiringApprovalPaging(Long, int, int, Integer, Integer) instead
      Retrieves the documents requiring approval (both for creation and deletion) for a given knowledge center
      Parameters:
      kcid_ - the unique ID of the KnowledgeCenter
      Returns:
      a list of documents requring approval for the knowledge center
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getDocumentsRequiringApprovalPaging

      @Read(K_COLLAB) ResultPage getDocumentsRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException
      Deprecated.
      Get a ResultPage containing the list of documents requiring approval (both for creation and deletion) for a knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      startPosition_ - 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_BY_XXX constants in Document.
      sortOrder_ - the order in which to sort the returned Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of documents requiring approval for the knowledge center
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getVersionsRequiringApproval

      @Deprecated @Read(K_COLLAB) Document[] getVersionsRequiringApproval(Long kcid_) throws InvalidKnowledgeCenterException
      Deprecated.
      use getVersionsRequiringApprovalPaging(Long, int, int, Integer, Integer) instead
      Get versions of documents requiring approval (both for creation and deletion) for a specified knowledge center
      Parameters:
      kcid_ - the unique ID of the KnowledgeCenter
      Returns:
      a list of documents representing versions that require approval for a knowledge center
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getVersionsRequiringApprovalPaging

      @Read(K_COLLAB) ResultPage getVersionsRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException
      Deprecated.
      Get a ResultPage contaning a list of document versions requiring approval (both for creation and deletion) for a specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      startPosition_ - 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_BY_XXX constants in Document.
      sortOrder_ - the order in which to sort the returned Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Document objects, representing the versions requiring approval for a knowledge center
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getExpiredDocuments

      @Deprecated @Read(K_COLLAB) Document[] getExpiredDocuments(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      use getExpiredDocumentsPaging(Long, int, int, Integer, Integer) instead
      Retrieves all expired documents for a knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      a list of expired documents for the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getExpiredDocumentsPaging

      @Read(K_COLLAB) ResultPage getExpiredDocumentsPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage containing a list of all expired documents in the specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      startPosition_ - 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_BY_XXX constants in Document.
      sortOrder_ - the order in which to sort the returned Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Document objects, representing the expired documents in the knowledge center.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • notifyExpiredDocuments

      @Write(K_COLLAB) void notifyExpiredDocuments(Double days, Boolean notifyCreator, Boolean notifyUsers, Boolean notifyGroups) throws InvalidUserException, PrivilegeException
      Deprecated.
      Send EXPIRING_FILES notifications for documents expiring within the next given number of days. This is the same list that appears with getExpiredDocuments, but from the root.
      Parameters:
      days - The number of days before a document expires. It is used as the criteria for selecting documents for which notifications should be sent. For example, if 14 is specified, notifications for expired documents and those expiring between now and 14 days from now will be sent. NOTE: it is not advisable to pass a value greater than the value set for the VIEW_EXPIRATION_DAYS_AHEAD property in server\_conf\collaboration.properties because the document reactivation user interface only shows documents that expire within the number of days specified by that property.
      notifyCreator - send notifications to creator of the kc
      notifyUsers - send notifications to users with admin rights over the kc
      notifyGroups - send notifications to groups with admin rights over the kc
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the User does not have rights to administer the content root
      ServiceException - if any system-level error occurs

    • notifyExpiredDocuments

      @Write(K_COLLAB) void notifyExpiredDocuments(Double[] days, Boolean notifyCreator, Boolean notifyUsers, Boolean notifyGroups) throws InvalidUserException, PrivilegeException
      Deprecated.
      Send EXPIRING_FILES notifications for documents expiring within the next given number of days. This is the same list that appears with getExpiredDocuments, but from the root.
      Parameters:
      days - The number of days before (negative) or after (positive) now in which a document expiring will be counted for purposes of this function. Only the first two (2) elements of the array are used. The range between the days is the range used.
      notifyCreator - send notifications to creator of the kc
      notifyUsers - send notifications to users with admin rights over the kc
      notifyGroups - send notifications to groups with admin rights over the kc
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the User does not have rights to administer the content root
      ServiceException - if any system-level error occurs

    • notifyExpiredDocumentsForKnowledgeCenter

      @Write(K_COLLAB) void notifyExpiredDocumentsForKnowledgeCenter(Long knowledgeCenterId, Double days, Boolean notifyCreator, Boolean notifyUsers, Boolean notifyGroups) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
      Deprecated.
      Send EXPIRING_FILES notifications for documents expiring within the next given number of days. This is the same list that appears with getExpiredDocuments, from the given knowledge center's children.
      Parameters:
      knowledgeCenterId - only send notifications for the given knowledge center id
      days - The number of days before a document expires. It is used as the criteria for selecting documents for which notifications should be sent. For example, if 14 is specified, notifications for expired documents and those expiring between now and 14 days from now will be sent. NOTE: it is not advisable to pass a value greater than the value set for the VIEW_EXPIRATION_DAYS_AHEAD property in server\_conf\collaboration.properties because the document reactivation user interface only shows documents that expire within the number of days specified by that property.
      notifyCreator - send notifications to creator of the kc
      notifyUsers - send notifications to users with admin rights over the kc
      notifyGroups - send notifications to groups with admin rights over the kc
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the User does not have rights to administer the specified knowledge center
      ServiceException - if any system-level error occurs

    • notifyExpiredDocumentsForKnowledgeCenter

      @Write(K_COLLAB) void notifyExpiredDocumentsForKnowledgeCenter(Long knowledgeCenterId, Double[] days, Boolean notifyCreator, Boolean notifyUsers, Boolean notifyGroups) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
      Deprecated.
      Send EXPIRING_FILES notifications for documents expiring within the next given number of days. This is the same list that appears with getExpiredDocuments, from the given knowledge center's children.
      Parameters:
      knowledgeCenterId - only send notifications for the given knowledge center id
      days - The number of days before (negative) or after (positive) now in which a document expiring will be counted for purposes of this function. Only the first two (2) elements of the array are used. The range between the days is the range used.
      notifyCreator - send notifications to creator of the kc
      notifyUsers - send notifications to users with admin rights over the kc
      notifyGroups - send notifications to groups with admin rights over the kc
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the User does not have rights to administer the specified knowledge center
      ServiceException - if any system-level error occurs

    • isKnowledgeCenterEmpty

      @Read(K_COLLAB) boolean isKnowledgeCenterEmpty(Long kcid_) throws InvalidKnowledgeCenterException
      Deprecated.
      Checks whether the specified knowledge center is empty (that is, whether it contains any folders)
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      true, if the knowledge center contains no folders; false otherwise.
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getParentCommunities

      @Deprecated @Read(K_COLLAB) Community[] getParentCommunities(Long kcid_) throws InvalidKnowledgeCenterException
      Deprecated.
      use getParentCommunitiesPaging(Long, int, int, Integer, Integer) instead
      Retrieves the parent communties of the specified knowledge center. If the knowledge center's direct parent community does not itself have any parents, the length of the returned array will be 1. If the knowledge center is private, the returned array will be zero-length.
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      a list of communities representing the parent communities
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getParentCommunitiesPaging

      @Read(K_COLLAB) ResultPage getParentCommunitiesPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException
      Deprecated.
      Retrieves a ResultPage containing a list of the communities which are the parents of a specified knowledge center. If the knowledge center's direct parent community does not itself have any parents, the length of the returned array will be 1. If the knowledge center is private, the returned array will be zero-length.
      Parameters:
      kcid_ - the unique ID of the knowledge center.
      startPosition_ - 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_BY_XXX constants in Community.
      sortOrder_ - the order in which to sort the returned Community objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of Community objects, representing the parent communities of this knowledge center.
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getFavoriteKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] getFavoriteKnowledgeCenters(Integer sortOrder_, String sortColumn_) throws InvalidUserException
      Deprecated.
      use getFavoriteKnowledgeCentersPaging(int, int, Integer, Integer) instead
      Retrieves knowledge centers which the current user has added to their "Favorites" list
      Parameters:
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      sortColumn_ - the property by which the results will be sorted. This is one of the SORT_COLUMN_XXX constants in KnowledgeCenter.
      Returns:
      the list of favorite knowledge centers
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      ServiceException - if any system-level error occurs

    • getFavoriteKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getFavoriteKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Retrieves a ResultPage containing the knowledge centers which the current user has added to their "Favorites" list
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing the current user's favorite knowledge centers
      Throws:
      InvalidUserException - if the user making this call is an invalid user.
      ServiceException - if any system-level error occurs

    • addKnowledgeCenterToFavorites

      @Write(K_COLLAB) void addKnowledgeCenterToFavorites(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Adds a knowledge center to the current user's "Favorites" list
      Parameters:
      kcid_ - the unique ID for the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • addKnowledgeCentersToFavorites

      @Write(K_COLLAB) void addKnowledgeCentersToFavorites(Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidDataFormatException
      Deprecated.
      Adds multiple knowledge centers to the current user's "Favorites" list
      Parameters:
      kcids_ - a list containing the unique IDs of the knowledge centers
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs
      InvalidDataFormatException

    • removeKnowledgeCenterFromFavorites

      @Write(K_COLLAB) void removeKnowledgeCenterFromFavorites(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Removes a knowledge center from the current user's "Favorites" list
      Parameters:
      kcid_ - the unique ID for the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • removeKnowledgeCentersFromFavorites

      @Write(K_COLLAB) void removeKnowledgeCentersFromFavorites(Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidDataFormatException
      Deprecated.
      Removes multiple knowledge centers from the current user's "Favorites" list
      Parameters:
      kcids_ - a list containing the unique IDs of the knowledge centers
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs
      InvalidDataFormatException

    • getUserStatusForKnowledgeCenter

      @Read(K_COLLAB) Long getUserStatusForKnowledgeCenter(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves the current user's subscription status (pending, subscribed or unsubscribed) for the specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      the status of the current user for the knowledge center. This is one of the USER_STATUS_XXX constants in KnowledgeCenter
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getUserStatusForKnowledgeCenters

      @Read(K_COLLAB) Long[] getUserStatusForKnowledgeCenters(Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves the current user's subscription status (pending, subscribed or unsubscribed) for the specified knowledge centers
      Parameters:
      kcids_ - a list containing the unique IDs of the knowledge centers
      Returns:
      the status of the current user for the knowledge centers. Each status is one of the USER_STATUS_XXX constants in KnowledgeCenter
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getAccessLevelForKnowledgeCenter

      @Read(K_COLLAB) int getAccessLevelForKnowledgeCenter(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves the access level of the current user to the specified knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      the current user's access level to the knowledge center. This is one of the ACCESS_LEVEL_XXX constants in KnowledgeCenter
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getAccessLevelForKnowledgeCenters

      @Read(K_COLLAB) int[] getAccessLevelForKnowledgeCenters(Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Retrieves the access level of the current user to the specified knowledge center
      Parameters:
      kcids_ - the unique IDs of the knowledge centers
      Returns:
      access levels of the current user to the knowledge centers. Each access level is one of the ACCESS_LEVEL_XXX constants in KnowledgeCenter
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center

    • updateRolesForKnowledgeCenter

      @Write(K_COLLAB) void updateRolesForKnowledgeCenter(Long kcid_, String[] users_, int[] roles_, String[] notes_, Long[] groups_, int[] groupRoles_, String[] groupNotes_) throws InvalidUserException, InvalidKnowledgeCenterException, com.appiancorp.kougar.mapper.exceptions.ParameterException, PrivilegeException
      Deprecated.
      Updates the role of the pending access users.
      Parameters:
      kcid_ - the unique ID of the knowledge center
      users_ - the list of users to update access
      roles_ - the list of access for users KnowledgeCenter.[ACCESS_LEVEL_ONLY | ACCESS_LEVEL_WRITE | ACESS_LEVEL_ADMINISTRATIVE | ACCESS_LEVEL_NO_ACCESS]
      notes_ - the list of notes from the admin to the user regarding their new access level
      groups_ - The list of groups to update access
      groupRoles_ - the list of access for groups KnowledgeCenter.[ACCESS_LEVEL_ONLY | ACCESS_LEVEL_WRITE | ACESS_LEVEL_ADMINISTRATIVE | ACCESS_LEVEL_NO_ACCESS]
      groupNotes_ - the list of notes from the admin to the group regarding their new access level
      Throws:
      InvalidUserException - if the user calling this method is invalid
      com.appiancorp.kougar.mapper.exceptions.ParameterException - if the set of arrays (users_, roles_ and notes_ or groups_, groupRoles_ and groupNotes_) don't match in length.
      PrivilegeException - if the User does not already have access to knowledge center and the knowledge center is not set for autoApprovalForReadOnlyAccess and the owner of knowledge center cannot administer the subscription request
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center

    • setRoleMapForKnowledgeCenter

      @Write(K_COLLAB) void setRoleMapForKnowledgeCenter(Long kcid_, CollaborationRoleMap crm_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException, InvalidGroupException
      Deprecated.
      Sets the role map for a given knowledge center. It is necessary to set the role map for a knowledge center before any methods which require certain privileges can be called (simply setting the permissions through the KnowledgeCenter is insufficient.)
      Parameters:
      kcid_ - the unique ID of the knowledge center
      crm_ - a CollaborationRoleMap object that contains the permissions to be applied to this knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid, or if any username that is part of the role map does not correspond to a valid user
      PrivilegeException - if the User does not have rights to administer the specified knowledge center
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      InvalidGroupException - if any of the group IDs in the role map does not correspond to a valid group

    • getRoleMapForKnowledgeCenter

      @Read(K_COLLAB) CollaborationRoleMap getRoleMapForKnowledgeCenter(Long kcid_) throws InvalidKnowledgeCenterException, PrivilegeException
      Deprecated.
      Retrieves the role map for a given knowledge center
      Parameters:
      kcid_ - the unique ID of the knowledge center
      Returns:
      a CollaborationRoleMap object that contains the permissions for this knowledge center
      Throws:
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      PrivilegeException - if the user does not have enough privileges to access the KC

    • browseKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] browseKnowledgeCenters(int startIndex_, int scrollLength_) throws InvalidUserException
      Deprecated.
      use browseKnowledgeCentersPaging(int, int, Integer, Integer) instead
      Retrieves knowledge centers, each of which meets the following criteria:
      • The knowledge center is private
      • The knowledge center name is not "My Private Knowledge Center"
      • The current user is not subscribed to the knowledge center
      • The current user has access to the knowledge center via group only (that is, the current user is a member of a group that has access to the knowledge center, but the current user does not have explicit access to the knowledge center)
      Parameters:
      startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.
      scrollLength_ - the number of consecutive knowledge centers to return after the first
      Returns:
      the list of knowledge centers that meet the given criteria
      Throws:
      InvalidUserException - if the user calling this method is invalid

    • browseKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage browseKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Retrieves a ResultPage containing knowledge centers, each of which meets the following criteria:
      • The knowledge center is private
      • The knowledge center name is not "My Private Knowledge Center"
      • The current user is not subscribed to the knowledge center
      • The current user has access to the knowledge center via group only (that is, the current user is a member of a group that has access to the knowledge center, but the current user does not have explicit access to the knowledge center)
      Parameters:
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects that meet the given criteria
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • addAdminToKnowledgeCenter

      @Write(K_COLLAB) void addAdminToKnowledgeCenter(String username_, Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Make a user an administrator of a knowledge center
      Parameters:
      username_ - - the username of the user to be added as administrator of the knowledge center
      kcid_ - - the ID of the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid, or if the username does not correspond to a valid user
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • updateKnowledgeCenterCreator

      @Write(K_COLLAB) void updateKnowledgeCenterCreator(String username_, Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Changes the creator of the knowledge center to be the user with the specified username
      Parameters:
      username_ - the username of the user to designate as creator of the knowledge center
      kcid_ - the ID of the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • searchKnowledgeCenters

      @Deprecated @Read(K_COLLAB) KnowledgeCenter[] searchKnowledgeCenters(String searchTerm_, int startIndex_, int scrollLength_) throws InvalidUserException
      Deprecated.
      use searchKnowledgeCentersPaging instead
      Returns knowledge centers which have names matching given search term. The search finds all knowledge centers that have the matching string anywhere in the name of knowledge center. for eg: search for om* will return all knowledge centers whose name are some, myHome, ommm etc
      Parameters:
      searchTerm_ - the search query
      startIndex_ - the starting index of the first knowledge center to return
      scrollLength_ - the number of consecutive knowledge centers to return after the first
      Returns:
      an array of knowledge centers matching the search terms
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • searchKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage searchKnowledgeCentersPaging(String searchterm_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException
      Deprecated.
      Returns a ResultPage of knowledge centers which have names matching given search term. The search finds all knowledge centers that have the matching string anywhere in the name of knowledge center. for eg: search for om* will return all knowledge centers whose names are some, myHome, ommm etc
      Parameters:
      searchterm_ - the query string to match for knowledge center name
      startPosition_ - 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_BY_XXX constants in KnowledgeCenter.
      sortOrder_ - the order in which to sort the returned KnowledgeCenter objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing a list of KnowledgeCenter objects, representing knowledge centers that match the search terms.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      ServiceException - if any system-level error occurs

    • getDescendantDocumentsOfKnowledgeCenterPaging

      @Read(K_COLLAB) ResultPage getDescendantDocumentsOfKnowledgeCenterPaging(Long knowledgeCenterId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Get a ResultPage containing a list of all documents in a given knowledge center
      Parameters:
      knowledgeCenterId_ - the unique ID of the knowledge center
      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_BY_XXX constants in Document.
      sortOrder_ - the order in which to sort the returned Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING results in descending order
      Returns:
      a ResultPage containing the list of Document objects representing the document descendants of the knowledge center
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getDescendantDocumentsOfKnowledgeCentersPaging

      @Read(K_COLLAB) ResultPage getDescendantDocumentsOfKnowledgeCentersPaging(Long[] knowledgeCenterIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
      Deprecated.
      Get a ResultPage containing a list of all documents in a given list of knowledge centers
      Parameters:
      knowledgeCenterIds_ - a list of the unique IDs of the knowledge centers
      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_BY_XXX constants in Document.
      sortOrder_ - the order in which to sort the returned Document objects. This is either Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING
      Returns:
      a ResultPage containing the list of Document objects representing the document descendants of the given knowledge centers
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
      ServiceException - if any system-level error occurs

    • getFolderTreeViewForKnowledgeCenter

      @Read(K_COLLAB) TreePivot getFolderTreeViewForKnowledgeCenter(Long knowledgeCenterId_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, IllegalArgumentException
      Deprecated.
      Get a tree pivoted at a particular knowledge center. The children of the TreePivot will all be Folder objects for which the current user has the specified accessLevel_, or a greater access level. (Eg if accessLevel_ is KnowledgeCenter.ACCESS_LEVEL_READ_WRITE, all folders for which the current user has write access and also administrative access will be returned.) No Document objects will be returned as children of the TreePivot.
      Parameters:
      knowledgeCenterId_ - the ID of the knowledge center
      accessLevel_ - the accessLevel which the current user must have for the child folders of the knowledge center
      Returns:
      a TreePivot, pivoted at the specified knowledge center. The _subtree field of TreePivot points to TreeNode object which might be either KnowledgeCenter, Document, Folder or Community. * The Id field maps to the ID of objects mentioned above, name maps to object name and data maps to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY, TYPE_KNOWLEDGE_CENTER constants in ObjectTypeMapping. The _breadcrumbs field points to the path of the object from the root.
      Throws:
      InvalidUserException - if the user calling this method is invalid
      InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
      IllegalArgumentException - if accessLevel_ is not one of:
      • KnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE
      • KnowledgeCenter.ACCESS_LEVEL_READ_ONLY
      • KnowledgeCenter.ACCESS_LEVEL_READ_WRITE
        ServiceException - if any system-level error occurs

      • getFolderTreeViewForKnowledgeCenters

        @Read(K_COLLAB) TreePivot[] getFolderTreeViewForKnowledgeCenters(Long[] knowledgeCenterIds_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, IllegalArgumentException
        Deprecated.
        Get trees pivoted at particular knowledge centers. The children of the TreePivot objects will all be Folder objects for which the current user has the specified accessLevel_, or a greater access level. (Eg if accessLevel_ is KnowledgeCenter.ACCESS_LEVEL_READ_WRITE, all Folder objects for which the current user has write access and also administrative access will be returned.) No Document objects will be returned as children of the TreePivot objects.
        Parameters:
        knowledgeCenterIds_ - the IDs of the knowledge centers
        accessLevel_ - the accessLevel which the current user must have for the child folders of the knowledge centers
        Returns:
        a list of TreePivot objects, each pivoted at one of the specified knowledge centers. The _subtree field of each TreePivot points to TreeNode object which might be either KnowledgeCenter, Document, Folder or Community. * The Id field maps to the ID of objects mentioned above, name maps to object name and data maps to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY, TYPE_KNOWLEDGE_CENTER constants in ObjectTypeMapping. The _breadcrumbs field points to the path of the object from the root.
        Throws:
        InvalidUserException - if the user calling this method is invalid
        InvalidKnowledgeCenterException - if any of the IDs does not correspond to a valid knowledge center
        IllegalArgumentException - if accessLevel_ is not one of:
        • KnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE
        • KnowledgeCenter.ACCESS_LEVEL_READ_ONLY
        • KnowledgeCenter.ACCESS_LEVEL_READ_WRITE
          ServiceException - if any system-level error occurs

        • getKnowledgeCentersList

          @Read(K_COLLAB) ResultList getKnowledgeCentersList(Long[] ids_) throws InvalidUserException
          Deprecated.
          Returns a ResultList containing result codes for all given IDs and KnowledgeCenter objects for valid IDs
          Parameters:
          ids_ - the IDs of knowledge centers to retrieve
          Returns:
          ResultList containing KnowledgeCenter objects and result codes. Each result code will be one of the CODE_XXX or COLLAB_CODE_XXX constants in ResultList
          Throws:
          InvalidUserException - if the user calling this method is invalid
          ServiceException - if any system-level error occurs

        • doesPrivateKnowledgeCenterExist

          @Read(K_COLLAB) boolean doesPrivateKnowledgeCenterExist()
          Deprecated.
          Determine whether the current user has an existing private knowledge center. This will be the case if a private knowledge center was never created for the user, or if it has been deleted.
          Returns:
          true if a private knowledge center exists for the user; false otherwise.
          Throws:
          ServiceException - if any system-level error occurs

        • createPrivateKnowledgeCenter

          @Write(K_COLLAB) void createPrivateKnowledgeCenter()
          Deprecated.
          Create a private knowledge center for the current user. If the current user already has a private knowledge center, calling this method will do nothing.
          Throws:
          ServiceException - if any system-level error occurs

        • getSystemKnowledgeCenterId

          @Deprecated @Read(K_COLLAB) Long getSystemKnowledgeCenterId(String name) throws InvalidKnowledgeCenterException
          Deprecated.
          use ContentService.getIdByUuid(String) and getKnowledgeCenterIdForContentId(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:
          InvalidKnowledgeCenterException - if the string is not recognized

        • setSystemKnowledgeCenterId

          @Deprecated @Write(K_COLLAB) void setSystemKnowledgeCenterId(String name, Long id) throws InvalidKnowledgeCenterException
          Deprecated.
          use createKnowledgeCenter(KnowledgeCenter) 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 knowledge center id.
          Throws:
          InvalidKnowledgeCenterException - if the string is not recognized.

        • suggest

          @Read(K_COLLAB) String suggest(String query, int maxItems, SuggestParam[] params, 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 knowledge center.
          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

          @Read(K_COLLAB) 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 knowledge center.
          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

        • deleteStatisticsKnowledgeCenter

          @Read(K_COLLAB) @Write(value=K_COLLAB_STAT, indirectRouting=true) void deleteStatisticsKnowledgeCenter(Long kcid) throws InvalidKnowledgeCenterException
          Deprecated.
          Deletes the individual download statistics related to a given knowledge center.
          Parameters:
          kcid - knowledge center whose statistics should be deleted
          Throws:
          InvalidKnowledgeCenterException

        • deleteStatisticsKnowledgeCenter

          @Read(K_COLLAB) @Write(value=K_COLLAB_STAT, indirectRouting=true) void deleteStatisticsKnowledgeCenter(Long[] kcid) throws InvalidKnowledgeCenterException
          Deprecated.
          Deletes the individual download statistics related to a given knowledge center.
          Parameters:
          kcid - knowledge centers whose statistics should be deleted
          Throws:
          InvalidKnowledgeCenterException

        • getContentIdForKnowledgeCenterId

          @Read(K_COLLAB) Long getContentIdForKnowledgeCenterId(Long id_)
          Deprecated.

        • getContentIdsForKnowledgeCenterIds

          @Read(K_COLLAB) Long[] getContentIdsForKnowledgeCenterIds(Long[] id_)
          Deprecated.

        • getKnowledgeCenterIdForContentId

          @Read(K_COLLAB) Long getKnowledgeCenterIdForContentId(Long id_)
          Deprecated.

        • getKnowledgeCenterIdsForContentIds

          @Read(K_COLLAB) Long[] getKnowledgeCenterIdsForContentIds(Long[] id_)
          Deprecated.

        • updateIsSearchableForKnowledgeCenter

          @Write(K_COLLAB) void updateIsSearchableForKnowledgeCenter(Long kcid_, Boolean isHierachySearchable_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
          Deprecated.
          Updates the searchability of a KC as well as recursively updates the searchability of the KC's contents down to the document level.
          Parameters:
          kcid_ - the unique ID of the knowledge center
          isHierachySearchable_ - specifies whether the KC as well as its contents will be searchable.
          Throws:
          InvalidUserException - if the user making this call is an invalid user.
          PrivilegeException - if the User does not have rights to update the specified knowledge center
          InvalidKnowledgeCenterException - if the ID does not correspond to a valid knowledge center
          ServiceException - if any system-level error occurs