ContentService
instead.@Deprecated
public interface KnowledgeCenterService
extends com.appiancorp.services.ContextSensitiveService
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.
Modifier and Type | Method and Description |
---|---|
void |
addAdminToKnowledgeCenter(java.lang.String username_,
java.lang.Long kcid_)
Deprecated.
Make a user an administrator of a knowledge center
|
void |
addKnowledgeCentersToFavorites(java.lang.Long[] kcids_)
Deprecated.
Adds multiple knowledge centers to the current user's "Favorites" list
|
void |
addKnowledgeCenterToFavorites(java.lang.Long kcid_)
Deprecated.
Adds a knowledge center to the current user's "Favorites" list
|
KnowledgeCenter[] |
browseKnowledgeCenters(int startIndex_,
int scrollLength_)
Deprecated.
|
ResultPage |
browseKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing knowledge centers, each of
which meets the following criteria:
The knowledge center is private
The knowledge center name is not "My Private Knowledge Center"
The current user is not subscribed to the knowledge center
The current user has access to the knowledge center via group only
(that is, the current user is a member of a group that has access to the
knowledge center, but the current user does not have explicit access to
the knowledge center)
|
java.lang.Long |
createKnowledgeCenter(KnowledgeCenter knowledgeCenter_)
Deprecated.
Creates a new knowledge center
|
java.lang.Long[] |
createKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_)
Deprecated.
Creates multiple knowledge centers
|
void |
createPrivateKnowledgeCenter()
Deprecated.
Create a private knowledge center for the current user.
|
void |
deleteKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Deletes a given knowledge center.
|
void |
deleteKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
Deletes knowledge centers.
|
void |
deleteStatisticsKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Deletes the individual download statistics related to a given knowledge center.
|
void |
deleteStatisticsKnowledgeCenter(java.lang.Long[] kcid_)
Deprecated.
Deletes the individual download statistics related to a given knowledge center.
|
boolean |
doesPrivateKnowledgeCenterExist()
Deprecated.
Determine whether the current user has an existing private knowledge
center.
|
int |
getAccessLevelForKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Retrieves the access level of the current user to the specified knowledge
center
|
int[] |
getAccessLevelForKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
Retrieves the access level of the current user to the specified knowledge
center
|
ResultPage |
getAdministratableKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of the
knowledge centers to which the current user has administrator privileges,
and to which the current user is subscribed |
Folder[] |
getAllFolders(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getAllFoldersPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing all of the folders in a
knowledge center (including the sub-folders of the direct child folders of
the knowledge center) |
java.lang.Long |
getContentIdForKnowledgeCenterId(java.lang.Long id_)
Deprecated.
|
java.lang.Long[] |
getContentIdsForKnowledgeCenterIds(java.lang.Long[] id_)
Deprecated.
|
ResultPage |
getDescendantDocumentsOfKnowledgeCenterPaging(java.lang.Long knowledgeCenterId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a
ResultPage containing a list of all documents in a given
knowledge center |
ResultPage |
getDescendantDocumentsOfKnowledgeCentersPaging(java.lang.Long[] knowledgeCenterIds_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a
ResultPage containing a list of all documents in a given
list of knowledge centers |
Document[] |
getDocumentsRequiringApproval(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getDocumentsRequiringApprovalPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a
ResultPage containing the list of documents requiring
approval (both for creation and deletion) for a knowledge center |
Document[] |
getExpiredDocuments(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getExpiredDocumentsPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of all expired
documents in the specified knowledge center |
KnowledgeCenter[] |
getFavoriteKnowledgeCenters(java.lang.Integer sortOrder_,
java.lang.String sortColumn_)
Deprecated.
|
ResultPage |
getFavoriteKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing the knowledge
centers which the current user has added to their "Favorites" list |
Folder[] |
getFoldersRequiringApproval(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getFoldersRequiringApprovalPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of requiring approval
(for creation or deletion) for the given knowledge center |
TreePivot |
getFolderTreeViewForKnowledgeCenter(java.lang.Long knowledgeCenterId_,
int accessLevel_)
Deprecated.
Get a tree pivoted at a particular knowledge center.
|
TreePivot[] |
getFolderTreeViewForKnowledgeCenters(java.lang.Long[] knowledgeCenterIds_,
int accessLevel_)
Deprecated.
Get trees pivoted at particular knowledge centers.
|
KnowledgeCenter |
getKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Retrieves the knowledge center with the given ID
|
java.lang.Long |
getKnowledgeCenterIdForContentId(java.lang.Long id_)
Deprecated.
|
java.lang.Long[] |
getKnowledgeCenterIdsForContentIds(java.lang.Long[] id_)
Deprecated.
|
KnowledgeCenter[] |
getKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
|
KnowledgeCenter[] |
getKnowledgeCentersForCommunities(java.lang.Long[] coids_)
Deprecated.
|
ResultPage |
getKnowledgeCentersForCommunitiesPaging(java.lang.Long[] coids_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of
KnowledgeCenter objects for given Community IDs |
KnowledgeCenter[] |
getKnowledgeCentersForCommunity(java.lang.Long coid_)
Deprecated.
|
ResultPage |
getKnowledgeCentersForCommunityPaging(java.lang.Long coid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing the list of knowledge centers
contained within a given community |
KnowledgeCenter[] |
getKnowledgeCentersForGroup(java.lang.Long gid_)
Deprecated.
|
ResultPage |
getKnowledgeCentersForGroupPaging(java.lang.Long gid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of
knowledge centers to which a given group has access |
KnowledgeCenter[] |
getKnowledgeCentersForGroups(java.lang.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. |
ResultPage |
getKnowledgeCentersForGroupsPaging(java.lang.Long[] gids_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage contaning a list of
knowledge centers to which the specified groups have access |
ResultList |
getKnowledgeCentersList(java.lang.Long[] ids_)
Deprecated.
Returns a
ResultList containing result codes for all given IDs
and KnowledgeCenter objects for valid IDs |
ResultPage |
getKnowledgeCentersPaging(java.lang.Long[] kcids_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage contaning a list of the
knowledge centers with the unique IDs specified |
Community[] |
getParentCommunities(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getParentCommunitiesPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of the
communities which are the parents of a specified knowledge center. |
KnowledgeCenter[] |
getPersonalKnowledgeCenters()
Deprecated.
|
ResultPage |
getPersonalKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing the current user's
private knowledge centers |
CollaborationRoleMap |
getRoleMapForKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Retrieves the role map for a given knowledge center
|
Folder[] |
getRootFolders(java.lang.Long kcid_,
java.lang.Integer sortOrder_,
java.lang.String sortColumn_,
int startIndex_,
int scrollLength_)
Deprecated.
|
ResultPage |
getRootFoldersPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing all of the folders that
are the direct children of the given knowledge center |
KnowledgeCenter[] |
getSubscribedKnowledgeCenters()
Deprecated.
|
ResultPage |
getSubscribedKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing the list of knowledge centers
to which the current user is subscribed |
java.lang.String[] |
getSubscriptionRequests(java.lang.Long kcid_)
Deprecated.
Retrieves all the requests for subscription to a specified knowledge center
|
java.lang.Long |
getSystemKnowledgeCenterId(java.lang.String name_)
Deprecated.
|
java.lang.Long |
getUserStatusForKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Retrieves the current user's subscription status (pending, subscribed or
unsubscribed) for the specified knowledge center
|
java.lang.Long[] |
getUserStatusForKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
Retrieves the current user's subscription status (pending, subscribed or
unsubscribed) for the specified knowledge centers
|
Document[] |
getVersionsRequiringApproval(java.lang.Long kcid_)
Deprecated.
|
ResultPage |
getVersionsRequiringApprovalPaging(java.lang.Long kcid_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a
ResultPage contaning a list of document
versions requiring approval (both for creation and deletion) for a
specified knowledge center |
ResultPage |
getWritableFoldersForKnowledgeCenterPaging(java.lang.Long kcId_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of the Folder
objects in the knowledge center with the given ID to which the
current user has editor privileges or greater |
KnowledgeCenter[] |
getWritableKnowledgeCenters()
Deprecated.
|
ResultPage |
getWritableKnowledgeCentersPaging(int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves a
ResultPage containing a list of the knowledge centers
to which the current user has editor privileges or greater. |
boolean |
isKnowledgeCenterEmpty(java.lang.Long kcid_)
Deprecated.
Checks whether the specified knowledge center is empty (that is, whether it
contains any folders)
|
void |
moveKnowledgeCenter(java.lang.Long kcid_,
java.lang.Long coid_)
Deprecated.
Moves the given knowledge center to the given community.
|
void |
moveKnowledgeCenters(java.lang.Long[] kcids_,
java.lang.Long coid_)
Deprecated.
Moves multiple knowledge centers to the given community.
|
void |
notifyExpiredDocuments(java.lang.Double[] days_,
java.lang.Boolean notifyCreator_,
java.lang.Boolean notifyUsers_,
java.lang.Boolean notifyGroups_)
Deprecated.
Send EXPIRING_FILES notifications for documents expiring within the next
given number of days.
|
void |
notifyExpiredDocuments(java.lang.Double days_,
java.lang.Boolean notifyCreator_,
java.lang.Boolean notifyUsers_,
java.lang.Boolean notifyGroups_)
Deprecated.
Send EXPIRING_FILES notifications for documents expiring within the next
given number of days.
|
void |
notifyExpiredDocumentsForKnowledgeCenter(java.lang.Long knowledgeCenterId_,
java.lang.Double[] days_,
java.lang.Boolean notifyCreator_,
java.lang.Boolean notifyUsers_,
java.lang.Boolean notifyGroups_)
Deprecated.
Send EXPIRING_FILES notifications for documents expiring within the next
given number of days.
|
void |
notifyExpiredDocumentsForKnowledgeCenter(java.lang.Long knowledgeCenterId_,
java.lang.Double days_,
java.lang.Boolean notifyCreator_,
java.lang.Boolean notifyUsers_,
java.lang.Boolean notifyGroups_)
Deprecated.
Send EXPIRING_FILES notifications for documents expiring within the next
given number of days.
|
void |
rejectSubscriptions(java.lang.Long kcid_,
java.lang.String[] users_)
Deprecated.
Rejects subscriptions to a knowledge center
|
void |
removeKnowledgeCenterFromFavorites(java.lang.Long kcid_)
Deprecated.
Removes a knowledge center from the current user's "Favorites" list
|
void |
removeKnowledgeCentersFromFavorites(java.lang.Long[] kcids_)
Deprecated.
Removes multiple knowledge centers from the current user's "Favorites" list
|
KnowledgeCenter[] |
searchKnowledgeCenters(java.lang.String searchTerm_,
int startIndex_,
int scrollLength_)
Deprecated.
use searchKnowledgeCentersPaging instead
|
ResultPage |
searchKnowledgeCentersPaging(java.lang.String searchterm_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Returns a
ResultPage of knowledge centers which have names
matching given search term. |
void |
setRoleMapForKnowledgeCenter(java.lang.Long kcid_,
CollaborationRoleMap crm_)
Deprecated.
Sets the role map for a given knowledge center.
|
void |
setSystemKnowledgeCenterId(java.lang.String name_,
java.lang.Long id_)
Deprecated.
use
createKnowledgeCenter(KnowledgeCenter) with a pre-populated
UUID |
java.lang.String[][] |
subscribeKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Subscribes the current user to a specified knowledge center.
|
java.lang.String[][] |
subscribeKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
Subscribes the current user to multiple knowledge centers.
|
java.lang.String[][] |
subscribeKnowledgeCentersWithNote(java.lang.Long[] kcids_,
java.lang.String userNote_)
Deprecated.
Subscribes the current user to the specified knowledge centers.
|
java.lang.String[][] |
subscribeKnowledgeCenterWithNote(java.lang.Long kcid_,
java.lang.String userNote_)
Deprecated.
Subscribes the current user to a specified knowledge center.
|
java.lang.String |
suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_)
Deprecated.
|
java.lang.String |
suggest(java.lang.String query_,
int maxItems_,
SuggestParam[] params_,
java.lang.Boolean groupResults_,
java.lang.Long[] allowList)
Deprecated.
|
void |
unsubscribeKnowledgeCenter(java.lang.Long kcid_)
Deprecated.
Unsubscribes the current user from the specified knowledge center
|
void |
unsubscribeKnowledgeCenters(java.lang.Long[] kcids_)
Deprecated.
Unsubscribes the current user from multiple knowledge centers
|
void |
updateExpirationDaysForKnowledgeCenter(java.lang.Long kcid_,
java.lang.Long days_)
Deprecated.
Updates the information about the number of days after which documents in
the given knowledge center will expire
|
void |
updateExpirationDaysForKnowledgeCenters(java.lang.Long[] kcids_,
java.lang.Long days_)
Deprecated.
Updates the information about the number of days after which documents in
the given knowledge centers will expire
|
void |
updateForumForKnowledgeCenter(KnowledgeCenter knowledgeCenter_)
Deprecated.
Updates the forum associated with a knowledge center
|
void |
updateForumForKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_)
Deprecated.
Updates the forums associated with knowledge centers
|
void |
updateIsSearchableForKnowledgeCenter(java.lang.Long kcid_,
java.lang.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 center
|
void |
updateKnowledgeCenterCreator(java.lang.String username_,
java.lang.Long kcid_)
Deprecated.
Changes the creator of the knowledge center to be the user with the
specified username
|
void |
updateKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_)
Deprecated.
Updates multiple knowledge centers
|
void |
updateRolesForKnowledgeCenter(java.lang.Long kcid_,
java.lang.String[] users_,
int[] roles_,
java.lang.String[] notes_,
java.lang.Long[] groups_,
int[] groupRoles_,
java.lang.String[] groupNotes_)
Deprecated.
Updates the role of the pending access users.
|
static final boolean createKnowledgeCenter$UPDATES
static final boolean createKnowledgeCenters$UPDATES
static final boolean updateKnowledgeCenter$UPDATES
static final boolean updateKnowledgeCenters$UPDATES
static final boolean updateExpirationDaysForKnowledgeCenter$UPDATES
static final boolean updateExpirationDaysForKnowledgeCenters$UPDATES
static final boolean updateForumForKnowledgeCenter$UPDATES
static final boolean updateForumForKnowledgeCenters$UPDATES
static final boolean deleteKnowledgeCenter$UPDATES
static final boolean deleteKnowledgeCenters$UPDATES
static final boolean moveKnowledgeCenter$UPDATES
static final boolean moveKnowledgeCenters$UPDATES
static final boolean getKnowledgeCenter$UPDATES
static final boolean getKnowledgeCenters$UPDATES
static final boolean getKnowledgeCentersPaging$UPDATES
static final boolean getWritableKnowledgeCenters$UPDATES
static final boolean getWritableKnowledgeCentersPaging$UPDATES
static final boolean getWritableFoldersForKnowledgeCenterPaging$UPDATES
static final boolean getAdministratableKnowledgeCentersPaging$UPDATES
static final boolean getKnowledgeCentersForGroup$UPDATES
static final boolean getKnowledgeCentersForGroupPaging$UPDATES
static final boolean getKnowledgeCentersForGroups$UPDATES
static final boolean getKnowledgeCentersForGroupsPaging$UPDATES
static final boolean getKnowledgeCentersForCommunity$UPDATES
static final boolean getKnowledgeCentersForCommunityPaging$UPDATES
static final boolean getKnowledgeCentersForCommunities$UPDATES
static final boolean getKnowledgeCentersForCommunitiesPaging$UPDATES
static final boolean getPersonalKnowledgeCenters$UPDATES
static final boolean getPersonalKnowledgeCentersPaging$UPDATES
static final boolean getSubscribedKnowledgeCenters$UPDATES
static final boolean getSubscribedKnowledgeCentersPaging$UPDATES
static final boolean subscribeKnowledgeCenter$UPDATES
static final boolean subscribeKnowledgeCenterWithNote$UPDATES
static final boolean subscribeKnowledgeCentersWithNote$UPDATES
static final boolean subscribeKnowledgeCenters$UPDATES
static final boolean unsubscribeKnowledgeCenter$UPDATES
static final boolean unsubscribeKnowledgeCenters$UPDATES
static final boolean getSubscriptionRequests$UPDATES
static final boolean rejectSubscriptions$UPDATES
static final boolean getAllFoldersPaging$UPDATES
static final boolean getAllFolders$UPDATES
static final boolean getRootFolders$UPDATES
static final boolean getRootFoldersPaging$UPDATES
static final boolean getFoldersRequiringApproval$UPDATES
static final boolean getFoldersRequiringApprovalPaging$UPDATES
static final boolean getDocumentsRequiringApproval$UPDATES
static final boolean getDocumentsRequiringApprovalPaging$UPDATES
static final boolean getVersionsRequiringApproval$UPDATES
static final boolean getVersionsRequiringApprovalPaging$UPDATES
static final boolean getExpiredDocuments$UPDATES
static final boolean getExpiredDocumentsPaging$UPDATES
static final boolean notifyExpiredDocuments$UPDATES
static final boolean notifyExpiredDocumentsForKnowledgeCenter$UPDATES
static final boolean isKnowledgeCenterEmpty$UPDATES
static final boolean getParentCommunities$UPDATES
static final boolean getParentCommunitiesPaging$UPDATES
static final boolean getFavoriteKnowledgeCenters$UPDATES
static final boolean getFavoriteKnowledgeCentersPaging$UPDATES
static final boolean addKnowledgeCenterToFavorites$UPDATES
static final boolean addKnowledgeCentersToFavorites$UPDATES
static final boolean removeKnowledgeCenterFromFavorites$UPDATES
static final boolean removeKnowledgeCentersFromFavorites$UPDATES
static final boolean getUserStatusForKnowledgeCenter$UPDATES
static final boolean getUserStatusForKnowledgeCenters$UPDATES
static final boolean getAccessLevelForKnowledgeCenter$UPDATES
static final boolean getAccessLevelForKnowledgeCenters$UPDATES
static final boolean updateRolesForKnowledgeCenter$UPDATES
static final boolean setRoleMapForKnowledgeCenter$UPDATES
static final boolean getRoleMapForKnowledgeCenter$UPDATES
static final boolean browseKnowledgeCenters$UPDATES
static final boolean browseKnowledgeCentersPaging$UPDATES
static final boolean addAdminToKnowledgeCenter$UPDATES
static final boolean updateKnowledgeCenterCreator$UPDATES
static final boolean searchKnowledgeCenters$UPDATES
static final boolean searchKnowledgeCentersPaging$UPDATES
static final boolean getDescendantDocumentsOfKnowledgeCenterPaging$UPDATES
static final boolean getDescendantDocumentsOfKnowledgeCentersPaging$UPDATES
static final boolean getFolderTreeViewForKnowledgeCenter$UPDATES
static final boolean getFolderTreeViewForKnowledgeCenters$UPDATES
static final boolean getKnowledgeCentersList$UPDATES
static final boolean doesPrivateKnowledgeCenterExist$UPDATES
static final boolean createPrivateKnowledgeCenter$UPDATES
static final boolean getSystemKnowledgeCenterId$UPDATES
static final boolean setSystemKnowledgeCenterId$UPDATES
static final boolean suggest$UPDATES
static final boolean deleteStatisticsKnowledgeCenter$UPDATES
static final boolean getContentIdForKnowledgeCenterId$UPDATES
static final boolean getContentIdsForKnowledgeCenterIds$UPDATES
static final boolean getKnowledgeCenterIdForContentId$UPDATES
static final boolean getKnowledgeCenterIdsForContentIds$UPDATES
static final boolean updateIsSearchableForKnowledgeCenter$UPDATES
java.lang.Long createKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidCommunityException
knowledgeCenter_
- a KnowledgeCenter
object which should contain
all of the information required to create a
valid KnowledgeCenter
.
Minimum required fields: name
,
description
, changesRequireApproval
,
searchable
,
autoApproveForReadOnlyAccess
,type
KnowledgeCenter
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 occursjava.lang.Long[] createKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidCommunityException
knowledgeCenters_
- an array of KnowledgeCenter
objects which should
contain minimum information required to create a valid
KnowledgeCenter
. Minimum required fields:
name
,
description
, changesRequireApproval
,
searchable
,
autoApproveForReadOnlyAccess
,type
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 occursvoid updateKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
knowledgeCenter_
- a KnowledgeCenter
object which contains
information to be updated. Minimum required fields:
name
,
description
, changesRequireApproval
,
isSearchable
,
autoApproveForReadOnlyAccess
,
id
,creator
.InvalidUserException
- if the user making this call is an invalid user.PrivilegeException
- if the User
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 occursvoid updateKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
knowledgeCenters_
- a list of KnowledgeCenter
objects which should
contain minimum information required to update a
KnowledgeCenter
. Minimum required fields:
name
,
description
,changesRequireApproval
,
isSearchable
,
autoApproveForReadOnlyAccess
,
id
, creator
.InvalidUserException
- if the user making this call is an invalid user.PrivilegeException
- if the User
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 occursvoid updateExpirationDaysForKnowledgeCenter(java.lang.Long kcid_, java.lang.Long days_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerdays_
- the number of days after which documents in the knowledge center
will expireInvalidUserException
- if the user making this call is an invalid user.PrivilegeException
- if the User
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 occursupdateAllChildrenAndVersionsVisibility
void updateExpirationDaysForKnowledgeCenters(java.lang.Long[] kcids_, java.lang.Long days_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
kcids_
- the uniques IDs of the knowledge centersdays_
- the number of days after which documents in the knowledge centers
will expireInvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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 occursupdateAllChildrenAndVersionsExpiration
void updateForumForKnowledgeCenter(KnowledgeCenter knowledgeCenter_) throws InvalidKnowledgeCenterException
knowledgeCenter_
- a KnowledgeCenter
object which should contain
all of the information required to update the Forum
associated with KnowledeCenter
.
Minimum required fields: name
,
description
,changesRequireApproval
,
isSearchable
,
autoApproveForReadOnlyAccess
, id
,
forum
.
If Forum
is set to null
,
this removes any forum associations.InvalidKnowledgeCenterException
- if the ID of the knowledge center
does not correspond a valid knowledge centerServiceException
- if any system-level error occursvoid updateForumForKnowledgeCenters(KnowledgeCenter[] knowledgeCenters_) throws InvalidKnowledgeCenterException
knowledgeCenters_
- a list of KnowledgeCenter
objects containing all of
the information required to update the Forum
s associated
with the KnowledgeCenter
s. Minimum required fields:
name
, description
,
changesRequireApproval
, isSearchable
,
autoApproveForReadOnlyAccess
, id
,
forum
.
If Forum
is set to null
, this removes
any forum associations.InvalidKnowledgeCenterException
- if any of the IDs of the knowledge centers does not correspond to
a valid knowledge centerServiceException
- if any system-level error occursvoid deleteKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, PrivilegeException, NotEmptyException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge center to be deletedInvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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 occursvoid deleteKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, PrivilegeException, NotEmptyException, InvalidKnowledgeCenterException
kcids_
- an array of the unique IDs of the knowledge centers to be deleted.InvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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 occursvoid moveKnowledgeCenter(java.lang.Long kcid_, java.lang.Long coid_) throws InvalidCommunityException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge center to be movedcoid_
- the unique ID of the community to which to move the knowledge
centerInvalidCommunityException
- 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 occursvoid moveKnowledgeCenters(java.lang.Long[] kcids_, java.lang.Long coid_) throws InvalidCommunityException, InvalidKnowledgeCenterException
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
centerInvalidCommunityException
- 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 occursKnowledgeCenter getKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerInvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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@Deprecated KnowledgeCenter[] getKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
getKnowledgeCentersPaging(Long[], int, int, Integer, Integer)
insteadkcids_
- an array containing the unique IDs of the knowledge centers to be
retrievedInvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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 occursResultPage getKnowledgeCentersPaging(java.lang.Long[] kcids_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
ResultPage
contaning a list of the
knowledge centers with the unique IDs specifiedkcids_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects
This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects for the specified IDs.InvalidUserException
- if the user making this call is an invalid userPrivilegeException
- if the User
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@Deprecated KnowledgeCenter[] getWritableKnowledgeCenters() throws InvalidUserException
getWritableKnowledgeCentersPaging(int, int, Integer, Integer)
insteadInvalidUserException
- if the user making this call is an invalid userServiceException
- if any system-level error occursResultPage getWritableKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
containing a list of the knowledge centers
to which the current user has editor privileges or greater.startPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
Objects.InvalidUserException
- if the user making this call is an invalid userServiceException
- if any system-level error occursResultPage getWritableFoldersForKnowledgeCenterPaging(java.lang.Long kcId_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
ResultPage
containing a list of the Folder
objects in the knowledge center with the given ID to which the
current user has editor privileges or greaterkcId_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Folder
.sortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Folder
objects.InvalidUserException
- if the user making this call is an invalid userInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the User
does not have view privileges to the
specified knowledge centerServiceException
- if any system-level error occursResultPage getAdministratableKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
ResultPage
containing a list of the
knowledge centers to which the current user has administrator privileges,
and to which the current user is subscribedstartPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects.ServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getKnowledgeCentersForGroup(java.lang.Long gid_)
getKnowledgeCentersForGroupPaging(Long, int, int, Integer, Integer)
insteadgid_
- the unique ID of the groupServiceException
- if any system-level error occursResultPage getKnowledgeCentersForGroupPaging(java.lang.Long gid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
ResultPage
containing a list of
knowledge centers to which a given group has accessgid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects.ServiceException
- if any system-level error occursKnowledgeCenter[] getKnowledgeCentersForGroups(java.lang.Long[] gids_)
getKnowledgeCentersForGroupsPaging
should be used
instead.gids_
- a list containing the unique IDs of the groupsServiceException
- if any system-level error occurs
deprecated use
getKnowledgeCentersForGroupsPaging(Long[], int, int, Integer, Integer)
insteadResultPage getKnowledgeCentersForGroupsPaging(java.lang.Long[] gids_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
ResultPage
contaning a list of
knowledge centers to which the specified groups have accessgids_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects, representing the knowledge
centers to which the specified groups have accessServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getKnowledgeCentersForCommunity(java.lang.Long coid_) throws InvalidCommunityException
getKnowledgeCentersForCommunityPaging(Long, int, int, Integer, Integer)
insteadcoid_
- the unique ID of the Community
InvalidCommunityException
- if the ID does not correspond to a valid communityServiceException
- if any system-level error occursResultPage getKnowledgeCentersForCommunityPaging(java.lang.Long coid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidCommunityException
ResultPage
containing the list of knowledge centers
contained within a given communitycoid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects, representing the knowledge
centers within a particular communityInvalidCommunityException
- if the ID does not correspond to a valid communityServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getKnowledgeCentersForCommunities(java.lang.Long[] coids_) throws InvalidCommunityException
getKnowledgeCentersForCommunitiesPaging(Long[], int, int, Integer, Integer)
insteadcoids_
- an array of unique community IDsInvalidComunityException
- if any of the IDs does not correspond to a valid communityServiceException
- if any system-level error occursInvalidCommunityException
ResultPage getKnowledgeCentersForCommunitiesPaging(java.lang.Long[] coids_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidCommunityException
ResultPage
containing a list of
KnowledgeCenter
objects for given Community
IDscoids_
- a list of unique Community
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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects representing the knowledge centers
contained within the given communitiesInvalidCommunityException
- if any of the IDs does not correspond to a valid communityServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getPersonalKnowledgeCenters() throws InvalidUserException
getPersonalKnowledgeCentersPaging(int, int, Integer, Integer)
insteadInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursResultPage getPersonalKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
containing the current user's
private knowledge centersstartPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects, representing the current
user's private knowledge centers.InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getSubscribedKnowledgeCenters() throws InvalidUserException
getSubscribedKnowledgeCentersPaging(int, int, Integer, Integer)
insteadInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursResultPage getSubscribedKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
containing the list of knowledge centers
to which the current user is subscribedstartPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects, representing the knowledge
centers to which the current user is subscribed.InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursjava.lang.String[][] subscribeKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
String
array of resulting pending knowledge center names and
the second index of which is a String
array of subscribed
knowledge center names (eg if the user is automatically subscribed, the
first index will be an empty String
array and the second index
will be a String
array of length 1 containing the name of the
knowledge center corresponding to kcid_
)kcid_
- the unique ID of the knowledge centerString
array of resulting pending knowledge center
names and the second index of which is a String
array
of resulting subscribed knowledge center namesInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
does not already have access to knowledge
center and the knowledge center is not set for
autoApprovalForReadOnlyAccess and the owner of knowledge center
cannot administer the subscription requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursjava.lang.String[][] subscribeKnowledgeCenterWithNote(java.lang.Long kcid_, java.lang.String userNote_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
String
array of resulting pending knowledge center names and
the second index of which is a String
array of subscribed
knowledge center names (eg if the user is automatically subscribed, the
first index will be an empty String
array and the second index
will be a String
array of length 1 containing the name of the
knowledge center corresponding to kcid_
)kcid_
- the unique ID of the knowledge centeruserNote_
- a note from the user regarding why he is requesting accessString
array of resulting pending knowledge center
names and the second index of which is a String
array
of resulting subscribed knowledge center namesInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
does not already have access to knowledge
center and the knowledge center is not set for
autoApprovalForReadOnlyAccess and the owner of knowledge center
cannot administer the subscription requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursjava.lang.String[][] subscribeKnowledgeCentersWithNote(java.lang.Long[] kcids_, java.lang.String userNote_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
String
array of resulting pending knowledge center names and
the second index of which is a String
array of subscribed
knowledge center names (eg if the user is automatically subscribed, the
first index will be an empty String
array and the second index
will be a String
array of length 1 containing the name of the
knowledge center corresponding to kcid_
)kcids_
- array with the unique IDs of the knowledge centers.userNote_
- a note from the user regarding why he is requesting accessString
array of resulting pending knowledge center
names and the second index of which is a String
array
of resulting subscribed knowledge center namesInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
does not already have access to knowledge
center and the knowledge center is not set for
autoApprovalForReadOnlyAccess and the owner of knowledge center
cannot administer the subscription requestInvalidKnowledgeCenterException
- if an ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursjava.lang.String[][] subscribeKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
String
array of
resulting pending knowledge center names and the second index of which is a
String
array of subscribed knowledge center nameskcids_
- an array containing the unique knowledge center IDsString
array of resulting pending knowledge center
names and the 2nd index of which is a String
array of
subscribed knowledge center namesInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
does not already have access to knowledge
center and the knowledge center is not set for
autoApprovalForReadOnlyAccess and the owner of knowledge center
cannot administer the subscription requestInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledgeServiceException
- if any system-level error occursvoid unsubscribeKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursvoid unsubscribeKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
kcids_
- an array of unique knowledge center IDsInvalidUserException
- 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 occursjava.lang.String[] getSubscriptionRequests(java.lang.Long kcid_)
kcid_
- the unique ID of the knowledge centerServiceException
- if any system-level error occursvoid rejectSubscriptions(java.lang.Long kcid_, java.lang.String[] users_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
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
rejectedInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
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 occursResultPage getAllFoldersPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
ResultPage
containing all of the folders in a
knowledge center (including the sub-folders of the direct child folders of
the knowledge center)kcid_
- the unique ID of the KnowledgeCenter
startPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Folder
.sortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing Folder
objects,
representing all of the folders in the knowledge centerInvalidUserException
- 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@Deprecated Folder[] getAllFolders(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
getAllFoldersPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the knowledge centerInvalidUserException
- 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@Deprecated Folder[] getRootFolders(java.lang.Long kcid_, java.lang.Integer sortOrder_, java.lang.String sortColumn_, int startIndex_, int scrollLength_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException, InvalidDocumentException, InvalidFolderException
getRootFoldersPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the knowledge centersortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
sortColumn_
- the property by which the results will be sorted. This is one of
the SORT_COLUMN_XXX
constants in
Folder
.startIndex_
- the starting index of the first Folder
to returnscrollLength_
- the number of consecutive Folder
objects to
return after the firstInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
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 occursResultPage getRootFoldersPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
ResultPage
containing all of the folders that
are the direct children of the given knowledge centerkcid_
- the unique ID of the KnowledgeCenter
startPosition_
- the
the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Folder
.sortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Folder
objects, representing the root folders.InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the User
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@Deprecated Folder[] getFoldersRequiringApproval(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
getFoldersRequiringApprovalPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getFoldersRequiringApprovalPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
ResultPage
containing a list of requiring approval
(for creation or deletion) for the given knowledge centerkcid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Folder
.sortOrder_
- the order in which to sort the returned
Folder
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Folder
objects, representing the folders tha require
approval for the given knowledge center.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@Deprecated Document[] getDocumentsRequiringApproval(java.lang.Long kcid_) throws InvalidKnowledgeCenterException
getDocumentsRequiringApprovalPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the KnowledgeCenter
InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getDocumentsRequiringApprovalPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidKnowledgeCenterException
ResultPage
containing the list of documents requiring
approval (both for creation and deletion) for a knowledge centerkcid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Document
.sortOrder_
- the order in which to sort the returned
Document
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of documents requiring
approval for the knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs@Deprecated Document[] getVersionsRequiringApproval(java.lang.Long kcid_) throws InvalidKnowledgeCenterException
getVersionsRequiringApprovalPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the KnowledgeCenter
InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getVersionsRequiringApprovalPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidKnowledgeCenterException
ResultPage
contaning a list of document
versions requiring approval (both for creation and deletion) for a
specified knowledge centerkcid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Document
.sortOrder_
- the order in which to sort the returned
Document
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Document
objects, representing the versions requiring
approval for a knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs@Deprecated Document[] getExpiredDocuments(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
getExpiredDocumentsPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getExpiredDocumentsPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
ResultPage
containing a list of all expired
documents in the specified knowledge centerkcid_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Document
.sortOrder_
- the order in which to sort the returned
Document
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Document
objects, representing the expired documents
in the knowledge center.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 occursvoid notifyExpiredDocuments(java.lang.Double days_, java.lang.Boolean notifyCreator_, java.lang.Boolean notifyUsers_, java.lang.Boolean notifyGroups_) throws InvalidUserException, PrivilegeException
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 kcInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the User
does not have rights to administer the
content rootServiceException
- if any system-level error occursvoid notifyExpiredDocuments(java.lang.Double[] days_, java.lang.Boolean notifyCreator_, java.lang.Boolean notifyUsers_, java.lang.Boolean notifyGroups_) throws InvalidUserException, PrivilegeException
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 kcInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the User
does not have rights to administer the
content rootServiceException
- if any system-level error occursvoid notifyExpiredDocumentsForKnowledgeCenter(java.lang.Long knowledgeCenterId_, java.lang.Double days_, java.lang.Boolean notifyCreator_, java.lang.Boolean notifyUsers_, java.lang.Boolean notifyGroups_) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
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 kcInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the User
does not have rights to administer the
specified knowledge centerServiceException
- if any system-level error occursvoid notifyExpiredDocumentsForKnowledgeCenter(java.lang.Long knowledgeCenterId_, java.lang.Double[] days_, java.lang.Boolean notifyCreator_, java.lang.Boolean notifyUsers_, java.lang.Boolean notifyGroups_) throws InvalidUserException, InvalidKnowledgeCenterException, PrivilegeException
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 kcInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the User
does not have rights to administer the
specified knowledge centerServiceException
- if any system-level error occursboolean isKnowledgeCenterEmpty(java.lang.Long kcid_) throws InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centertrue
, if the knowledge center contains no
folders; false
otherwise.InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs@Deprecated Community[] getParentCommunities(java.lang.Long kcid_) throws InvalidKnowledgeCenterException
getParentCommunitiesPaging(Long, int, int, Integer, Integer)
insteadkcid_
- the unique ID of the knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getParentCommunitiesPaging(java.lang.Long kcid_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidKnowledgeCenterException
ResultPage
containing a list of the
communities which are the parents of a specified knowledge center. If the
knowledge center's direct parent community does not itself have any
parents, the length of the returned array will be 1. If the knowledge
center is private, the returned array will be zero-length.kcid_
- the unique ID of the knowledge center.startPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Community
.sortOrder_
- the order in which to sort the returned
Community
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
Community
objects, representing the parent communities
of this knowledge center.InvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occurs@Deprecated KnowledgeCenter[] getFavoriteKnowledgeCenters(java.lang.Integer sortOrder_, java.lang.String sortColumn_) throws InvalidUserException
getFavoriteKnowledgeCentersPaging(int, int, Integer, Integer)
insteadsortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
sortColumn_
- the property by which the results will be sorted. This is one of
the SORT_COLUMN_XXX
constants in
KnowledgeCenter
.InvalidUserException
- if the user making this call is an invalid user.ServiceException
- if any system-level error occursResultPage getFavoriteKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
containing the knowledge
centers which the current user has added to their "Favorites" liststartPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
KnowledgeCenter
objects, representing the current user's favorite knowledge centersInvalidUserException
- if the user making this call is an invalid user.ServiceException
- if any system-level error occursvoid addKnowledgeCenterToFavorites(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
kcid_
- the unique ID for the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursvoid addKnowledgeCentersToFavorites(java.lang.Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidDataFormatException
kcids_
- a list containing the unique IDs of the knowledge centersInvalidUserException
- 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
void removeKnowledgeCenterFromFavorites(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
kcid_
- the unique ID for the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursvoid removeKnowledgeCentersFromFavorites(java.lang.Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException, InvalidDataFormatException
kcids_
- a list containing the unique IDs of the knowledge centersInvalidUserException
- 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
java.lang.Long getUserStatusForKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerUSER_STATUS_XXX
constants in
KnowledgeCenter
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 occursjava.lang.Long[] getUserStatusForKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
kcids_
- a list containing the unique IDs of the knowledge centersUSER_STATUS_XXX
constants in
KnowledgeCenter
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 occursint getAccessLevelForKnowledgeCenter(java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerACCESS_LEVEL_XXX
constants in
KnowledgeCenter
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 occursint[] getAccessLevelForKnowledgeCenters(java.lang.Long[] kcids_) throws InvalidUserException, InvalidKnowledgeCenterException
kcids_
- the unique IDs of the knowledge centersACCESS_LEVEL_XXX
constants
in KnowledgeCenter
InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centervoid updateRolesForKnowledgeCenter(java.lang.Long kcid_, java.lang.String[] users_, int[] roles_, java.lang.String[] notes_, java.lang.Long[] groups_, int[] groupRoles_, java.lang.String[] groupNotes_) throws InvalidUserException, InvalidKnowledgeCenterException, com.appiancorp.kougar.mapper.exceptions.ParameterException, PrivilegeException
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 levelInvalidUserException
- 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 the User
does not already have access to knowledge
center and the knowledge center is not set for
autoApprovalForReadOnlyAccess and the owner of knowledge center
cannot administer the subscription requestInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centervoid setRoleMapForKnowledgeCenter(java.lang.Long kcid_, CollaborationRoleMap crm_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException, InvalidGroupException
KnowledgeCenter
is insufficient.)kcid_
- the unique ID of the knowledge centercrm_
- a CollaborationRoleMap
object that contains the
permissions to be applied to this knowledge centerInvalidUserException
- 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 the User
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 groupCollaborationRoleMap getRoleMapForKnowledgeCenter(java.lang.Long kcid_) throws InvalidKnowledgeCenterException, PrivilegeException
kcid_
- the unique ID of the knowledge centerCollaborationRoleMap
object that contains the
permissions for this knowledge centerInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerPrivilegeException
- if the user does not have enough privileges to access the KC@Deprecated KnowledgeCenter[] browseKnowledgeCenters(int startIndex_, int scrollLength_) throws InvalidUserException
browseKnowledgeCentersPaging(int, int, Integer, Integer)
insteadstartIndex_
- 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
firstInvalidUserException
- if the user calling this method is invalidResultPage browseKnowledgeCentersPaging(int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
containing knowledge centers, each of
which meets the following criteria:
startPosition_
- the index into the collection of total results at which to
start. Negative numbers are treated as zeros.batchSize_
- the number of results to return.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects that meet the given criteriaInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursvoid addAdminToKnowledgeCenter(java.lang.String username_, java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
username_
- -
the username of the user to be added as administrator of the
knowledge centerkcid_
- -
the ID of the knowledge centerInvalidUserException
- 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 occursvoid updateKnowledgeCenterCreator(java.lang.String username_, java.lang.Long kcid_) throws InvalidUserException, InvalidKnowledgeCenterException
username_
- the username of the user to designate as creator of the
knowledge centerkcid_
- the ID of the knowledge centerInvalidUserException
- 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@Deprecated KnowledgeCenter[] searchKnowledgeCenters(java.lang.String searchTerm_, int startIndex_, int scrollLength_) throws InvalidUserException
searchTerm_
- the search querystartIndex_
- the starting index of the first knowledge center to returnscrollLength_
- the number of consecutive knowledge centers to return after the
firstInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursResultPage searchKnowledgeCentersPaging(java.lang.String searchterm_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
ResultPage
of knowledge centers which have names
matching given search term. The search finds all knowledge centers that
have the matching string anywhere in the name of knowledge center.
for eg: search for om* will return all knowledge centers whose names are
some, myHome, ommm etcsearchterm_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
KnowledgeCenter
.sortOrder_
- the order in which to sort the returned
KnowledgeCenter
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing a list of
KnowledgeCenter
objects, representing knowledge centers
that match the search terms.InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursResultPage getDescendantDocumentsOfKnowledgeCenterPaging(java.lang.Long knowledgeCenterId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
ResultPage
containing a list of all documents in a given
knowledge centerknowledgeCenterId_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Document
.sortOrder_
- the order in which to sort the returned
Document
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
results in descending orderResultPage
containing the list of
Document
objects representing the document
descendants of the knowledge centerInvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerServiceException
- if any system-level error occursResultPage getDescendantDocumentsOfKnowledgeCentersPaging(java.lang.Long[] knowledgeCenterIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidKnowledgeCenterException
ResultPage
containing a list of all documents in a given
list of knowledge centersknowledgeCenterIds_
- 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.
Use Constants.COUNT_ALL
to return
the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of
the SORT_BY_XXX
constants in
Document
.sortOrder_
- the order in which to sort the returned
Document
objects. This is either
Constants.SORT_ORDER_ASCENDING
or
Constants.SORT_ORDER_DESCENDING
ResultPage
containing the list of
Document
objects representing the document descendants
of the given knowledge centersInvalidUserException
- 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 occursTreePivot getFolderTreeViewForKnowledgeCenter(java.lang.Long knowledgeCenterId_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, java.lang.IllegalArgumentException
TreePivot
will all be
Folder
objects for which the current user
has the specified accessLevel_
, or a greater access
level. (Eg if accessLevel_
is
KnowledgeCenter.ACCESS_LEVEL_READ_WRITE
, all folders for which the
current user has write access and also administrative access will be
returned.)
No Document
objects will be returned as children of the
TreePivot
.knowledgeCenterId_
- the ID of the knowledge centeraccessLevel_
- the accessLevel which the current user must have for the
child folders of the knowledge centerTreePivot
, pivoted at the specified knowledge
center. The _subtree field of TreePivot
points to
TreeNode
object which might be either
KnowledgeCenter, Document, Folder or Community.
* The Id
field maps to the ID of objects mentioned above,
name
maps to object name and data
maps
to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY,
TYPE_KNOWLEDGE_CENTER constants in ObjectTypeMapping
.
The _breadcrumbs field points to the path of the object from the
root.InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if the ID does not correspond to a valid knowledge centerjava.lang.IllegalArgumentException
- if accessLevel_
is not one
of:
ServiceException
- if any system-level error occursTreePivot[] getFolderTreeViewForKnowledgeCenters(java.lang.Long[] knowledgeCenterIds_, int accessLevel_) throws InvalidUserException, InvalidKnowledgeCenterException, java.lang.IllegalArgumentException
TreePivot
objects will all be
Folder
objects for which the current user has
the specified accessLevel_
, or a greater
access level. (Eg if accessLevel_
is
KnowledgeCenter.ACCESS_LEVEL_READ_WRITE
, all Folder
objects for which the current user has write access and also
administrative access will be returned.)
No Document
objects will be returned as children of the
TreePivot
objects.knowledgeCenterIds_
- the IDs of the knowledge centersaccessLevel_
- the accessLevel which the current user must have
for the child folders of the knowledge centersTreePivot
objects, each pivoted at one of
the specified knowledge centers.
The _subtree field of each TreePivot
points to
TreeNode
object which might be either
KnowledgeCenter, Document, Folder or Community.
* The Id
field maps to the ID of objects mentioned above,
name
maps to object name and data
maps
to either of the TYPE_DOCUMENT, TYPE_FOLDER, TYPE_COMMUNITY,
TYPE_KNOWLEDGE_CENTER constants in ObjectTypeMapping
.
The _breadcrumbs field points to the path of the object from the
root.InvalidUserException
- if the user calling this method is invalidInvalidKnowledgeCenterException
- if any of the IDs does not correspond to a valid knowledge centerjava.lang.IllegalArgumentException
- if accessLevel_
is not one
of:
ServiceException
- if any system-level error occursResultList getKnowledgeCentersList(java.lang.Long[] ids_) throws InvalidUserException
ResultList
containing result codes for all given IDs
and KnowledgeCenter
objects for valid IDsids_
- the IDs of knowledge centers to retrieveResultList
containing KnowledgeCenter
objects and result codes. Each result code will be one of the
CODE_XXX
or COLLAB_CODE_XXX
constants in ResultList
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursboolean doesPrivateKnowledgeCenterExist()
true
if a private knowledge center exists for the
user; false
otherwise.ServiceException
- if any system-level error occursvoid createPrivateKnowledgeCenter()
ServiceException
- if any system-level error occurs@Deprecated java.lang.Long getSystemKnowledgeCenterId(java.lang.String name_) throws InvalidKnowledgeCenterException
ContentService.getIdByUuid(String)
and
getKnowledgeCenterIdForContentId(Long)
name
- A case-insensitive system name.InvalidKnowledgeCenterException
- if the string is not recognized@Deprecated void setSystemKnowledgeCenterId(java.lang.String name_, java.lang.Long id_) throws InvalidKnowledgeCenterException
createKnowledgeCenter(KnowledgeCenter)
with a pre-populated
UUIDid
value with the specified
name
key.name
- A case-insensitive system name.id
- The knowledge center id.InvalidKnowledgeCenterException
- if the string is not recognized.java.lang.String suggest(java.lang.String query_, int maxItems_, SuggestParam[] params_, java.lang.Boolean groupResults_)
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.java.lang.String suggest(java.lang.String query_, int maxItems_, SuggestParam[] params_, java.lang.Boolean groupResults_, java.lang.Long[] allowList)
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.void deleteStatisticsKnowledgeCenter(java.lang.Long kcid_) throws InvalidKnowledgeCenterException
kcid
- knowledge center whose statistics should be deletedInvalidKnowledgeCenterException
void deleteStatisticsKnowledgeCenter(java.lang.Long[] kcid_) throws InvalidKnowledgeCenterException
kcid
- knowledge centers whose statistics should be deletedInvalidKnowledgeCenterException
java.lang.Long getContentIdForKnowledgeCenterId(java.lang.Long id_)
java.lang.Long[] getContentIdsForKnowledgeCenterIds(java.lang.Long[] id_)
java.lang.Long getKnowledgeCenterIdForContentId(java.lang.Long id_)
java.lang.Long[] getKnowledgeCenterIdsForContentIds(java.lang.Long[] id_)
void updateIsSearchableForKnowledgeCenter(java.lang.Long kcid_, java.lang.Boolean isHierachySearchable_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
kcid_
- the unique ID of the knowledge centerisHierachySearchable_
- specifies whether the KC as well as its contents will be
searchable.InvalidUserException
- if the user making this call is an invalid user.PrivilegeException
- if the User
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 occursCopyright © 2003-2024 Appian Corporation. All Rights Reserved.