Interface FolderService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
This interface provides services for other applications using methods related to collaboration folders
Methods of service classes can all throw the unchecked exception
ServiceException
if any
system-level error (for example, server failure) occurs, and will in general
throw a checked exception (InvalidXXXException
) when an entity
to be retrieved is inaccessible, instead of returning null
.
Exceptions to this paradigm (including the use of ResultList
as
described below) are noted. All checked exceptions extend
AppianException
.
It may be necessary to retrieve a subset of results as opposed to an entire
collection, and also to sort the subset by some property of the returned
object. "Paging" methods which return a
ResultPage
are provided in certain
instances for this purpose. The ResultPage
will contain the
sorted subset of results
(via Result.getResults()
), and the
total number of items in the available result set
(via ResultPage.getAvailableItems()
).
It may also be necessary to retrieve some results, even if all results
cannot be retrieved (for instance, some of the entities corresponding
to a list of entity IDs may no longer exist). Methods which return a
ResultList
are provided for this
purpose. The Result.getResults()
method in this case will return all results which can be retrieved. In
addition, there will be a list of result codes
(ResultList.getResultCodes()
) that
represent the successful retrieval of an entity, or, if the entity could
not be retrieved, the reason for the failure. See the CODE_XXX
constants in ResultList
for details.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addFoldersToFavorites
(Long[] foids_) Deprecated.Adds multiple folders to the current user's "Favorites" list.void
addFolderToFavorites
(Long foid_) Deprecated.Adds a folder to the current user's "Favorites" list.Long[]
approveChangesForFolder
(Long foid_) Deprecated.Approves the creation or deletion of a folder (within a knowledge center for which changes require approval).Long[]
approveChangesForFolders
(Long[] foids_) Deprecated.Approves the creation or deletion of multiple folders (within a knowledge center for which changes require approval).createFolder
(Folder folder_) Deprecated.Creates a new folderLong[]
createFolders
(Folder[] folders_) Deprecated.Creates multiple foldersvoid
deleteFolder
(Long foid_) Deprecated.Deletes a foldervoid
deleteFolders
(Long[] foids_) Deprecated.Deletes multiple foldersfindAdministratableFoldersPaging
(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user is an administrator (ie has an access level ofFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.findReadableFoldersPaging
(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user has read privileges or greater (ie an access level ofFolder.ACCESS_LEVEL_READ_ONLY
orFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.findWritableFoldersPaging
(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user has author privileges or greater (ie an access level ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.int
getAccessLevelForFolder
(Long foid_) Deprecated.Retrieves the current user's access level for a folderint[]
getAccessLevelForFolders
(Long[] foids_) Deprecated.Retrieves the current user's access levels for multiple foldersDocument[]
getChildDocuments
(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) getChildDocumentsPaging
(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the direct child documents of a folderFolder[]
getChildFolders
(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) getChildFoldersPaging
(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the direct child folders of a folderDeprecated.Long[]
Deprecated.getDescendantDocumentsOfFolderPaging
(Long folderId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get a flat list of all documents in a given folder and its subfoldersgetDescendantDocumentsOfFoldersPaging
(Long[] folderIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Get a flat list of all documents in a list of folders and their subfoldersDocument[]
getDocumentsByName
(Long folderId, String name) Deprecated.This call will retrieve all documents of a given folder that have a given name.Folder[]
getFavoriteFolders
(Integer sortOrder_, String sortColumn_) getFavoriteFoldersPaging
(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieve all the folders that are in the current user's "Favorites" list.Deprecated.Gets information about a folderDeprecated.Long[]
Deprecated.Folder[]
getFolders
(Long[] foids_) getFoldersList
(Long[] folderIds_) Deprecated.Returns a ResultList containing error codes for each value supplied in the parameter andFolder
objects for each value which corresponds to a valid foldergetFoldersPaging
(Long[] foids_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Gets Information about multiple foldersgetFullPathStringToFolder
(Long folderId_, String pathSeparator_) Deprecated.Gets the path to a folder through the Collaboration navigation tree.String[]
getFullPathStringToFolders
(Long[] folderIds_, String pathSeparator_) Deprecated.Gets the path to a list of folders through the Collaboration navigation tree.Deprecated.This call will retrieve the folder named ###my_process_views under the current users private knowledge center.Deprecated.This call will retrieve the folder named ###my_reports under the current users private knowledge center.Deprecated.This call will retrieve the folder named ###my_task_views under the current users private knowledge center.Folder[]
getParentFolders
(Long foid_) getParentFoldersPaging
(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves the breadcrumbs to a folder (that is, the parent folders of a given folder, and also the folder itself).Deprecated.This call will retrieve the folder named ###personalized_task_views under the current users private knowledge center.getRoleMapForFolder
(Long foid_) Deprecated.Retrieves theCollaborationRoleMap
for a given foldergetSystemFolderId
(String name) Deprecated.getTreeViewForFolder
(Long folderId_, int descendantDepth_) Deprecated.Get the tree pivoted at a particular folder.getTreeViewForFolders
(Long[] folderIds_, int descendantDepth_) Deprecated.Get the trees pivoted at particular folders.getWritableFoldersForFolderPaging
(Long folderId_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Retrieves a list of sub-folders of a folder, for which the current user has an access level ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
boolean
isFolderEmpty
(Long foid_) Deprecated.Checks whether a folder contains any children (documents or sub-folders)void
rejectChangesForFolder
(Long foid_) Deprecated.Rejects the creation or deletion of a folder (within a knowledge center for which changes require approval).void
rejectChangesForFolders
(Long[] foids_) Deprecated.Rejects the creation or deletion of multiple folders (within a knowledge center for which changes require approval).void
removeFolderFromFavorites
(Long foid_) Deprecated.Removes a folder from the current user's "Favorites" listvoid
removeFoldersFromFavorites
(Long[] foids_) Deprecated.Removes multiple folders from the current user's "Favorites" listvoid
setRoleMapForFolder
(Long foid_, CollaborationRoleMap crm_) Deprecated.Set theCollaborationRoleMap
for a given folder If the role map is not set for a folder, by default it inherits the permissions specified in the role map from its parent knowledge centervoid
setSystemFolderId
(String name, Long id) Deprecated.usecreateFolder(Folder)
with a pre-populated UUIDsuggest
(String query, int maxItems, SuggestParam[] params, Boolean groupResults) Deprecated.suggest
(String query, int maxItems, SuggestParam[] params, Boolean groupResults, Long[] allowList) Deprecated.void
updateFolder
(Folder folder_) Deprecated.Updates a foldervoid
updateFolders
(Folder[] folders_) Deprecated.Updates the information stored about multiple foldersvoid
updateForumForFolder
(Folder folder_) Deprecated.Updates the forum ID associated with a foldervoid
updateForumForFolders
(Folder[] folders_) Deprecated.Updates the forums associated with an array of foldersMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
getFolder$UPDATES
static final boolean getFolder$UPDATESDeprecated.- See Also:
-
getFolders$UPDATES
static final boolean getFolders$UPDATESDeprecated.- See Also:
-
getFoldersPaging$UPDATES
static final boolean getFoldersPaging$UPDATESDeprecated.- See Also:
-
createFolder$UPDATES
static final boolean createFolder$UPDATESDeprecated.- See Also:
-
createFolders$UPDATES
static final boolean createFolders$UPDATESDeprecated.- See Also:
-
updateFolder$UPDATES
static final boolean updateFolder$UPDATESDeprecated.- See Also:
-
updateFolders$UPDATES
static final boolean updateFolders$UPDATESDeprecated.- See Also:
-
updateForumForFolder$UPDATES
static final boolean updateForumForFolder$UPDATESDeprecated.- See Also:
-
updateForumForFolders$UPDATES
static final boolean updateForumForFolders$UPDATESDeprecated.- See Also:
-
deleteFolder$UPDATES
static final boolean deleteFolder$UPDATESDeprecated.- See Also:
-
deleteFolders$UPDATES
static final boolean deleteFolders$UPDATESDeprecated.- See Also:
-
approveChangesForFolder$UPDATES
static final boolean approveChangesForFolder$UPDATESDeprecated.- See Also:
-
approveChangesForFolders$UPDATES
static final boolean approveChangesForFolders$UPDATESDeprecated.- See Also:
-
rejectChangesForFolder$UPDATES
static final boolean rejectChangesForFolder$UPDATESDeprecated.- See Also:
-
rejectChangesForFolders$UPDATES
static final boolean rejectChangesForFolders$UPDATESDeprecated.- See Also:
-
isFolderEmpty$UPDATES
static final boolean isFolderEmpty$UPDATESDeprecated.- See Also:
-
getParentFolders$UPDATES
static final boolean getParentFolders$UPDATESDeprecated.- See Also:
-
getParentFoldersPaging$UPDATES
static final boolean getParentFoldersPaging$UPDATESDeprecated.- See Also:
-
getChildFolders$UPDATES
static final boolean getChildFolders$UPDATESDeprecated.- See Also:
-
getChildFoldersPaging$UPDATES
static final boolean getChildFoldersPaging$UPDATESDeprecated.- See Also:
-
getWritableFoldersForFolderPaging$UPDATES
static final boolean getWritableFoldersForFolderPaging$UPDATESDeprecated.- See Also:
-
getChildDocuments$UPDATES
static final boolean getChildDocuments$UPDATESDeprecated.- See Also:
-
getChildDocumentsPaging$UPDATES
static final boolean getChildDocumentsPaging$UPDATESDeprecated.- See Also:
-
getFavoriteFolders$UPDATES
static final boolean getFavoriteFolders$UPDATESDeprecated.- See Also:
-
getFavoriteFoldersPaging$UPDATES
static final boolean getFavoriteFoldersPaging$UPDATESDeprecated.- See Also:
-
addFolderToFavorites$UPDATES
static final boolean addFolderToFavorites$UPDATESDeprecated.- See Also:
-
addFoldersToFavorites$UPDATES
static final boolean addFoldersToFavorites$UPDATESDeprecated.- See Also:
-
removeFolderFromFavorites$UPDATES
static final boolean removeFolderFromFavorites$UPDATESDeprecated.- See Also:
-
removeFoldersFromFavorites$UPDATES
static final boolean removeFoldersFromFavorites$UPDATESDeprecated.- See Also:
-
getAccessLevelForFolder$UPDATES
static final boolean getAccessLevelForFolder$UPDATESDeprecated.- See Also:
-
getAccessLevelForFolders$UPDATES
static final boolean getAccessLevelForFolders$UPDATESDeprecated.- See Also:
-
setRoleMapForFolder$UPDATES
static final boolean setRoleMapForFolder$UPDATESDeprecated.- See Also:
-
getRoleMapForFolder$UPDATES
static final boolean getRoleMapForFolder$UPDATESDeprecated.- See Also:
-
getTreeViewForFolder$UPDATES
static final boolean getTreeViewForFolder$UPDATESDeprecated.- See Also:
-
getTreeViewForFolders$UPDATES
static final boolean getTreeViewForFolders$UPDATESDeprecated.- See Also:
-
getDescendantDocumentsOfFolderPaging$UPDATES
static final boolean getDescendantDocumentsOfFolderPaging$UPDATESDeprecated.- See Also:
-
getDescendantDocumentsOfFoldersPaging$UPDATES
static final boolean getDescendantDocumentsOfFoldersPaging$UPDATESDeprecated.- See Also:
-
findAdministratableFoldersPaging$UPDATES
static final boolean findAdministratableFoldersPaging$UPDATESDeprecated.- See Also:
-
findWritableFoldersPaging$UPDATES
static final boolean findWritableFoldersPaging$UPDATESDeprecated.- See Also:
-
findReadableFoldersPaging$UPDATES
static final boolean findReadableFoldersPaging$UPDATESDeprecated.- See Also:
-
getFullPathStringToFolder$UPDATES
static final boolean getFullPathStringToFolder$UPDATESDeprecated.- See Also:
-
getFullPathStringToFolders$UPDATES
static final boolean getFullPathStringToFolders$UPDATESDeprecated.- See Also:
-
getFoldersList$UPDATES
static final boolean getFoldersList$UPDATESDeprecated.- See Also:
-
getSystemFolderId$UPDATES
static final boolean getSystemFolderId$UPDATESDeprecated.- See Also:
-
setSystemFolderId$UPDATES
static final boolean setSystemFolderId$UPDATESDeprecated.- See Also:
-
getMyTaskViewFolder$UPDATES
static final boolean getMyTaskViewFolder$UPDATESDeprecated.- See Also:
-
getMyProcessViewFolder$UPDATES
static final boolean getMyProcessViewFolder$UPDATESDeprecated.- See Also:
-
getMyReportsFolder$UPDATES
static final boolean getMyReportsFolder$UPDATESDeprecated.- See Also:
-
getPersonalizedTaskViewsFolder$UPDATES
static final boolean getPersonalizedTaskViewsFolder$UPDATESDeprecated.- See Also:
-
getDocumentsByName$UPDATES
static final boolean getDocumentsByName$UPDATESDeprecated.- See Also:
-
getContentIdForFolderId$UPDATES
static final boolean getContentIdForFolderId$UPDATESDeprecated.- See Also:
-
getContentIdsForFolderIds$UPDATES
static final boolean getContentIdsForFolderIds$UPDATESDeprecated.- See Also:
-
getFolderIdForContentId$UPDATES
static final boolean getFolderIdForContentId$UPDATESDeprecated.- See Also:
-
getFolderIdsForContentIds$UPDATES
static final boolean getFolderIdsForContentIds$UPDATESDeprecated.- See Also:
-
suggest$UPDATES
static final boolean suggest$UPDATESDeprecated.- See Also:
-
-
Method Details
-
getFolder
Folder getFolder(Long foid_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Gets information about a folder- Parameters:
foid_
- the unique ID of the folder- Returns:
- a
Folder
object representing the folder with unique ID - Throws:
InvalidFolderException
- if no folder with the given ID existsInvalidUserException
- if user calling this method is invalidPrivilegeException
- if the current user's access level to the folder is not one ofFolder.ACCESS_LEVEL_READ_ONLY
,Folder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs
-
getFolders
@Deprecated Folder[] getFolders(Long[] foids_) throws InvalidFolderException, InvalidUserException, PrivilegeException Gets information about multiple folders- Parameters:
foids_
- a list of unique IDs of the folders- Returns:
- an array of
Folder
objects representing the folders with unique IDs - Throws:
InvalidFolderException
- if at least one of the IDs does not refer to an existing folderInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to one of the folders is not one ofFolder.ACCESS_LEVEL_READ_ONLY
,Folder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs
-
getFoldersPaging
ResultPage getFoldersPaging(Long[] foids_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Gets Information about multiple folders- Parameters:
foids_
- a list of unique IDs of the foldersstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results.This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing the list of
Folder
objects representing the folders with the unique IDs - Throws:
InvalidFolderException
- if at least one of the IDs does not correspond to a valid folderInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to one of the folders is not one ofFolder.ACCESS_LEVEL_READ_ONLY
,Folder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs
-
createFolder
Long createFolder(Folder folder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Creates a new folderNOTE: The only fields that are actually used in the create are
name
,searchable
,knowledgeCenterId
andparentFolderId
. All other fields are ignored.- Parameters:
folder_
- aFolder
object which should contain all of the information required to create a valid folder. Minimum required fields:name
,searchable
,knowledgeCenterId
- Returns:
- the ID of the created folder
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to the knowledge center in which this folder is to be created is not one ofKnowledgeCenter.ACCESS_LEVEL_READ_WRITE
orKnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE
InvalidKnowledgeCenterException
- if theknowledgeCenterId
field of the folder does not refer to a valid knowledge centerServiceException
- if any system-level error occurs
-
createFolders
Long[] createFolders(Folder[] folders_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Creates multiple foldersNOTE: The only fields that are actually used in the create are
name
,searchable
,knowledgeCenterId
andparentFolderId
. All other fields are ignored.- Parameters:
folders_
- an array ofFolder
objects which should contain all of the information required to create valid folders. Minimum required fields:name
,searchable
,knowledgeCenterId
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to the knowledge center in which one of the folders is to be created is not one ofKnowledgeCenter.ACCESS_LEVEL_READ_WRITE
orKnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE
InvalidKnowledgeCenterException
- if theknowledgeCenterId
field of one of the folders does not refer to a valid knowledge centerServiceException
- if any system-level error occurs
-
updateFolder
void updateFolder(Folder folder_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Updates a folder- Parameters:
folder_
- aFolder
object which should contain all of the information required to update a folder Minimum required fields:name
andid
. The fields that can be updated using this call arename
,id
andforum
. All other fields will be ignored.- Throws:
InvalidFolderException
- if the folder does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to the folder is not one ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs
-
updateFolders
void updateFolders(Folder[] folders_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Updates the information stored about multiple folders- Parameters:
folders_
- an array ofFolder
objects, each of which should contain all of the information required to update the folder. Minimum required fields:name
andid
. The fields that can be updated using this call arename
,id
andforum
. All other fields will be ignored.- Throws:
InvalidFolderException
- if one of the folders does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current user's access level to one of the folders is not one ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs
-
updateForumForFolder
Deprecated.Updates the forum ID associated with a folder- Parameters:
folder_
- aFolder
object which should contain the updated forum ID and the minimum required fields to update a folder. Minimum required fields:id
. The fields that can be updated using this call areid
andforum
. All other fields will be ignored. Ifforum
is set tonull
, this call will remove any forum associations.- Throws:
InvalidFolderException
- if the folder does not existPrivilegeException
- if 1) the current user does not have access to the folder (his access leve is not one ofFolder.ACCESS_LEVEL_READ_ONLY
,Folder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) or 2) the current user is not an administrator of the folder and a forum currently exists for the folderServiceException
- if any system-level error occurs
-
updateForumForFolders
Deprecated.Updates the forums associated with an array of folders- Parameters:
folders_
- an array ofFolder
objects which should contain the updated forum information and the minimum required fields for updating a folder. Minimum required fields:id
. The fields that can be updated using this call areid
andforum
. All other fields will be ignored. Ifforum
is set tonull
, this call will remove any forum associations.- Throws:
InvalidFolderException
- if any of the folders does not existPrivilegeException
- if 1) the current user does not have access to one of the folders (his access leve is not one ofFolder.ACCESS_LEVEL_READ_ONLY
,Folder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) or 2) the current user is not an administrator of one of the folders and a forum currently exists for the folderServiceException
- if any system-level error occurs
-
deleteFolder
void deleteFolder(Long foid_) throws InvalidFolderException, InvalidUserException, NotEmptyException, PrivilegeException Deprecated.Deletes a folder- Parameters:
foid_
- the unique ID of the folder to be deleted- Throws:
InvalidFolderException
- if theFolder
specified byfoid_
does not existInvalidUserException
- if the user calling this method is invalidNotEmptyException
- if the folders contains documents or sub-foldersPrivilegeException
- if the currentUser
is not an administrator or the creator of the folder.ServiceException
- if any system-level error occurs
-
deleteFolders
void deleteFolders(Long[] foids_) throws InvalidFolderException, InvalidUserException, NotEmptyException, PrivilegeException Deprecated.Deletes multiple folders- Parameters:
foids_
- a list containing the unique IDs of theFolder
objects to be deleted- Throws:
InvalidFolderException
- if any of the folders specified byfoids_
do not existInvalidUserException
- if the user calling this method is invalidNotEmptyException
- if any of the folders contain documents or sub-foldersPrivilegeException
- if the currentUser
is not an administrator or creator of all of the foldersServiceException
- if any system-level error occurs
-
approveChangesForFolder
Long[] approveChangesForFolder(Long foid_) throws InvalidUserException, InvalidDataFormatException, PrivilegeException, InvalidFolderException Deprecated.Approves the creation or deletion of a folder (within a knowledge center for which changes require approval). To approve creation of a folder, pass the ID of the folder. To approve deletion of a folder, pass (-1 * (folder ID)).- Parameters:
foid_
- the unique ID of the folder, or the negation of the ID of the folder, depending on whether approval is being done for creation or deletion- Returns:
- the IDs of the folders (the current folder or any of its sub-folders) that could not be deleted because they are not empty (they contain documents or subfolders).
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
is not an administrator of theKnowledgeCenter
to which this folder belongsInvalidFolderException
- if theFolder
does not existInvalidDataFormatException
- if the folder id provided isnull
ServiceException
- if any system-level error occurs
-
approveChangesForFolders
Long[] approveChangesForFolders(Long[] foids_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException Deprecated.Approves the creation or deletion of multiple folders (within a knowledge center for which changes require approval). To approve creation of a folder, pass the ID of the folder. To approve deletion of a folder, pass (-1 * (folder ID)).- Parameters:
foids_
- a list containing the unique IDs of the folders, or the negation of the IDs of the folders, depending on whether approval is being done for creation or deletion- Returns:
- the IDs of the folders (any of the folders in
foids_
or any of their subfolders) which could not be deleted because they are not empty (they contain documents or subfolders) - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
is not an administrator of theKnowledgeCenter
objects to which these folders belongInvalidFolderException
- if any of theFolder
objects specified byfoids_
do not existInvalidDataFormatException
- if one or more folder ids provided arenull
ServiceException
- if any system-level error occurs
-
rejectChangesForFolder
void rejectChangesForFolder(Long foid_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException, NotEmptyException Deprecated.Rejects the creation or deletion of a folder (within a knowledge center for which changes require approval). To reject creation of a folder, pass the ID of the folder. To reject deletion of a folder, pass (-1 * (folder ID)).- Parameters:
foid_
- the unique ID of the folder, or the negation of the ID of the folder, depending on whether rejection is being done for creation or deletion- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
is not an administrator of theKnowledgeCenter
to which this folder belongsInvalidFolderException
- if theFolder
specified byfoid_
does not existNotEmptyException
- if theFolder
is not empty, and the change is a creation (meaning the rollback would delete the folder)InvalidDataFormatException
- if the folder id provided isnull
ServiceException
- if any system-level error occurs
-
rejectChangesForFolders
void rejectChangesForFolders(Long[] foids_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException, NotEmptyException Deprecated.Rejects the creation or deletion of multiple folders (within a knowledge center for which changes require approval). To reject creation of a folder, pass the ID of the folder. To reject deletion of a folder, pass (-1 * (folder ID)).- Parameters:
foids_
- a list containing the unique IDs of the folders, or the negation of the IDs of the folders, depending on whether rejection is being done for creation or deletion- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
is not an administrator of theKnowledgeCenter
objects to which these folders belongInvalidFolderException
- if any of the folders specified byfoids_
does not existNotEmptyException
- if any of the folders is not empty, and the change is a creation (meaning the rollback would delete the folder)InvalidDataFormatException
- if one or more folder ids provided arenull
ServiceException
- if any system-level error occurs
-
isFolderEmpty
Deprecated.Checks whether a folder contains any children (documents or sub-folders)- Parameters:
foid_
- the unique ID of the folder- Returns:
- true if the
Folder
is empty, false otherwise - Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getParentFolders
Deprecated.Retrieves the breadcrumbs to a folder (that is, the parent folders of a given folder, and also the folder itself). The top level parent will be returned in the first index of the array; the folder corresponding tofoid_
will be returned in the last index of the array. If the folder has no parents, an array of length 1, containing the folder corresponding tofoid_
will be returned.- Parameters:
foid_
- the unique ID of the folder whose parents are to be retrieved- Returns:
- the parent folders of the folder with the given ID, and also the
folder referenced by
foid_
- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getParentFoldersPaging
ResultPage getParentFoldersPaging(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidFolderException Deprecated.Retrieves the breadcrumbs to a folder (that is, the parent folders of a given folder, and also the folder itself). If the folder has no parents, an array of length 1, containing the folder corresponding tofoid_
will be returned.- Parameters:
foid_
- the unique ID of the folder whose parents are to be retrievedstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects representing the parents of the specified folder,and also the folder referenced byfoid_
- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getChildFolders
@Deprecated Folder[] getChildFolders(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) throws InvalidFolderException, PrivilegeException Deprecated.Retrieves the direct child folders of a folder- Parameters:
foid_
- the unique ID of the parent foldersortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the column by which the results will be sorted. This is one of theSORT_COLUMN_XXX
properties inFolder
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.scrollLength_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Returns:
- the direct child folders of the folder specified by
foid_
- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existPrivilegeException
- if the currentUser
does not have at least read access to the folder and its children.
-
getChildFoldersPaging
ResultPage getChildFoldersPaging(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Retrieves the direct child folders of a folder- Parameters:
foid_
- the unique ID of the parent folderstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects representing the child folders of the folder - Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if currentUser
does not have at least read access to the folder and its children.ServiceException
- if any system-level error occurs
-
getWritableFoldersForFolderPaging
ResultPage getWritableFoldersForFolderPaging(Long folderId_, int startPosition_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, PrivilegeException Deprecated.Retrieves a list of sub-folders of a folder, for which the current user has an access level ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
- Parameters:
folderId_
- the unique ID of the folder whose sub-folders are to be retrievedstartPosition_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects which represent the writable folders for a user - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if currentUser
does not have at least read access to the folder and its children.ServiceException
- if any system-level error occurs
-
getChildDocuments
@Deprecated Document[] getChildDocuments(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_) throws InvalidFolderException, InvalidUserException, PrivilegeException Deprecated.Retrieves the direct child documents of a folder- Parameters:
foid_
- the unique ID of the folder whose child documents are to be retrievedsortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the column by which the results will be sorted. This is one of theSORT_COLUMN_XXX
properties inDocument
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.scrollLength_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if currentUser
does not have at least read access to the folder.ServiceException
- if any system-level error occurs
-
getChildDocumentsPaging
ResultPage getChildDocumentsPaging(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidFolderException, InvalidDocumentException, PrivilegeException, InvalidKnowledgeCenterException Deprecated.Retrieves the direct child documents of a folder- Parameters:
foid_
- the unique ID of the folder whose child documents are to be retrievedstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofDocument
objects representing the child documents of the folder - Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existPrivilegeException
- if currentUser
does not have at least read access to the folder.ServiceException
- if any system-level error occursInvalidDocumentException
InvalidKnowledgeCenterException
-
getFavoriteFolders
@Deprecated Folder[] getFavoriteFolders(Integer sortOrder_, String sortColumn_) throws InvalidUserException Retrieve all the folders that are in the current user's "Favorites" list.- Parameters:
sortOrder_
- the order in which to sort the returned list of folders. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
sortColumn_
- the field of theFolder
by which to sort the returned list of folders. This is one ofSORT_COLUMN_XXX
inFolder
- Returns:
- the current user's favorite folders
- Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
getFavoriteFoldersPaging
ResultPage getFavoriteFoldersPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException Deprecated.Retrieve all the folders that are in the current user's "Favorites" list.- Parameters:
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array of folders in the current user's "Favorites" list - Throws:
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
addFolderToFavorites
Deprecated.Adds a folder to the current user's "Favorites" list.- Parameters:
foid_
- the unique ID of the folder to be added- Throws:
InvalidFolderException
- if theFolder
specified byfoid_
does not existInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occurs
-
addFoldersToFavorites
void addFoldersToFavorites(Long[] foids_) throws InvalidUserException, InvalidFolderException, InvalidDataFormatException Deprecated.Adds multiple folders to the current user's "Favorites" list.- Parameters:
foids_
- a list of unique IDs representing the folders to be added- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if one of the folder IDs does not correspond to a valid folderServiceException
- if any system-level error occursInvalidDataFormatException
-
removeFolderFromFavorites
Deprecated.Removes a folder from the current user's "Favorites" list- Parameters:
foid_
- the unique ID of the folder to be removed- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
removeFoldersFromFavorites
void removeFoldersFromFavorites(Long[] foids_) throws InvalidUserException, InvalidFolderException, InvalidDataFormatException Deprecated.Removes multiple folders from the current user's "Favorites" list- Parameters:
foids_
- a list of unique IDs for the folders to be removed- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if theFolder
specified byfoid_
does not existServiceException
- if any system-level error occursInvalidDataFormatException
-
getAccessLevelForFolder
Deprecated.Retrieves the current user's access level for a folder- Parameters:
foid_
- the unique ID of the folder- Returns:
- The current user's access level for the folder. This will be one of:
- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getAccessLevelForFolders
Deprecated.Retrieves the current user's access levels for multiple folders- Parameters:
foids_
- a list of unique IDs of the folders- Returns:
- The current user's access levels for the folders. Each access level will be one of:
- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
setRoleMapForFolder
void setRoleMapForFolder(Long foid_, CollaborationRoleMap crm_) throws InvalidFolderException, InvalidGroupException, InvalidUserException, PrivilegeException Deprecated.Set theCollaborationRoleMap
for a given folder If the role map is not set for a folder, by default it inherits the permissions specified in the role map from its parent knowledge center- Parameters:
foid_
- the unique ID for a foldercrm_
- theCollaborationRoleMap
object containing the new roles to set- Throws:
InvalidFolderException
- if the folder specified byfoid_
does not existInvalidGroupException
- if any group in the role map is invalidInvalidUserException
- if any user in the role map is invalidPrivilegeException
- if the current user is not an administrator of the given folderServiceException
- if any system-level error occurs
-
getRoleMapForFolder
CollaborationRoleMap getRoleMapForFolder(Long foid_) throws InvalidFolderException, PrivilegeException Deprecated.Retrieves theCollaborationRoleMap
for a given folder- Parameters:
foid_
- the unique ID for a folder- Returns:
- the
CollaborationRoleMap
object containing the roles for the folder - Throws:
PrivilegeException
- if the current user does not have enough privileges to view the role mapInvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getTreeViewForFolder
TreePivot getTreeViewForFolder(Long folderId_, int descendantDepth_) throws InvalidUserException, PrivilegeException, InvalidFolderException Deprecated.Get the tree pivoted at a particular folder. Each node in the tree will have itsdata
property populated with the local object type value of the local object that it represents (eg, forDocument
nodes, thedata
property of the node will be populated withLocalObjectTypeMapping.TYPE_DOCUMENT
)- Parameters:
folderId_
- the unique ID for aFolder
descendantDepth_
- the number of levels below the root that should be returned. UseConstants.COUNT_ALL
to return all levels below the root.- Returns:
- the
TreePivot
object which represents a tree whose root is theFolder
specified byfolderId_
. The data in theTreePivot
tree areDocument
andFolder
objects. The breadcrumbs contained in theTreePivot
go all the way up to the community - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
does not have at least read access to all the returned folders.InvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getTreeViewForFolders
TreePivot[] getTreeViewForFolders(Long[] folderIds_, int descendantDepth_) throws InvalidUserException, PrivilegeException, InvalidFolderException Deprecated.Get the trees pivoted at particular folders. Each node in a tree will have itsdata
property populated with the local object type value of the local object that it represents (eg, forDocument
nodes, thedata
property of the node will be populated withLocalObjectTypeMapping.TYPE_DOCUMENT
)- Parameters:
folderIds_
- an array of unique IDs which each represent aFolder
descendantDepth_
- the number of levels below the root that should be returned for each tree. UseConstants.COUNT_ALL
to return all levels below the root.- Returns:
- an array of
TreePivot
objects, each of which represents a tree whose root is theFolder
specified by a folder ID - Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
does not have at least read access to all root folders and all other returned folders.InvalidFolderException
- if theFolder
specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getDescendantDocumentsOfFolderPaging
ResultPage getDescendantDocumentsOfFolderPaging(Long folderId_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidFolderException Deprecated.Get a flat list of all documents in a given folder and its subfolders- Parameters:
folderId_
- the unique ID of theFolder
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing an array of
Document
objects representing the document descendants of the folder with IDfolderId_
- Throws:
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if theFolder
specified byfoid_
does not existServiceException
- if any system-level error occurs
-
getDescendantDocumentsOfFoldersPaging
ResultPage getDescendantDocumentsOfFoldersPaging(Long[] folderIds_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) throws InvalidUserException, InvalidFolderException Deprecated.Get a flat list of all documents in a list of folders and their subfolders- Parameters:
folderIds_
- a list of the unique IDs of the foldersstartIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inDocument
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a ResultPage containing an array of
Document
objects representing the document descendants of the folders - Throws:
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the folder specified byfoid_
does not existServiceException
- if any system-level error occurs
-
findAdministratableFoldersPaging
ResultPage findAdministratableFoldersPaging(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user is an administrator (ie has an access level ofFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.- Parameters:
folderName_
- the folder name to be matched. A folder will match if its name contains the value offolderName_
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects which match the given criteria - Throws:
ServiceException
- if any system-level error occurs
-
findWritableFoldersPaging
ResultPage findWritableFoldersPaging(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user has author privileges or greater (ie an access level ofFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.- Parameters:
folderName_
- the folder name to be matched. AFolder
will match if its name contains the value offolderName_
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects which match the given criteria - Throws:
ServiceException
- if any system-level error occurs
-
findReadableFoldersPaging
ResultPage findReadableFoldersPaging(String folderName_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_) Deprecated.Finds folder for which the current user has read privileges or greater (ie an access level ofFolder.ACCESS_LEVEL_READ_ONLY
orFolder.ACCESS_LEVEL_READ_WRITE
orFolder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given folder name.- Parameters:
folderName_
- the folder name to be matched. AFolder
will match if its name contains the value offolderName_
startIndex_
- the index into the collection of total results at which to start. Negative numbers are treated as zeros.batchSize_
- the number of results to return. UseConstants.COUNT_ALL
to return the entire collection, but this is STRONGLY discouraged.sortProperty_
- the property by which the results will be sorted. This is one of theSORT_BY_XXX
constants inFolder
.sortOrder_
- the order in which to sort the results. This is one ofConstants.SORT_ORDER_ASCENDING
orConstants.SORT_ORDER_DESCENDING
- Returns:
- a
ResultPage
containing an array ofFolder
objects which match the given criteria - Throws:
ServiceException
- if any system-level error occurs
-
getFullPathStringToFolder
String getFullPathStringToFolder(Long folderId_, String pathSeparator_) throws InvalidUserException, PrivilegeException, InvalidFolderException Deprecated.Gets the path to a folder through the Collaboration navigation tree. For example, if folder 'mySubfolder' exists within folder 'myFolder', within knowledge center 'myKC', within community 'myCommunity', the return value will be "myCommunity/myKC/myFolder/mySubfolder", assuming apathSeparator_
of "/". If theFolder
existed within a privateKnowledgeCenter
, the return value would be "/myKC/myFolder/mySubfolder".- Parameters:
folderId_
- the unique ID of the folderpathSeparator_
- the string which will be used to separate entries in the path- Returns:
- the full path to the folder
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
does not have at least read access to the folderInvalidFolderException
- if the folder specified byfolderId_
does not existServiceException
- if any system-level error occurs
-
getFullPathStringToFolders
String[] getFullPathStringToFolders(Long[] folderIds_, String pathSeparator_) throws InvalidUserException, PrivilegeException, InvalidFolderException Deprecated.Gets the path to a list of folders through the Collaboration navigation tree. For example, if folder 'mySubfolder' exists within folder 'myFolder', within knowledge center 'myKC', within community 'myCommunity', the return value for that folder will be "/myCommunity/myKC/myFolder/mySubfolder", assuming apathSeparator_
of "/". If the folder existed within a private knowledge center, the return value would be "/myKC/myFolder/mySubfolder".- Parameters:
folderIds_
- the unique IDs of the folderspathSeparator_
- the string which will be used to separate entries in the paths- Returns:
- the full paths to the folders
- Throws:
InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the currentUser
does not have at least read access to all the folders passed to this methodInvalidFolderException
- if any offolderIds
does not refer to a valid folderServiceException
- if any system-level error occurs
-
getFoldersList
Deprecated.Returns a ResultList containing error codes for each value supplied in the parameter andFolder
objects for each value which corresponds to a valid folder- Parameters:
folderIds_
- unique Ids of folders to retrieve- Returns:
- an
Integer
array of result codes and an array ofFolder
objects for all valid folders. The possible result codes are any of theCODE_XXX
orCOLLAB_CODE_XXX
constants inResultList
- Throws:
InvalidDataFormatException
- if null is passed in
-
getSystemFolderId
Deprecated.This is a small wrapper on Content's getSystemId, but returns the content id as a folder id.- Parameters:
name
- A case-insensitive system name, currently one of: image_folder_id leader_message_channel_image_folder_id priority_image_folder_id indicator_image_folder_id- Returns:
- the id of the folder.
- Throws:
InvalidFolderException
- if the string is not recognized.
-
setSystemFolderId
Deprecated.usecreateFolder(Folder)
with a pre-populated UUIDStores and associates the specifiedid
value with the specifiedname
key.- Parameters:
name
- A case-insensitive system name.id
- The folder id.- Throws:
InvalidFolderException
- if the string is not recognized.
-
getMyTaskViewFolder
Folder getMyTaskViewFolder()Deprecated.This call will retrieve the folder named ###my_task_views under the current users private knowledge center. Note that the key ###my_task_views is used as this folder name to support internationalization. (See private kc for details). If the current user doesnt have either a private kc or a my task view folder, one or both of these enitities will be created in k and the new folder returned. Therefore this method has the potential for updates.- Returns:
- The
Folder
.
-
getMyProcessViewFolder
Folder getMyProcessViewFolder()Deprecated.This call will retrieve the folder named ###my_process_views under the current users private knowledge center. Note that the key ###my_process_views is used as this folder name to support internationalization. (See private kc for details). If the current user doesnt have either a private kc or a my process view folder, one or both of these enitities will be created in k and the new folder returned. Therefore this method has the potential for updates.- Returns:
- The
Folder
.
-
getMyReportsFolder
Folder getMyReportsFolder()Deprecated.This call will retrieve the folder named ###my_reports under the current users private knowledge center. Note that the key ###my_reports is used as this folder name to support internationalization. (See private kc for details). If the current user doesnt have either a private kc or a my reports folder, one or both of these enitities will be created in k and the new folder returned. Therefore this method has the potential for updates.- Returns:
- The
Folder
.
-
getPersonalizedTaskViewsFolder
Folder getPersonalizedTaskViewsFolder()Deprecated.This call will retrieve the folder named ###personalized_task_views under the current users private knowledge center. Note that the key ###personalized_task_views is used as this folder name to support internationalization. (See private kc for details). If the current user doesnt have either a private kc or a personalized.task.views folder, one or both of these enitities will be created in k and the new folder returned. Therefore this method has the potential for updates.- Returns:
- The
Folder
.
-
getDocumentsByName
Deprecated.This call will retrieve all documents of a given folder that have a given name.- Parameters:
folderId
- The unique ID of the foldername
- The name of the documents that are to be retrieved- Returns:
- An array of
Document
s
-
getContentIdForFolderId
Deprecated. -
getContentIdsForFolderIds
Deprecated. -
getFolderIdForContentId
Deprecated. -
getFolderIdsForContentIds
Deprecated. -
suggest
Deprecated.- Parameters:
query
-maxItems
-params
- list of information on what is being suggested and what format the results should be in. valid types are folder, document.groupResults
- if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.- Returns:
- a JSON formatted string
-
suggest
String suggest(String query, int maxItems, SuggestParam[] params, Boolean groupResults, Long[] allowList) Deprecated.- Parameters:
query
-maxItems
-params
- list of information on what is being suggested and what format the results should be in. valid types are folder, document.groupResults
- if specifying more than one SuggestParam, would you like to group the results by type, or mixed together and sorted? Default is true. If grouped, order of types matches the order of the suggestParams passed in.allowList
- list of IDs that will be automatically added to returned results, filtered by query. Ignored if null or empty.- Returns:
- a JSON formatted string
-
ContentService
instead.