Package com.appiancorp.suiteapi.collaboration

Interface FolderService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

@Deprecated
public interface FolderService
extends com.appiancorp.services.ContextSensitiveService

Deprecated.

Use the class ContentService instead.

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.

See Also:

• AdministrationService
• CollaborationSearchService
• CommunityService
• DocumentService
• KnowledgeCenterService
• ReportingService
• StatisticsService

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	addFoldersToFavorites$UPDATES	Deprecated.
static final boolean	addFolderToFavorites$UPDATES	Deprecated.
static final boolean	approveChangesForFolder$UPDATES	Deprecated.
static final boolean	approveChangesForFolders$UPDATES	Deprecated.
static final boolean	createFolder$UPDATES	Deprecated.
static final boolean	createFolders$UPDATES	Deprecated.
static final boolean	deleteFolder$UPDATES	Deprecated.
static final boolean	deleteFolders$UPDATES	Deprecated.
static final boolean	findAdministratableFoldersPaging$UPDATES	Deprecated.
static final boolean	findReadableFoldersPaging$UPDATES	Deprecated.
static final boolean	findWritableFoldersPaging$UPDATES	Deprecated.
static final boolean	getAccessLevelForFolder$UPDATES	Deprecated.
static final boolean	getAccessLevelForFolders$UPDATES	Deprecated.
static final boolean	getChildDocuments$UPDATES	Deprecated.
static final boolean	getChildDocumentsPaging$UPDATES	Deprecated.
static final boolean	getChildFolders$UPDATES	Deprecated.
static final boolean	getChildFoldersPaging$UPDATES	Deprecated.
static final boolean	getContentIdForFolderId$UPDATES	Deprecated.
static final boolean	getContentIdsForFolderIds$UPDATES	Deprecated.
static final boolean	getDescendantDocumentsOfFolderPaging$UPDATES	Deprecated.
static final boolean	getDescendantDocumentsOfFoldersPaging$UPDATES	Deprecated.
static final boolean	getDocumentsByName$UPDATES	Deprecated.
static final boolean	getFavoriteFolders$UPDATES	Deprecated.
static final boolean	getFavoriteFoldersPaging$UPDATES	Deprecated.
static final boolean	getFolder$UPDATES	Deprecated.
static final boolean	getFolderIdForContentId$UPDATES	Deprecated.
static final boolean	getFolderIdsForContentIds$UPDATES	Deprecated.
static final boolean	getFolders$UPDATES	Deprecated.
static final boolean	getFoldersList$UPDATES	Deprecated.
static final boolean	getFoldersPaging$UPDATES	Deprecated.
static final boolean	getFullPathStringToFolder$UPDATES	Deprecated.
static final boolean	getFullPathStringToFolders$UPDATES	Deprecated.
static final boolean	getMyProcessViewFolder$UPDATES	Deprecated.
static final boolean	getMyReportsFolder$UPDATES	Deprecated.
static final boolean	getMyTaskViewFolder$UPDATES	Deprecated.
static final boolean	getParentFolders$UPDATES	Deprecated.
static final boolean	getParentFoldersPaging$UPDATES	Deprecated.
static final boolean	getPersonalizedTaskViewsFolder$UPDATES	Deprecated.
static final boolean	getRoleMapForFolder$UPDATES	Deprecated.
static final boolean	getSystemFolderId$UPDATES	Deprecated.
static final boolean	getTreeViewForFolder$UPDATES	Deprecated.
static final boolean	getTreeViewForFolders$UPDATES	Deprecated.
static final boolean	getWritableFoldersForFolderPaging$UPDATES	Deprecated.
static final boolean	isFolderEmpty$UPDATES	Deprecated.
static final boolean	rejectChangesForFolder$UPDATES	Deprecated.
static final boolean	rejectChangesForFolders$UPDATES	Deprecated.
static final boolean	removeFolderFromFavorites$UPDATES	Deprecated.
static final boolean	removeFoldersFromFavorites$UPDATES	Deprecated.
static final boolean	setRoleMapForFolder$UPDATES	Deprecated.
static final boolean	setSystemFolderId$UPDATES	Deprecated.
static final boolean	suggest$UPDATES	Deprecated.
static final boolean	updateFolder$UPDATES	Deprecated.
static final boolean	updateFolders$UPDATES	Deprecated.
static final boolean	updateForumForFolder$UPDATES	Deprecated.
static final boolean	updateForumForFolders$UPDATES	Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method	Description
void	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).
Long	createFolder(Folder folder_)	Deprecated. Creates a new folder
Long[]	createFolders(Folder[] folders_)	Deprecated. Creates multiple folders
void	deleteFolder(Long foid_)	Deprecated. Deletes a folder
void	deleteFolders(Long[] foids_)	Deprecated. Deletes multiple folders
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 of Folder.ACCESS_LEVEL_ADMINISTRATIVE) and which match the given folder name.
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 of Folder.ACCESS_LEVEL_READ_ONLY or Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE) and which match the given folder name.
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 of Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE) and which match the given folder name.
int	getAccessLevelForFolder(Long foid_)	Deprecated. Retrieves the current user's access level for a folder
int[]	getAccessLevelForFolders(Long[] foids_)	Deprecated. Retrieves the current user's access levels for multiple folders
Document[]	getChildDocuments(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_)	Deprecated. use getChildDocumentsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
ResultPage	getChildDocumentsPaging(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. Retrieves the direct child documents of a folder
Folder[]	getChildFolders(Long foid_, Integer sortOrder_, String sortColumn_, int startIndex_, int scrollLength_)	Deprecated. use getChildFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
ResultPage	getChildFoldersPaging(Long foid_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. Retrieves the direct child folders of a folder
Long	getContentIdForFolderId(Long id)	Deprecated.
Long[]	getContentIdsForFolderIds(Long[] id)	Deprecated.
ResultPage	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 subfolders
ResultPage	getDescendantDocumentsOfFoldersPaging(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 subfolders
Document[]	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_)	Deprecated. use getFavoriteFoldersPaging(int, int, java.lang.Integer, java.lang.Integer)
ResultPage	getFavoriteFoldersPaging(int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. Retrieve all the folders that are in the current user's "Favorites" list.
Folder	getFolder(Long foid_)	Deprecated. Gets information about a folder
Long	getFolderIdForContentId(Long id)	Deprecated.
Long[]	getFolderIdsForContentIds(Long[] id)	Deprecated.
Folder[]	getFolders(Long[] foids_)	Deprecated. use getFoldersPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer)
ResultList	getFoldersList(Long[] folderIds_)	Deprecated. Returns a ResultList containing error codes for each value supplied in the parameter and Folder objects for each value which corresponds to a valid folder
ResultPage	getFoldersPaging(Long[] foids_, int startIndex_, int batchSize_, Integer sortProperty_, Integer sortOrder_)	Deprecated. Gets Information about multiple folders
String	getFullPathStringToFolder(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.
Folder	getMyProcessViewFolder()	Deprecated. This call will retrieve the folder named ###my_process_views under the current users private knowledge center.
Folder	getMyReportsFolder()	Deprecated. This call will retrieve the folder named ###my_reports under the current users private knowledge center.
Folder	getMyTaskViewFolder()	Deprecated. This call will retrieve the folder named ###my_task_views under the current users private knowledge center.
Folder[]	getParentFolders(Long foid_)	Deprecated. use getParentFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
ResultPage	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).
Folder	getPersonalizedTaskViewsFolder()	Deprecated. This call will retrieve the folder named ###personalized_task_views under the current users private knowledge center.
CollaborationRoleMap	getRoleMapForFolder(Long foid_)	Deprecated. Retrieves the CollaborationRoleMap for a given folder
Long	getSystemFolderId(String name)	Deprecated. use ContentService.getIdByUuid(String) and getFolderIdForContentId(Long)
TreePivot	getTreeViewForFolder(Long folderId_, int descendantDepth_)	Deprecated. Get the tree pivoted at a particular folder.
TreePivot[]	getTreeViewForFolders(Long[] folderIds_, int descendantDepth_)	Deprecated. Get the trees pivoted at particular folders.
ResultPage	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 of Folder.ACCESS_LEVEL_READ_WRITE or Folder.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" list
void	removeFoldersFromFavorites(Long[] foids_)	Deprecated. Removes multiple folders from the current user's "Favorites" list
void	setRoleMapForFolder(Long foid_, CollaborationRoleMap crm_)	Deprecated. Set the CollaborationRoleMap 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
void	setSystemFolderId(String name, Long id)	Deprecated. use createFolder(Folder) with a pre-populated UUID
String	suggest(String query, int maxItems, SuggestParam[] params, Boolean groupResults)	Deprecated.
String	suggest(String query, int maxItems, SuggestParam[] params, Boolean groupResults, Long[] allowList)	Deprecated.
void	updateFolder(Folder folder_)	Deprecated. Updates a folder
void	updateFolders(Folder[] folders_)	Deprecated. Updates the information stored about multiple folders
void	updateForumForFolder(Folder folder_)	Deprecated. Updates the forum ID associated with a folder
void	updateForumForFolders(Folder[] folders_)	Deprecated. Updates the forums associated with an array of folders

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Details

getFolder$UPDATES

static final boolean getFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFolders$UPDATES

static final boolean getFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFoldersPaging$UPDATES

static final boolean getFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

createFolder$UPDATES

static final boolean createFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

createFolders$UPDATES

static final boolean createFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

updateFolder$UPDATES

static final boolean updateFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

updateFolders$UPDATES

static final boolean updateFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

updateForumForFolder$UPDATES

static final boolean updateForumForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

updateForumForFolders$UPDATES

static final boolean updateForumForFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

deleteFolder$UPDATES

static final boolean deleteFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

deleteFolders$UPDATES

static final boolean deleteFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

approveChangesForFolder$UPDATES

static final boolean approveChangesForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

approveChangesForFolders$UPDATES

static final boolean approveChangesForFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

rejectChangesForFolder$UPDATES

static final boolean rejectChangesForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

rejectChangesForFolders$UPDATES

static final boolean rejectChangesForFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

isFolderEmpty$UPDATES

static final boolean isFolderEmpty$UPDATES

Deprecated.

See Also:

• Constant Field Values

getParentFolders$UPDATES

static final boolean getParentFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getParentFoldersPaging$UPDATES

static final boolean getParentFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getChildFolders$UPDATES

static final boolean getChildFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getChildFoldersPaging$UPDATES

static final boolean getChildFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getWritableFoldersForFolderPaging$UPDATES

static final boolean getWritableFoldersForFolderPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getChildDocuments$UPDATES

static final boolean getChildDocuments$UPDATES

Deprecated.

See Also:

• Constant Field Values

getChildDocumentsPaging$UPDATES

static final boolean getChildDocumentsPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFavoriteFolders$UPDATES

static final boolean getFavoriteFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFavoriteFoldersPaging$UPDATES

static final boolean getFavoriteFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

addFolderToFavorites$UPDATES

static final boolean addFolderToFavorites$UPDATES

Deprecated.

See Also:

• Constant Field Values

addFoldersToFavorites$UPDATES

static final boolean addFoldersToFavorites$UPDATES

Deprecated.

See Also:

• Constant Field Values

removeFolderFromFavorites$UPDATES

static final boolean removeFolderFromFavorites$UPDATES

Deprecated.

See Also:

• Constant Field Values

removeFoldersFromFavorites$UPDATES

static final boolean removeFoldersFromFavorites$UPDATES

Deprecated.

See Also:

• Constant Field Values

getAccessLevelForFolder$UPDATES

static final boolean getAccessLevelForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getAccessLevelForFolders$UPDATES

static final boolean getAccessLevelForFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

setRoleMapForFolder$UPDATES

static final boolean setRoleMapForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getRoleMapForFolder$UPDATES

static final boolean getRoleMapForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getTreeViewForFolder$UPDATES

static final boolean getTreeViewForFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getTreeViewForFolders$UPDATES

static final boolean getTreeViewForFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getDescendantDocumentsOfFolderPaging$UPDATES

static final boolean getDescendantDocumentsOfFolderPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getDescendantDocumentsOfFoldersPaging$UPDATES

static final boolean getDescendantDocumentsOfFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

findAdministratableFoldersPaging$UPDATES

static final boolean findAdministratableFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

findWritableFoldersPaging$UPDATES

static final boolean findWritableFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

findReadableFoldersPaging$UPDATES

static final boolean findReadableFoldersPaging$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFullPathStringToFolder$UPDATES

static final boolean getFullPathStringToFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFullPathStringToFolders$UPDATES

static final boolean getFullPathStringToFolders$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFoldersList$UPDATES

static final boolean getFoldersList$UPDATES

Deprecated.

See Also:

• Constant Field Values

getSystemFolderId$UPDATES

static final boolean getSystemFolderId$UPDATES

Deprecated.

See Also:

• Constant Field Values

setSystemFolderId$UPDATES

static final boolean setSystemFolderId$UPDATES

Deprecated.

See Also:

• Constant Field Values

getMyTaskViewFolder$UPDATES

static final boolean getMyTaskViewFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getMyProcessViewFolder$UPDATES

static final boolean getMyProcessViewFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getMyReportsFolder$UPDATES

static final boolean getMyReportsFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getPersonalizedTaskViewsFolder$UPDATES

static final boolean getPersonalizedTaskViewsFolder$UPDATES

Deprecated.

See Also:

• Constant Field Values

getDocumentsByName$UPDATES

static final boolean getDocumentsByName$UPDATES

Deprecated.

See Also:

• Constant Field Values

getContentIdForFolderId$UPDATES

static final boolean getContentIdForFolderId$UPDATES

Deprecated.

See Also:

• Constant Field Values

getContentIdsForFolderIds$UPDATES

static final boolean getContentIdsForFolderIds$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFolderIdForContentId$UPDATES

static final boolean getFolderIdForContentId$UPDATES

Deprecated.

See Also:

• Constant Field Values

getFolderIdsForContentIds$UPDATES

static final boolean getFolderIdsForContentIds$UPDATES

Deprecated.

See Also:

• Constant Field Values

suggest$UPDATES

static final boolean suggest$UPDATES

Deprecated.

See Also:

• Constant Field Values

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 exists

InvalidUserException - if user calling this method is invalid

PrivilegeException - if the current user's access level to the folder is not one of Folder.ACCESS_LEVEL_READ_ONLY, Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE

ServiceException - if any system-level error occurs

getFolders

@Deprecated
Folder[] getFolders(Long[] foids_)
             throws InvalidFolderException,
InvalidUserException,
PrivilegeException

Deprecated.

use getFoldersPaging(java.lang.Long[], int, int, java.lang.Integer, java.lang.Integer)

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 folder

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user's access level to one of the folders is not one of Folder.ACCESS_LEVEL_READ_ONLY, Folder.ACCESS_LEVEL_READ_WRITE or Folder.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 folders

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results.This is one of Constants.SORT_ORDER_ASCENDING or Constants.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 folder

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user's access level to one of the folders is not one of Folder.ACCESS_LEVEL_READ_ONLY, Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE

ServiceException - if any system-level error occurs

createFolder

Long createFolder(Folder folder_)
           throws InvalidUserException,
PrivilegeException,
InvalidKnowledgeCenterException

Deprecated.

Creates a new folder

NOTE: The only fields that are actually used in the create are name, searchable, knowledgeCenterId and parentFolderId. All other fields are ignored.

Parameters:

folder_ - a Folder 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 invalid

PrivilegeException - if the current user's access level to the knowledge center in which this folder is to be created is not one of KnowledgeCenter.ACCESS_LEVEL_READ_WRITE or KnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE

InvalidKnowledgeCenterException - if the knowledgeCenterId field of the folder does not refer to a valid knowledge center

ServiceException - if any system-level error occurs

createFolders

Long[] createFolders(Folder[] folders_)
              throws InvalidUserException,
PrivilegeException,
InvalidKnowledgeCenterException

Deprecated.

Creates multiple folders

NOTE: The only fields that are actually used in the create are name, searchable, knowledgeCenterId and parentFolderId. All other fields are ignored.

Parameters:

folders_ - an array of Folder 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 invalid

PrivilegeException - if the current user's access level to the knowledge center in which one of the folders is to be created is not one of KnowledgeCenter.ACCESS_LEVEL_READ_WRITE or KnowledgeCenter.ACCESS_LEVEL_ADMINISTRATIVE

InvalidKnowledgeCenterException - if the knowledgeCenterId field of one of the folders does not refer to a valid knowledge center

ServiceException - if any system-level error occurs

updateFolder

void updateFolder(Folder folder_)
           throws InvalidFolderException,
InvalidUserException,
PrivilegeException

Deprecated.

Updates a folder

Parameters:

folder_ - a Folder object which should contain all of the information required to update a folder Minimum required fields: name and id. The fields that can be updated using this call are name, id and forum. All other fields will be ignored.

Throws:

InvalidFolderException - if the folder does not exist

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user's access level to the folder is not one of Folder.ACCESS_LEVEL_READ_WRITE or Folder.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 of Folder objects, each of which should contain all of the information required to update the folder. Minimum required fields: name and id. The fields that can be updated using this call are name, id and forum. All other fields will be ignored.

Throws:

InvalidFolderException - if one of the folders does not exist

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current user's access level to one of the folders is not one of Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE

ServiceException - if any system-level error occurs

updateForumForFolder

void updateForumForFolder(Folder folder_)
                   throws InvalidFolderException,
PrivilegeException

Deprecated.

Updates the forum ID associated with a folder

Parameters:

folder_ - a Folder 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 are id and forum. All other fields will be ignored. If forum is set to null, this call will remove any forum associations.

Throws:

InvalidFolderException - if the folder does not exist

PrivilegeException - if 1) the current user does not have access to the folder (his access leve is not one of Folder.ACCESS_LEVEL_READ_ONLY, Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE) or 2) the current user is not an administrator of the folder and a forum currently exists for the folder

ServiceException - if any system-level error occurs

updateForumForFolders

void updateForumForFolders(Folder[] folders_)
                    throws InvalidFolderException,
PrivilegeException

Deprecated.

Updates the forums associated with an array of folders

Parameters:

folders_ - an array of Folder 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 are id and forum. All other fields will be ignored. If forum is set to null, this call will remove any forum associations.

Throws:

InvalidFolderException - if any of the folders does not exist

PrivilegeException - if 1) the current user does not have access to one of the folders (his access leve is not one of Folder.ACCESS_LEVEL_READ_ONLY, Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE) or 2) the current user is not an administrator of one of the folders and a forum currently exists for the folder

ServiceException - 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 the Folder specified by foid_ does not exist

InvalidUserException - if the user calling this method is invalid

NotEmptyException - if the folders contains documents or sub-folders

PrivilegeException - if the current User 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 the Folder objects to be deleted

Throws:

InvalidFolderException - if any of the folders specified by foids_ do not exist

InvalidUserException - if the user calling this method is invalid

NotEmptyException - if any of the folders contain documents or sub-folders

PrivilegeException - if the current User is not an administrator or creator of all of the folders

ServiceException - 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 invalid

PrivilegeException - if the current User is not an administrator of the KnowledgeCenter to which this folder belongs

InvalidFolderException - if the Folder does not exist

InvalidDataFormatException - if the folder id provided is null

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 invalid

PrivilegeException - if the current User is not an administrator of the KnowledgeCenter objects to which these folders belong

InvalidFolderException - if any of the Folder objects specified by foids_ do not exist

InvalidDataFormatException - if one or more folder ids provided are null

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 invalid

PrivilegeException - if the current User is not an administrator of the KnowledgeCenter to which this folder belongs

InvalidFolderException - if the Folder specified by foid_ does not exist

NotEmptyException - if the Folder is not empty, and the change is a creation (meaning the rollback would delete the folder)

InvalidDataFormatException - if the folder id provided is null

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 invalid

PrivilegeException - if the current User is not an administrator of the KnowledgeCenter objects to which these folders belong

InvalidFolderException - if any of the folders specified by foids_ does not exist

NotEmptyException - 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 are null

ServiceException - if any system-level error occurs

isFolderEmpty

boolean isFolderEmpty(Long foid_)
               throws InvalidFolderException

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 by foid_ does not exist

ServiceException - if any system-level error occurs

getParentFolders

@Deprecated
Folder[] getParentFolders(Long foid_)
                   throws InvalidFolderException

Deprecated.

use getParentFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)

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 to foid_ 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 to foid_ 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 by foid_ does not exist

ServiceException - 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 to foid_ will be returned.

Parameters:

foid_ - the unique ID of the folder whose parents are to be retrieved

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder objects representing the parents of the specified folder,and also the folder referenced by foid_

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - if any system-level error occurs

getChildFolders

@Deprecated
Folder[] getChildFolders(Long foid_,
 Integer sortOrder_,
 String sortColumn_,
 int startIndex_,
 int scrollLength_)
                  throws InvalidFolderException,
PrivilegeException

Deprecated.

use getChildFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)

Retrieves the direct child folders of a folder

Parameters:

foid_ - the unique ID of the parent folder

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

sortColumn_ - the column by which the results will be sorted. This is one of the SORT_COLUMN_XXX properties in Folder

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. Use Constants.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 by foid_ does not exist

PrivilegeException - if the current User 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 folder

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder objects representing the child folders of the folder

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if current User 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 of Folder.ACCESS_LEVEL_READ_WRITE or Folder.ACCESS_LEVEL_ADMINISTRATIVE

Parameters:

folderId_ - the unique ID of the folder whose sub-folders are to be retrieved

startPosition_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder objects which represent the writable folders for a user

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if current User 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.

use getChildDocumentsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)

Retrieves the direct child documents of a folder

Parameters:

foid_ - the unique ID of the folder whose child documents are to be retrieved

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

sortColumn_ - the column by which the results will be sorted. This is one of the SORT_COLUMN_XXX properties in Document

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. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if current User 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 retrieved

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Document

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Document objects representing the child documents of the folder

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

PrivilegeException - if current User does not have at least read access to the folder.

ServiceException - if any system-level error occurs

InvalidDocumentException

InvalidKnowledgeCenterException

getFavoriteFolders

@Deprecated
Folder[] getFavoriteFolders(Integer sortOrder_,
 String sortColumn_)
                     throws InvalidUserException

Deprecated.

use getFavoriteFoldersPaging(int, int, java.lang.Integer, java.lang.Integer)

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 of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

sortColumn_ - the field of the Folder by which to sort the returned list of folders. This is one of SORT_COLUMN_XXX in Folder

Returns:

the current user's favorite folders

Throws:

InvalidUserException - if the user calling this method is invalid

ServiceException - 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. 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 results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.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 invalid

ServiceException - if any system-level error occurs

addFolderToFavorites

void addFolderToFavorites(Long foid_)
                   throws InvalidUserException,
InvalidFolderException

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 the Folder specified by foid_ does not exist

InvalidUserException - if the user calling this method is invalid

ServiceException - 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 invalid

InvalidFolderException - if one of the folder IDs does not correspond to a valid folder

ServiceException - if any system-level error occurs

InvalidDataFormatException

removeFolderFromFavorites

void removeFolderFromFavorites(Long foid_)
                        throws InvalidUserException,
InvalidFolderException

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 invalid

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - 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 invalid

InvalidFolderException - if the Folder specified by foid_ does not exist

ServiceException - if any system-level error occurs

InvalidDataFormatException

getAccessLevelForFolder

int getAccessLevelForFolder(Long foid_)
                     throws InvalidFolderException

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:

• Folder.ACCESS_LEVEL_READ_ONLY
• Folder.ACCESS_LEVEL_READ_WRITE
• Folder.ACCESS_LEVEL_ADMINISTRATIVE
• Folder.ACCESS_LEVEL_NO_ACCESS

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - if any system-level error occurs

getAccessLevelForFolders

int[] getAccessLevelForFolders(Long[] foids_)
                        throws InvalidFolderException

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:

• Folder.ACCESS_LEVEL_READ_ONLY
• Folder.ACCESS_LEVEL_READ_WRITE
• Folder.ACCESS_LEVEL_ADMINISTRATIVE
• Folder.ACCESS_LEVEL_NO_ACCESS

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - if any system-level error occurs

setRoleMapForFolder

void setRoleMapForFolder(Long foid_,
 CollaborationRoleMap crm_)
                  throws InvalidFolderException,
InvalidGroupException,
InvalidUserException,
PrivilegeException

Deprecated.

Set the CollaborationRoleMap 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 folder

crm_ - the CollaborationRoleMap object containing the new roles to set

Throws:

InvalidFolderException - if the folder specified by foid_ does not exist

InvalidGroupException - if any group in the role map is invalid

InvalidUserException - if any user in the role map is invalid

PrivilegeException - if the current user is not an administrator of the given folder

ServiceException - if any system-level error occurs

getRoleMapForFolder

CollaborationRoleMap getRoleMapForFolder(Long foid_)
                                  throws InvalidFolderException,
PrivilegeException

Deprecated.

Retrieves the CollaborationRoleMap 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 map

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - 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 its data property populated with the local object type value of the local object that it represents (eg, for Document nodes, the data property of the node will be populated with LocalObjectTypeMapping.TYPE_DOCUMENT)

Parameters:

folderId_ - the unique ID for a Folder

descendantDepth_ - the number of levels below the root that should be returned. Use Constants.COUNT_ALL to return all levels below the root.

Returns:

the TreePivot object which represents a tree whose root is the Folder specified by folderId_. The data in the TreePivot tree are Document and Folder objects. The breadcrumbs contained in the TreePivot go all the way up to the community

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current User does not have at least read access to all the returned folders.

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - 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 its data property populated with the local object type value of the local object that it represents (eg, for Document nodes, the data property of the node will be populated with LocalObjectTypeMapping.TYPE_DOCUMENT)

Parameters:

folderIds_ - an array of unique IDs which each represent a Folder

descendantDepth_ - the number of levels below the root that should be returned for each tree. Use Constants.COUNT_ALL to return all levels below the root.

Returns:

an array of TreePivot objects, each of which represents a tree whose root is the Folder specified by a folder ID

Throws:

InvalidUserException - if the user calling this method is invalid

PrivilegeException - if the current User does not have at least read access to all root folders and all other returned folders.

InvalidFolderException - if the Folder specified by foid_ does not exist

ServiceException - 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 the Folder

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Document.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Document objects representing the document descendants of the folder with ID folderId_

Throws:

InvalidUserException - if the user calling this method is invalid

InvalidFolderException - if the Folder specified by foid_ does not exist

ServiceException - 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 folders

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Document.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.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 invalid

InvalidFolderException - if the folder specified by foid_ does not exist

ServiceException - 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 of Folder.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 of folderName_

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder 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 of Folder.ACCESS_LEVEL_READ_WRITE or Folder.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 of folderName_

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder 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 of Folder.ACCESS_LEVEL_READ_ONLY or Folder.ACCESS_LEVEL_READ_WRITE or Folder.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 of folderName_

startIndex_ - the index into the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize_ - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty_ - the property by which the results will be sorted. This is one of the SORT_BY_XXX constants in Folder.

sortOrder_ - the order in which to sort the results. This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

Returns:

a ResultPage containing an array of Folder 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 a pathSeparator_ of "/". If the Folder existed within a private KnowledgeCenter, the return value would be "/myKC/myFolder/mySubfolder".

Parameters:

folderId_ - the unique ID of the folder

pathSeparator_ - 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 invalid

PrivilegeException - if the current User does not have at least read access to the folder

InvalidFolderException - if the folder specified by folderId_ does not exist

ServiceException - 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 a pathSeparator_ 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 folders

pathSeparator_ - 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 invalid

PrivilegeException - if the current User does not have at least read access to all the folders passed to this method

InvalidFolderException - if any of folderIds does not refer to a valid folder

ServiceException - if any system-level error occurs

getFoldersList

ResultList getFoldersList(Long[] folderIds_)
                   throws InvalidDataFormatException

Deprecated.

Returns a ResultList containing error codes for each value supplied in the parameter and Folder 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 of Folder objects for all valid folders. The possible result codes are any of the CODE_XXX or COLLAB_CODE_XXX constants in ResultList

Throws:

InvalidDataFormatException - if null is passed in

getSystemFolderId

@Deprecated
Long getSystemFolderId(String name)
                throws InvalidFolderException

Deprecated.

use ContentService.getIdByUuid(String) and getFolderIdForContentId(Long)

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
void setSystemFolderId(String name,
 Long id)
                throws InvalidFolderException

Deprecated.

use createFolder(Folder) with a pre-populated UUID

Stores and associates the specified id value with the specified name key.

Parameters:

name - A case-insensitive system name.

id - The 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

Document[] getDocumentsByName(Long folderId,
 String name)

Deprecated.

This call will retrieve all documents of a given folder that have a given name.

Parameters:

folderId - The unique ID of the folder

name - The name of the documents that are to be retrieved

Returns:

An array of Documents

getContentIdForFolderId

Long getContentIdForFolderId(Long id)

Deprecated.

getContentIdsForFolderIds

Long[] getContentIdsForFolderIds(Long[] id)

Deprecated.

getFolderIdForContentId

Long getFolderIdForContentId(Long id)

Deprecated.

getFolderIdsForContentIds

Long[] getFolderIdsForContentIds(Long[] id)

Deprecated.

suggest

String suggest(String query,
 int maxItems,
 SuggestParam[] params,
 Boolean groupResults)

Deprecated.

Parameters:

query -

maxItems -

params - list of information on what is being suggested and what format the results should be in. valid types are 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