Interface KnowledgeCenterService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
Knowledge centers may be private or public
(see KnowledgeCenter.getType()
). Public knowledge centers are
those that are housed within collaboration Community
s; 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 Folder
s. 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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addAdminToKnowledgeCenter
(String username_, Long kcid_) Deprecated.Make a user an administrator of a knowledge centervoid
addKnowledgeCentersToFavorites
(Long[] kcids_) Deprecated.Adds multiple knowledge centers to the current user's "Favorites" listvoid
Deprecated.Adds a knowledge center to the current user's "Favorites" listbrowseKnowledgeCenters
(int startIndex_, int scrollLength_) Deprecated.browseKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
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)createKnowledgeCenter
(KnowledgeCenter knowledgeCenter_) Deprecated.Creates a new knowledge centerLong[]
createKnowledgeCenters
(KnowledgeCenter[] knowledgeCenters_) Deprecated.Creates multiple knowledge centersvoid
Deprecated.Create a private knowledge center for the current user.void
deleteKnowledgeCenter
(Long kcid_) Deprecated.Deletes a given knowledge center.void
deleteKnowledgeCenters
(Long[] kcids_) Deprecated.Deletes knowledge centers.void
Deprecated.Deletes the individual download statistics related to a given knowledge center.void
deleteStatisticsKnowledgeCenter
(Long[] kcid_) Deprecated.Deletes the individual download statistics related to a given knowledge center.boolean
Deprecated.Determine whether the current user has an existing private knowledge center.int
Deprecated.Retrieves the access level of the current user to the specified knowledge centerint[]
getAccessLevelForKnowledgeCenters
(Long[] kcids_) Deprecated.Retrieves the access level of the current user to the specified knowledge centergetAdministratableKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of the knowledge centers to which the current user has administrator privileges, and to which the current user is subscribedFolder[]
getAllFolders
(Long kcid_) Deprecated.getAllFoldersPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing all of the folders in a knowledge center (including the sub-folders of the direct child folders of the knowledge center)Deprecated.Long[]
Deprecated.getDescendantDocumentsOfKnowledgeCenterPaging
(Long knowledgeCenterId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get aResultPage
containing a list of all documents in a given knowledge centergetDescendantDocumentsOfKnowledgeCentersPaging
(Long[] knowledgeCenterIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get aResultPage
containing a list of all documents in a given list of knowledge centersDocument[]
Deprecated.getDocumentsRequiringApprovalPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get aResultPage
containing the list of documents requiring approval (both for creation and deletion) for a knowledge centerDocument[]
getExpiredDocuments
(Long kcid_) Deprecated.getExpiredDocumentsPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of all expired documents in the specified knowledge centergetFavoriteKnowledgeCenters
(Integer sortOrder_, String sortColumn_) Deprecated.getFavoriteKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing the knowledge centers which the current user has added to their "Favorites" listFolder[]
getFoldersRequiringApproval
(Long kcid_) Deprecated.getFoldersRequiringApprovalPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of requiring approval (for creation or deletion) for the given knowledge centergetFolderTreeViewForKnowledgeCenter
(Long knowledgeCenterId_, int accessLevel_) Deprecated.Get a tree pivoted at a particular knowledge center.getFolderTreeViewForKnowledgeCenters
(Long[] knowledgeCenterIds_, int accessLevel_) Deprecated.Get trees pivoted at particular knowledge centers.getKnowledgeCenter
(Long kcid_) Deprecated.Retrieves the knowledge center with the given IDDeprecated.Long[]
Deprecated.getKnowledgeCenters
(Long[] kcids_) Deprecated.getKnowledgeCentersForCommunities
(Long[] coids_) Deprecated.getKnowledgeCentersForCommunitiesPaging
(Long[] coids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list ofKnowledgeCenter
objects for givenCommunity
IDsDeprecated.getKnowledgeCentersForCommunityPaging
(Long coid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing the list of knowledge centers contained within a given communityDeprecated.getKnowledgeCentersForGroupPaging
(Long gid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of knowledge centers to which a given group has accessgetKnowledgeCentersForGroups
(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.getKnowledgeCentersForGroupsPaging
(Long[] gids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
contaning a list of knowledge centers to which the specified groups have accessgetKnowledgeCentersList
(Long[] ids_) Deprecated.Returns aResultList
containing result codes for all given IDs andKnowledgeCenter
objects for valid IDsgetKnowledgeCentersPaging
(Long[] kcids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
contaning a list of the knowledge centers with the unique IDs specifiedgetParentCommunities
(Long kcid_) Deprecated.getParentCommunitiesPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of the communities which are the parents of a specified knowledge center.Deprecated.getPersonalKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing the current user's private knowledge centersgetRoleMapForKnowledgeCenter
(Long kcid_) Deprecated.Retrieves the role map for a given knowledge centerFolder[]
getRootFolders
(Long kcid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) Deprecated.getRootFoldersPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing all of the folders that are the direct children of the given knowledge centerDeprecated.getSubscribedKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing the list of knowledge centers to which the current user is subscribedString[]
getSubscriptionRequests
(Long kcid_) Deprecated.Retrieves all the requests for subscription to a specified knowledge centergetSystemKnowledgeCenterId
(String name_) Deprecated.Deprecated.Retrieves the current user's subscription status (pending, subscribed or unsubscribed) for the specified knowledge centerLong[]
getUserStatusForKnowledgeCenters
(Long[] kcids_) Deprecated.Retrieves the current user's subscription status (pending, subscribed or unsubscribed) for the specified knowledge centersDocument[]
getVersionsRequiringApproval
(Long kcid_) Deprecated.getVersionsRequiringApprovalPaging
(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get aResultPage
contaning a list of document versions requiring approval (both for creation and deletion) for a specified knowledge centergetWritableFoldersForKnowledgeCenterPaging
(Long kcId_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of theFolder
objects in the knowledge center with the given ID to which the current user has editor privileges or greaterDeprecated.getWritableKnowledgeCentersPaging
(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of the knowledge centers to which the current user has editor privileges or greater.boolean
isKnowledgeCenterEmpty
(Long kcid_) Deprecated.Checks whether the specified knowledge center is empty (that is, whether it contains any folders)void
moveKnowledgeCenter
(Long kcid_, Long coid_) Deprecated.Moves the given knowledge center to the given community.void
moveKnowledgeCenters
(Long[] kcids_, Long coid_) Deprecated.Moves multiple knowledge centers to the given community.void
notifyExpiredDocuments
(Double[] days_, Boolean notifyCreator_, Boolean notifyUsers_, Boolean notifyGroups_) Deprecated.Send EXPIRING_FILES notifications for documents expiring within the next given number of days.void
notifyExpiredDocuments
(Double days_, Boolean notifyCreator_, Boolean notifyUsers_, Boolean notifyGroups_) Deprecated.Send EXPIRING_FILES notifications for documents expiring within the next given number of days.void
notifyExpiredDocumentsForKnowledgeCenter
(Long knowledgeCenterId_, Double[] days_, Boolean notifyCreator_, Boolean notifyUsers_, Boolean notifyGroups_) Deprecated.Send EXPIRING_FILES notifications for documents expiring within the next given number of days.void
notifyExpiredDocumentsForKnowledgeCenter
(Long knowledgeCenterId_, Double days_, Boolean notifyCreator_, Boolean notifyUsers_, Boolean notifyGroups_) Deprecated.Send EXPIRING_FILES notifications for documents expiring within the next given number of days.void
rejectSubscriptions
(Long kcid_, String[] users_) Deprecated.Rejects subscriptions to a knowledge centervoid
Deprecated.Removes a knowledge center from the current user's "Favorites" listvoid
removeKnowledgeCentersFromFavorites
(Long[] kcids_) Deprecated.Removes multiple knowledge centers from the current user's "Favorites" listsearchKnowledgeCenters
(String searchTerm_, int startIndex_, int scrollLength_) Deprecated.use searchKnowledgeCentersPaging insteadsearchKnowledgeCentersPaging
(String searchterm_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Returns aResultPage
of knowledge centers which have names matching given search term.void
setRoleMapForKnowledgeCenter
(Long kcid_, CollaborationRoleMap crm_) Deprecated.Sets the role map for a given knowledge center.void
setSystemKnowledgeCenterId
(String name_, Long id_) Deprecated.usecreateKnowledgeCenter(KnowledgeCenter)
with a pre-populated UUIDString[][]
subscribeKnowledgeCenter
(Long kcid_) Deprecated.Subscribes the current user to a specified knowledge center.String[][]
subscribeKnowledgeCenters
(Long[] kcids_) Deprecated.Subscribes the current user to multiple knowledge centers.String[][]
subscribeKnowledgeCentersWithNote
(Long[] kcids_, String userNote_) Deprecated.Subscribes the current user to the specified knowledge centers.String[][]
subscribeKnowledgeCenterWithNote
(Long kcid_, String userNote_) Deprecated.Subscribes the current user to a specified knowledge center.suggest
(String query_, int maxItems_, SuggestParam[] params_, Boolean groupResults_) Deprecated.suggest
(String query_, int maxItems_, SuggestParam[] params_, Boolean groupResults_, Long[] allowList) Deprecated.void
unsubscribeKnowledgeCenter
(Long kcid_) Deprecated.Unsubscribes the current user from the specified knowledge centervoid
unsubscribeKnowledgeCenters
(Long[] kcids_) Deprecated.Unsubscribes the current user from multiple knowledge centersvoid
updateExpirationDaysForKnowledgeCenter
(Long kcid_, Long days_) Deprecated.Updates the information about the number of days after which documents in the given knowledge center will expirevoid
updateExpirationDaysForKnowledgeCenters
(Long[] kcids_, Long days_) Deprecated.Updates the information about the number of days after which documents in the given knowledge centers will expirevoid
updateForumForKnowledgeCenter
(KnowledgeCenter knowledgeCenter_) Deprecated.Updates the forum associated with a knowledge centervoid
updateForumForKnowledgeCenters
(KnowledgeCenter[] knowledgeCenters_) Deprecated.Updates the forums associated with knowledge centersvoid
updateIsSearchableForKnowledgeCenter
(Long kcid_, Boolean isHierachySearchable_) Deprecated.Updates the searchability of a KC as well as recursively updates the searchability of the KC's contents down to the document level.void
updateKnowledgeCenter
(KnowledgeCenter knowledgeCenter_) Deprecated.Updates a knowledge centervoid
updateKnowledgeCenterCreator
(String username_, Long kcid_) Deprecated.Changes the creator of the knowledge center to be the user with the specified usernamevoid
updateKnowledgeCenters
(KnowledgeCenter[] knowledgeCenters_) Deprecated.Updates multiple knowledge centersvoid
updateRolesForKnowledgeCenter
(Long kcid_, String[] users_, int[] roles_, String[] notes_, Long[] groups_, int[] groupRoles_, String[] groupNotes_) Deprecated.Updates the role of the pending access users.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
createKnowledgeCenter$UPDATES
static final boolean createKnowledgeCenter$UPDATESDeprecated.- See Also:
-
createKnowledgeCenters$UPDATES
static final boolean createKnowledgeCenters$UPDATESDeprecated.- See Also:
-
updateKnowledgeCenter$UPDATES
static final boolean updateKnowledgeCenter$UPDATESDeprecated.- See Also:
-
updateKnowledgeCenters$UPDATES
static final boolean updateKnowledgeCenters$UPDATESDeprecated.- See Also:
-
updateExpirationDaysForKnowledgeCenter$UPDATES
static final boolean updateExpirationDaysForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
updateExpirationDaysForKnowledgeCenters$UPDATES
static final boolean updateExpirationDaysForKnowledgeCenters$UPDATESDeprecated.- See Also:
-
updateForumForKnowledgeCenter$UPDATES
static final boolean updateForumForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
updateForumForKnowledgeCenters$UPDATES
static final boolean updateForumForKnowledgeCenters$UPDATESDeprecated.- See Also:
-
deleteKnowledgeCenter$UPDATES
static final boolean deleteKnowledgeCenter$UPDATESDeprecated.- See Also:
-
deleteKnowledgeCenters$UPDATES
static final boolean deleteKnowledgeCenters$UPDATESDeprecated.- See Also:
-
moveKnowledgeCenter$UPDATES
static final boolean moveKnowledgeCenter$UPDATESDeprecated.- See Also:
-
moveKnowledgeCenters$UPDATES
static final boolean moveKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getKnowledgeCenter$UPDATES
static final boolean getKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getKnowledgeCenters$UPDATES
static final boolean getKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersPaging$UPDATES
static final boolean getKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getWritableKnowledgeCenters$UPDATES
static final boolean getWritableKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getWritableKnowledgeCentersPaging$UPDATES
static final boolean getWritableKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getWritableFoldersForKnowledgeCenterPaging$UPDATES
static final boolean getWritableFoldersForKnowledgeCenterPaging$UPDATESDeprecated.- See Also:
-
getAdministratableKnowledgeCentersPaging$UPDATES
static final boolean getAdministratableKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForGroup$UPDATES
static final boolean getKnowledgeCentersForGroup$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForGroupPaging$UPDATES
static final boolean getKnowledgeCentersForGroupPaging$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForGroups$UPDATES
static final boolean getKnowledgeCentersForGroups$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForGroupsPaging$UPDATES
static final boolean getKnowledgeCentersForGroupsPaging$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForCommunity$UPDATES
static final boolean getKnowledgeCentersForCommunity$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForCommunityPaging$UPDATES
static final boolean getKnowledgeCentersForCommunityPaging$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForCommunities$UPDATES
static final boolean getKnowledgeCentersForCommunities$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersForCommunitiesPaging$UPDATES
static final boolean getKnowledgeCentersForCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getPersonalKnowledgeCenters$UPDATES
static final boolean getPersonalKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getPersonalKnowledgeCentersPaging$UPDATES
static final boolean getPersonalKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getSubscribedKnowledgeCenters$UPDATES
static final boolean getSubscribedKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getSubscribedKnowledgeCentersPaging$UPDATES
static final boolean getSubscribedKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
subscribeKnowledgeCenter$UPDATES
static final boolean subscribeKnowledgeCenter$UPDATESDeprecated.- See Also:
-
subscribeKnowledgeCenterWithNote$UPDATES
static final boolean subscribeKnowledgeCenterWithNote$UPDATESDeprecated.- See Also:
-
subscribeKnowledgeCentersWithNote$UPDATES
static final boolean subscribeKnowledgeCentersWithNote$UPDATESDeprecated.- See Also:
-
subscribeKnowledgeCenters$UPDATES
static final boolean subscribeKnowledgeCenters$UPDATESDeprecated.- See Also:
-
unsubscribeKnowledgeCenter$UPDATES
static final boolean unsubscribeKnowledgeCenter$UPDATESDeprecated.- See Also:
-
unsubscribeKnowledgeCenters$UPDATES
static final boolean unsubscribeKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getSubscriptionRequests$UPDATES
static final boolean getSubscriptionRequests$UPDATESDeprecated.- See Also:
-
rejectSubscriptions$UPDATES
static final boolean rejectSubscriptions$UPDATESDeprecated.- See Also:
-
getAllFoldersPaging$UPDATES
static final boolean getAllFoldersPaging$UPDATESDeprecated.- See Also:
-
getAllFolders$UPDATES
static final boolean getAllFolders$UPDATESDeprecated.- See Also:
-
getRootFolders$UPDATES
static final boolean getRootFolders$UPDATESDeprecated.- See Also:
-
getRootFoldersPaging$UPDATES
static final boolean getRootFoldersPaging$UPDATESDeprecated.- See Also:
-
getFoldersRequiringApproval$UPDATES
static final boolean getFoldersRequiringApproval$UPDATESDeprecated.- See Also:
-
getFoldersRequiringApprovalPaging$UPDATES
static final boolean getFoldersRequiringApprovalPaging$UPDATESDeprecated.- See Also:
-
getDocumentsRequiringApproval$UPDATES
static final boolean getDocumentsRequiringApproval$UPDATESDeprecated.- See Also:
-
getDocumentsRequiringApprovalPaging$UPDATES
static final boolean getDocumentsRequiringApprovalPaging$UPDATESDeprecated.- See Also:
-
getVersionsRequiringApproval$UPDATES
static final boolean getVersionsRequiringApproval$UPDATESDeprecated.- See Also:
-
getVersionsRequiringApprovalPaging$UPDATES
static final boolean getVersionsRequiringApprovalPaging$UPDATESDeprecated.- See Also:
-
getExpiredDocuments$UPDATES
static final boolean getExpiredDocuments$UPDATESDeprecated.- See Also:
-
getExpiredDocumentsPaging$UPDATES
static final boolean getExpiredDocumentsPaging$UPDATESDeprecated.- See Also:
-
notifyExpiredDocuments$UPDATES
static final boolean notifyExpiredDocuments$UPDATESDeprecated.- See Also:
-
notifyExpiredDocumentsForKnowledgeCenter$UPDATES
static final boolean notifyExpiredDocumentsForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
isKnowledgeCenterEmpty$UPDATES
static final boolean isKnowledgeCenterEmpty$UPDATESDeprecated.- See Also:
-
getParentCommunities$UPDATES
static final boolean getParentCommunities$UPDATESDeprecated.- See Also:
-
getParentCommunitiesPaging$UPDATES
static final boolean getParentCommunitiesPaging$UPDATESDeprecated.- See Also:
-
getFavoriteKnowledgeCenters$UPDATES
static final boolean getFavoriteKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getFavoriteKnowledgeCentersPaging$UPDATES
static final boolean getFavoriteKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
addKnowledgeCenterToFavorites$UPDATES
static final boolean addKnowledgeCenterToFavorites$UPDATESDeprecated.- See Also:
-
addKnowledgeCentersToFavorites$UPDATES
static final boolean addKnowledgeCentersToFavorites$UPDATESDeprecated.- See Also:
-
removeKnowledgeCenterFromFavorites$UPDATES
static final boolean removeKnowledgeCenterFromFavorites$UPDATESDeprecated.- See Also:
-
removeKnowledgeCentersFromFavorites$UPDATES
static final boolean removeKnowledgeCentersFromFavorites$UPDATESDeprecated.- See Also:
-
getUserStatusForKnowledgeCenter$UPDATES
static final boolean getUserStatusForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getUserStatusForKnowledgeCenters$UPDATES
static final boolean getUserStatusForKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getAccessLevelForKnowledgeCenter$UPDATES
static final boolean getAccessLevelForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getAccessLevelForKnowledgeCenters$UPDATES
static final boolean getAccessLevelForKnowledgeCenters$UPDATESDeprecated.- See Also:
-
updateRolesForKnowledgeCenter$UPDATES
static final boolean updateRolesForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
setRoleMapForKnowledgeCenter$UPDATES
static final boolean setRoleMapForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getRoleMapForKnowledgeCenter$UPDATES
static final boolean getRoleMapForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
browseKnowledgeCenters$UPDATES
static final boolean browseKnowledgeCenters$UPDATESDeprecated.- See Also:
-
browseKnowledgeCentersPaging$UPDATES
static final boolean browseKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
addAdminToKnowledgeCenter$UPDATES
static final boolean addAdminToKnowledgeCenter$UPDATESDeprecated.- See Also:
-
updateKnowledgeCenterCreator$UPDATES
static final boolean updateKnowledgeCenterCreator$UPDATESDeprecated.- See Also:
-
searchKnowledgeCenters$UPDATES
static final boolean searchKnowledgeCenters$UPDATESDeprecated.- See Also:
-
searchKnowledgeCentersPaging$UPDATES
static final boolean searchKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getDescendantDocumentsOfKnowledgeCenterPaging$UPDATES
static final boolean getDescendantDocumentsOfKnowledgeCenterPaging$UPDATESDeprecated.- See Also:
-
getDescendantDocumentsOfKnowledgeCentersPaging$UPDATES
static final boolean getDescendantDocumentsOfKnowledgeCentersPaging$UPDATESDeprecated.- See Also:
-
getFolderTreeViewForKnowledgeCenter$UPDATES
static final boolean getFolderTreeViewForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getFolderTreeViewForKnowledgeCenters$UPDATES
static final boolean getFolderTreeViewForKnowledgeCenters$UPDATESDeprecated.- See Also:
-
getKnowledgeCentersList$UPDATES
static final boolean getKnowledgeCentersList$UPDATESDeprecated.- See Also:
-
doesPrivateKnowledgeCenterExist$UPDATES
static final boolean doesPrivateKnowledgeCenterExist$UPDATESDeprecated.- See Also:
-
createPrivateKnowledgeCenter$UPDATES
static final boolean createPrivateKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getSystemKnowledgeCenterId$UPDATES
static final boolean getSystemKnowledgeCenterId$UPDATESDeprecated.- See Also:
-
setSystemKnowledgeCenterId$UPDATES
static final boolean setSystemKnowledgeCenterId$UPDATESDeprecated.- See Also:
-
suggest$UPDATES
static final boolean suggest$UPDATESDeprecated.- See Also:
-
deleteStatisticsKnowledgeCenter$UPDATES
static final boolean deleteStatisticsKnowledgeCenter$UPDATESDeprecated.- See Also:
-
getContentIdForKnowledgeCenterId$UPDATES
static final boolean getContentIdForKnowledgeCenterId$UPDATESDeprecated.- See Also:
-
getContentIdsForKnowledgeCenterIds$UPDATES
static final boolean getContentIdsForKnowledgeCenterIds$UPDATESDeprecated.- See Also:
-
getKnowledgeCenterIdForContentId$UPDATES
static final boolean getKnowledgeCenterIdForContentId$UPDATESDeprecated.- See Also:
-
getKnowledgeCenterIdsForContentIds$UPDATES
static final boolean getKnowledgeCenterIdsForContentIds$UPDATESDeprecated.- See Also:
-
updateIsSearchableForKnowledgeCenter$UPDATES
static final boolean updateIsSearchableForKnowledgeCenter$UPDATESDeprecated.- See Also:
-
-
Method Details
-
createKnowledgeCenter
Long createKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidCommunityException Deprecated.Creates a new knowledge center- Parameters:
knowledgeCenter_
- aKnowledgeCenter
object which should contain all of the information required to create a validKnowledgeCenter
. 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 communityServiceException
- if any system-level error occurs
-
createKnowledgeCenters
Long[] createKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidCommunityException Deprecated.Creates multiple knowledge centers- Parameters:
knowledgeCenters_
- an array ofKnowledgeCenter
objects which should contain minimum information required to create a validKnowledgeCenter
. 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 communityServiceException
- if any system-level error occurs
-
updateKnowledgeCenter
void updateKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Updates a knowledge center- Parameters:
knowledgeCenter_
- aKnowledgeCenter
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 theUser
does not have rights to update the specified knowledge centerInvalidKnowledgeCenterException
- if the ID the knowledge center does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
updateKnowledgeCenters
void updateKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Updates multiple knowledge centers- Parameters:
knowledgeCenters_
- a list ofKnowledgeCenter
objects which should contain minimum information required to update aKnowledgeCenter
. Minimum required fields:name
,description
,changesRequireApproval
,isSearchable
,autoApproveForReadOnlyAccess
,id
,creator
.- Throws:
InvalidUserException
- if the user making this call is an invalid user.PrivilegeException
- if theUser
does not have rights to update the specified knowledge centersInvalidKnowledgeCenterException
- if the ID any of the knowledge centers does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
updateExpirationDaysForKnowledgeCenter
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 centerdays_
- 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 theUser
does not have rights to update the specified knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs- See Also:
-
updateExpirationDaysForKnowledgeCenters
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 centersdays_
- the number of days after which documents in the knowledge centers will expire- Throws:
InvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if theUser
does not have rights to update the specified knowledge centersInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs- See Also:
-
updateForumForKnowledgeCenter
void updateForumForKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidKnowledgeCenterException Deprecated.Updates the forum associated with a knowledge center- Parameters:
knowledgeCenter_
- aKnowledgeCenter
object which should contain all of the information required to update theForum
associated withKnowledeCenter
. Minimum required fields:name
,description
,changesRequireApproval
,isSearchable
,autoApproveForReadOnlyAccess
,id
,forum
. IfForum
is set tonull
, this removes any forum associations.- Throws:
InvalidKnowledgeCenterException
- if the ID of the knowledge center does not correspond a valid knowledge centerServiceException
- if any system-level error occurs
-
updateForumForKnowledgeCenters
void updateForumForKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidKnowledgeCenterException Deprecated.Updates the forums associated with knowledge centers- Parameters:
knowledgeCenters_
- a list ofKnowledgeCenter
objects containing all of the information required to update theForum
s associated with theKnowledgeCenter
s. Minimum required fields:name
,description
,changesRequireApproval
,isSearchable
,autoApproveForReadOnlyAccess
,id
,forum
. IfForum
is set tonull
, this removes any forum associations.- Throws:
InvalidKnowledgeCenterException
- if any of the IDs of the knowledge centers does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
deleteKnowledgeCenter
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 userPrivilegeException
- if theUser
does not have rights to delete the specified knowledge centerNotEmptyException
- if the knowledge center contains foldersInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
deleteKnowledgeCenters
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 userPrivilegeException
- if theUser
does not have rights to delete any of the specified knowledge centersNotEmptyException
- if any of the the knowledge centers contains foldersInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
moveKnowledgeCenter
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 movedcoid_
- 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 communityInvalidKnowledgeCenterException
- if the knowledge center ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
moveKnowledgeCenters
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 movedcoid_
- 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 communityInvalidKnowledgeCenterException
- if any of the knowledge center IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getKnowledgeCenter
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 userPrivilegeException
- if theUser
does not have view privileges for this knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getKnowledgeCenters
@Deprecated KnowledgeCenter[] getKnowledgeCenters(Long[] kcids_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.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 userPrivilegeException
- if theUser
does not have view privileges for any of the specified knowledge centersInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getKnowledgeCentersPaging
ResultPage getKnowledgeCentersPaging(Long[] kcids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
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 retrievedstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects for the specified IDs. - Throws:
InvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if theUser
does not have view privileges for any of knowledge center's returnedInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getWritableKnowledgeCenters
Deprecated.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 userServiceException
- if any system-level error occurs
-
getWritableKnowledgeCentersPaging
ResultPage getWritableKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
Objects. - Throws:
InvalidUserException
- if the user making this call is an invalid userServiceException
- if any system-level error occurs
-
getWritableFoldersForKnowledgeCenterPaging
ResultPage getWritableFoldersForKnowledgeCenterPaging(Long kcId_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException Deprecated.Retrieves aResultPage
containing a list of theFolder
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 centerstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofFolder
objects. - Throws:
InvalidUserException
- if the user making this call is an invalid userInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if theUser
does not have view privileges to the specified knowledge centerServiceException
- if any system-level error occurs
-
getAdministratableKnowledgeCentersPaging
ResultPage getAdministratableKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersForGroup
Deprecated.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
ResultPage getKnowledgeCentersForGroupPaging(Long gid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
containing a list of knowledge centers to which a given group has access- Parameters:
gid_
- the unique ID of the groupstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects. - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersForGroups
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 usegetKnowledgeCentersForGroupsPaging(Long[], int, int, Integer, Integer)
instead
-
getKnowledgeCentersForGroupsPaging
ResultPage getKnowledgeCentersForGroupsPaging(Long[] gids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves aResultPage
contaning a list of knowledge centers to which the specified groups have access- Parameters:
gids_
- an array containing the unique IDs of groupsstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects, representing the knowledge centers to which the specified groups have access - Throws:
ServiceException
- if any system-level error occurs
-
getKnowledgeCentersForCommunity
@Deprecated KnowledgeCenter[] getKnowledgeCentersForCommunity(Long coid_) throws InvalidCommunityException Deprecated.Retrieves the knowledge centers contained in the specified community- Parameters:
coid_
- the unique ID of theCommunity
- Returns:
- a list of knowledge centers contained within the community
- Throws:
InvalidCommunityException
- if the ID does not correspond to a valid communityServiceException
- if any system-level error occurs
-
getKnowledgeCentersForCommunityPaging
ResultPage getKnowledgeCentersForCommunityPaging(Long coid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException Deprecated.Retrieves aResultPage
containing the list of knowledge centers contained within a given community- Parameters:
coid_
- the unique ID of the communitystartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects, representing the knowledge centers within a particular community - Throws:
InvalidCommunityException
- if the ID does not correspond to a valid communityServiceException
- if any system-level error occurs
-
getKnowledgeCentersForCommunities
@Deprecated KnowledgeCenter[] getKnowledgeCentersForCommunities(Long[] coids_) throws InvalidCommunityException Deprecated.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 communityServiceException
- if any system-level error occursInvalidCommunityException
-
getKnowledgeCentersForCommunitiesPaging
ResultPage getKnowledgeCentersForCommunitiesPaging(Long[] coids_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidCommunityException Deprecated.Retrieves aResultPage
containing a list ofKnowledgeCenter
objects for givenCommunity
IDs- Parameters:
coids_
- a list of uniqueCommunity
IDsstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects representing the knowledge centers contained within the given communities - Throws:
InvalidCommunityException
- if any of the IDs does not correspond to a valid communityServiceException
- if any system-level error occurs
-
getPersonalKnowledgeCenters
Deprecated.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 invalidServiceException
- if any system-level error occurs
-
getPersonalKnowledgeCentersPaging
ResultPage getPersonalKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects, representing the current user's private knowledge centers. - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
getSubscribedKnowledgeCenters
Deprecated.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 invalidServiceException
- if any system-level error occurs
-
getSubscribedKnowledgeCentersPaging
ResultPage getSubscribedKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects, representing the knowledge centers to which the current user is subscribed. - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
subscribeKnowledgeCenter
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 aString
array of resulting pending knowledge center names and the second index of which is aString
array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an emptyString
array and the second index will be aString
array of length 1 containing the name of the knowledge center corresponding tokcid_
)- 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 aString
array of resulting subscribed knowledge center names - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if theUser
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 requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
subscribeKnowledgeCenterWithNote
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 aString
array of resulting pending knowledge center names and the second index of which is aString
array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an emptyString
array and the second index will be aString
array of length 1 containing the name of the knowledge center corresponding tokcid_
)- Parameters:
kcid_
- the unique ID of the knowledge centeruserNote_
- 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 aString
array of resulting subscribed knowledge center names - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if theUser
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 requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
subscribeKnowledgeCentersWithNote
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 aString
array of resulting pending knowledge center names and the second index of which is aString
array of subscribed knowledge center names (eg if the user is automatically subscribed, the first index will be an emptyString
array and the second index will be aString
array of length 1 containing the name of the knowledge center corresponding tokcid_
)- 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 aString
array of resulting subscribed knowledge center names - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if theUser
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 requestInvalidKnowledgeCenterException
- if an ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
subscribeKnowledgeCenters
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 aString
array of resulting pending knowledge center names and the second index of which is aString
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 aString
array of subscribed knowledge center names - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if theUser
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 requestInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledgeServiceException
- if any system-level error occurs
-
unsubscribeKnowledgeCenter
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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
unsubscribeKnowledgeCenters
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 invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getSubscriptionRequests
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
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 centerusers_
- 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 invalidPrivilegeException
- if theUser
does not have rights to administer the specified knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getAllFoldersPaging
ResultPage getAllFoldersPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
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 theKnowledgeCenter
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containingFolder
objects, representing all of the folders in the knowledge center - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getAllFolders
@Deprecated Folder[] getAllFolders(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getRootFolders
@Deprecated Folder[] getRootFolders(Long kcid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException, InvalidDocumentException, InvalidFolderException Deprecated.Retrieves all of the folders that are the direct children of a given knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centersortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the property by which the results will be sorted. This is one of theSORT_COLUMN_XXX
constants inFolder
.startIndex_
- the starting index of the firstFolder
to returnscrollLength_
- the number of consecutiveFolder
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 invalidPrivilegeException
- if theUser
does not have view privileges for any of the folder's returnedInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerInvalidDocumentException
- if any of the child documents for root folders points to an invalid documentInvalidFolderException
- if any of the root folders or child folder of root folders points to an invalid folderServiceException
- if any system-level error occurs
-
getRootFoldersPaging
ResultPage getRootFoldersPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
containing all of the folders that are the direct children of the given knowledge center- Parameters:
kcid_
- the unique ID of theKnowledgeCenter
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofFolder
objects, representing the root folders. - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if theUser
does not have rights to perform this operation.InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getFoldersRequiringApproval
@Deprecated Folder[] getFoldersRequiringApproval(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getFoldersRequiringApprovalPaging
ResultPage getFoldersRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
containing a list of requiring approval (for creation or deletion) for the given knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the returnedFolder
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofFolder
objects, representing the folders tha require approval for the given knowledge center. - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getDocumentsRequiringApproval
@Deprecated Document[] getDocumentsRequiringApproval(Long kcid_) throws InvalidKnowledgeCenterException Deprecated.Retrieves the documents requiring approval (both for creation and deletion) for a given knowledge center- Parameters:
kcid_
- the unique ID of theKnowledgeCenter
- Returns:
- a list of documents requring approval for the knowledge center
- Throws:
InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getDocumentsRequiringApprovalPaging
ResultPage getDocumentsRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException Deprecated.Get aResultPage
containing the list of documents requiring approval (both for creation and deletion) for a knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the returnedDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.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 centerServiceException
- if any system-level error occurs
-
getVersionsRequiringApproval
@Deprecated Document[] getVersionsRequiringApproval(Long kcid_) throws InvalidKnowledgeCenterException Deprecated.Get versions of documents requiring approval (both for creation and deletion) for a specified knowledge center- Parameters:
kcid_
- the unique ID of theKnowledgeCenter
- 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 centerServiceException
- if any system-level error occurs
-
getVersionsRequiringApprovalPaging
ResultPage getVersionsRequiringApprovalPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException Deprecated.Get aResultPage
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 centerstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the returnedDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDocument
objects, representing the versions requiring approval for a knowledge center - Throws:
InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getExpiredDocuments
@Deprecated Document[] getExpiredDocuments(Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getExpiredDocumentsPaging
ResultPage getExpiredDocumentsPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
containing a list of all expired documents in the specified knowledge center- Parameters:
kcid_
- the unique ID of the knowledge centerstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the returnedDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofDocument
objects, representing the expired documents in the knowledge center. - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
notifyExpiredDocuments
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 kcnotifyUsers
- send notifications to users with admin rights over the kcnotifyGroups
- send notifications to groups with admin rights over the kc- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if theUser
does not have rights to administer the content rootServiceException
- if any system-level error occurs
-
notifyExpiredDocuments
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 kcnotifyUsers
- send notifications to users with admin rights over the kcnotifyGroups
- send notifications to groups with admin rights over the kc- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if theUser
does not have rights to administer the content rootServiceException
- if any system-level error occurs
-
notifyExpiredDocumentsForKnowledgeCenter
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 iddays
- 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 kcnotifyUsers
- send notifications to users with admin rights over the kcnotifyGroups
- send notifications to groups with admin rights over the kc- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if theUser
does not have rights to administer the specified knowledge centerServiceException
- if any system-level error occurs
-
notifyExpiredDocumentsForKnowledgeCenter
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 iddays
- 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 kcnotifyUsers
- send notifications to users with admin rights over the kcnotifyGroups
- send notifications to groups with admin rights over the kc- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if theUser
does not have rights to administer the specified knowledge centerServiceException
- if any system-level error occurs
-
isKnowledgeCenterEmpty
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 centerServiceException
- if any system-level error occurs
-
getParentCommunities
Deprecated.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 centerServiceException
- if any system-level error occurs
-
getParentCommunitiesPaging
ResultPage getParentCommunitiesPaging(Long kcid_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidKnowledgeCenterException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inCommunity
.sortOrder_
- the order in which to sort the returnedCommunity
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofCommunity
objects, representing the parent communities of this knowledge center. - Throws:
InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getFavoriteKnowledgeCenters
@Deprecated KnowledgeCenter[] getFavoriteKnowledgeCenters(Integer sortOrder_, String sortColumn_) throws InvalidUserException Deprecated.Retrieves knowledge centers which the current user has added to their "Favorites" list- Parameters:
sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the property by which the results will be sorted. This is one of theSORT_COLUMN_XXX
constants inKnowledgeCenter
.- 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
ResultPage getFavoriteKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.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
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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
addKnowledgeCentersToFavorites
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 invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occursInvalidDataFormatException
-
removeKnowledgeCenterFromFavorites
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 invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
removeKnowledgeCentersFromFavorites
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 invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occursInvalidDataFormatException
-
getUserStatusForKnowledgeCenter
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 inKnowledgeCenter
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getUserStatusForKnowledgeCenters
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 inKnowledgeCenter
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getAccessLevelForKnowledgeCenter
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 inKnowledgeCenter
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getAccessLevelForKnowledgeCenters
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 inKnowledgeCenter
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge center
-
updateRolesForKnowledgeCenter
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 centerusers_
- the list of users to update accessroles_
- 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 levelgroups_
- The list of groups to update accessgroupRoles_
- 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 invalidcom.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 theUser
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 requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge center
-
setRoleMapForKnowledgeCenter
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 theKnowledgeCenter
is insufficient.)- Parameters:
kcid_
- the unique ID of the knowledge centercrm_
- aCollaborationRoleMap
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 userPrivilegeException
- if theUser
does not have rights to administer the specified knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerInvalidGroupException
- if any of the group IDs in the role map does not correspond to a valid group
-
getRoleMapForKnowledgeCenter
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 centerPrivilegeException
- if the user does not have enough privileges to access the KC
-
browseKnowledgeCenters
@Deprecated KnowledgeCenter[] browseKnowledgeCenters(int startIndex_, int scrollLength_) throws InvalidUserException Deprecated.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
ResultPage browseKnowledgeCentersPaging(int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieves aResultPage
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. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects that meet the given criteria - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
addAdminToKnowledgeCenter
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 centerkcid_
- - 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 userInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
updateKnowledgeCenterCreator
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 centerkcid_
- the ID of the knowledge center- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
searchKnowledgeCenters
@Deprecated KnowledgeCenter[] searchKnowledgeCenters(String searchTerm_, int startIndex_, int scrollLength_) throws InvalidUserException Deprecated.use searchKnowledgeCentersPaging insteadReturns 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 querystartIndex_
- the starting index of the first knowledge center to returnscrollLength_
- 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 invalidServiceException
- if any system-level error occurs
-
searchKnowledgeCentersPaging
ResultPage searchKnowledgeCentersPaging(String searchterm_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Returns aResultPage
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 namestartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inKnowledgeCenter
.sortOrder_
- the order in which to sort the returnedKnowledgeCenter
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing a list ofKnowledgeCenter
objects, representing knowledge centers that match the search terms. - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
getDescendantDocumentsOfKnowledgeCenterPaging
ResultPage getDescendantDocumentsOfKnowledgeCenterPaging(Long knowledgeCenterId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Get aResultPage
containing a list of all documents in a given knowledge center- Parameters:
knowledgeCenterId_
- the unique ID of the knowledge centerstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the returnedDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
results in descending order- Returns:
- a
ResultPage
containing the list ofDocument
objects representing the document descendants of the knowledge center - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getDescendantDocumentsOfKnowledgeCentersPaging
ResultPage getDescendantDocumentsOfKnowledgeCentersPaging(Long[] knowledgeCenterIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException Deprecated.Get aResultPage
containing a list of all documents in a given list of knowledge centers- Parameters:
knowledgeCenterIds_
- a list of the unique IDs of the knowledge centersstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the returnedDocument
objects. This is eitherConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing the list ofDocument
objects representing the document descendants of the given knowledge centers - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
getFolderTreeViewForKnowledgeCenter
TreePivot getFolderTreeViewForKnowledgeCenter(Long knowledgeCenterId_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, IllegalArgumentException Deprecated.Get a tree pivoted at a particular knowledge center. The children of theTreePivot
will all beFolder
objects for which the current user has the specifiedaccessLevel_
, or a greater access level. (Eg ifaccessLevel_
isKnowledgeCenter.ACCESS_LEVEL_READ_WRITE
, all folders for which the current user has write access and also administrative access will be returned.) NoDocument
objects will be returned as children of theTreePivot
.- Parameters:
knowledgeCenterId_
- the ID of the knowledge centeraccessLevel_
- 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 ofTreePivot
points toTreeNode
object which might be either KnowledgeCenter, Document, Folder or Community. * TheId
field maps to the ID of objects mentioned above,name
maps to object name anddata
maps to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY, TYPE_KNOWLEDGE_CENTER constants inObjectTypeMapping
. The _breadcrumbs field points to the path of the object from the root. - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerIllegalArgumentException
- ifaccessLevel_
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
TreePivot[] getFolderTreeViewForKnowledgeCenters(Long[] knowledgeCenterIds_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, IllegalArgumentException Deprecated.Get trees pivoted at particular knowledge centers. The children of theTreePivot
objects will all beFolder
objects for which the current user has the specifiedaccessLevel_
, or a greater access level. (Eg ifaccessLevel_
isKnowledgeCenter.ACCESS_LEVEL_READ_WRITE
, allFolder
objects for which the current user has write access and also administrative access will be returned.) NoDocument
objects will be returned as children of theTreePivot
objects.- Parameters:
knowledgeCenterIds_
- the IDs of the knowledge centersaccessLevel_
- 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 eachTreePivot
points toTreeNode
object which might be either KnowledgeCenter, Document, Folder or Community. * TheId
field maps to the ID of objects mentioned above,name
maps to object name anddata
maps to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY, TYPE_KNOWLEDGE_CENTER constants inObjectTypeMapping
. The _breadcrumbs field points to the path of the object from the root. - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerIllegalArgumentException
- ifaccessLevel_
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
Deprecated.Returns aResultList
containing result codes for all given IDs andKnowledgeCenter
objects for valid IDs- Parameters:
ids_
- the IDs of knowledge centers to retrieve- Returns:
ResultList
containingKnowledgeCenter
objects and result codes. Each result code will be one of theCODE_XXX
orCOLLAB_CODE_XXX
constants inResultList
- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
doesPrivateKnowledgeCenterExist
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
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.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 void setSystemKnowledgeCenterId(String name_, Long id_) throws InvalidKnowledgeCenterException Deprecated.usecreateKnowledgeCenter(KnowledgeCenter)
with a pre-populated UUIDStores and associates the specifiedid
value with the specifiedname
key.- Parameters:
name
- A case-insensitive system name.id
- The knowledge center id.- Throws:
InvalidKnowledgeCenterException
- if the string is not recognized.
-
suggest
Deprecated.- Parameters:
query
-maxItems
-params
- list of information on what is being suggested and what format the results should be in. valid types are 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
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
Deprecated.Deletes the individual download statistics related to a given knowledge center.- Parameters:
kcid
- knowledge center whose statistics should be deleted- Throws:
InvalidKnowledgeCenterException
-
deleteStatisticsKnowledgeCenter
Deprecated.Deletes the individual download statistics related to a given knowledge center.- Parameters:
kcid
- knowledge centers whose statistics should be deleted- Throws:
InvalidKnowledgeCenterException
-
getContentIdForKnowledgeCenterId
Deprecated. -
getContentIdsForKnowledgeCenterIds
Deprecated. -
getKnowledgeCenterIdForContentId
Deprecated. -
getKnowledgeCenterIdsForContentIds
Deprecated. -
updateIsSearchableForKnowledgeCenter
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 centerisHierachySearchable_
- 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 theUser
does not have rights to update the specified knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs
-
ContentService
instead.