ContentService
instead.@Deprecated
public interface FolderService
extends com.appiancorp.services.ContextSensitiveService
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.
Modifier and Type | Field and Description |
---|---|
static boolean |
addFoldersToFavorites$UPDATES
Deprecated.
|
static boolean |
addFolderToFavorites$UPDATES
Deprecated.
|
static boolean |
approveChangesForFolder$UPDATES
Deprecated.
|
static boolean |
approveChangesForFolders$UPDATES
Deprecated.
|
static boolean |
createFolder$UPDATES
Deprecated.
|
static boolean |
createFolders$UPDATES
Deprecated.
|
static boolean |
deleteFolder$UPDATES
Deprecated.
|
static boolean |
deleteFolders$UPDATES
Deprecated.
|
static boolean |
findAdministratableFoldersPaging$UPDATES
Deprecated.
|
static boolean |
findReadableFoldersPaging$UPDATES
Deprecated.
|
static boolean |
findWritableFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getAccessLevelForFolder$UPDATES
Deprecated.
|
static boolean |
getAccessLevelForFolders$UPDATES
Deprecated.
|
static boolean |
getChildDocuments$UPDATES
Deprecated.
|
static boolean |
getChildDocumentsPaging$UPDATES
Deprecated.
|
static boolean |
getChildFolders$UPDATES
Deprecated.
|
static boolean |
getChildFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getContentIdForFolderId$UPDATES
Deprecated.
|
static boolean |
getContentIdsForFolderIds$UPDATES
Deprecated.
|
static boolean |
getDescendantDocumentsOfFolderPaging$UPDATES
Deprecated.
|
static boolean |
getDescendantDocumentsOfFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getDocumentsByName$UPDATES
Deprecated.
|
static boolean |
getFavoriteFolders$UPDATES
Deprecated.
|
static boolean |
getFavoriteFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getFolder$UPDATES
Deprecated.
|
static boolean |
getFolderIdForContentId$UPDATES
Deprecated.
|
static boolean |
getFolderIdsForContentIds$UPDATES
Deprecated.
|
static boolean |
getFolders$UPDATES
Deprecated.
|
static boolean |
getFoldersList$UPDATES
Deprecated.
|
static boolean |
getFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getFullPathStringToFolder$UPDATES
Deprecated.
|
static boolean |
getFullPathStringToFolders$UPDATES
Deprecated.
|
static boolean |
getMyProcessViewFolder$UPDATES
Deprecated.
|
static boolean |
getMyReportsFolder$UPDATES
Deprecated.
|
static boolean |
getMyTaskViewFolder$UPDATES
Deprecated.
|
static boolean |
getParentFolders$UPDATES
Deprecated.
|
static boolean |
getParentFoldersPaging$UPDATES
Deprecated.
|
static boolean |
getPersonalizedTaskViewsFolder$UPDATES
Deprecated.
|
static boolean |
getRoleMapForFolder$UPDATES
Deprecated.
|
static boolean |
getSystemFolderId$UPDATES
Deprecated.
|
static boolean |
getTreeViewForFolder$UPDATES
Deprecated.
|
static boolean |
getTreeViewForFolders$UPDATES
Deprecated.
|
static boolean |
getWritableFoldersForFolderPaging$UPDATES
Deprecated.
|
static boolean |
isFolderEmpty$UPDATES
Deprecated.
|
static boolean |
rejectChangesForFolder$UPDATES
Deprecated.
|
static boolean |
rejectChangesForFolders$UPDATES
Deprecated.
|
static boolean |
removeFolderFromFavorites$UPDATES
Deprecated.
|
static boolean |
removeFoldersFromFavorites$UPDATES
Deprecated.
|
static boolean |
setRoleMapForFolder$UPDATES
Deprecated.
|
static boolean |
setSystemFolderId$UPDATES
Deprecated.
|
static boolean |
suggest$UPDATES
Deprecated.
|
static boolean |
updateFolder$UPDATES
Deprecated.
|
static boolean |
updateFolders$UPDATES
Deprecated.
|
static boolean |
updateForumForFolder$UPDATES
Deprecated.
|
static boolean |
updateForumForFolders$UPDATES
Deprecated.
|
Modifier and Type | Method and Description |
---|---|
void |
addFoldersToFavorites(java.lang.Long[] foids_)
Deprecated.
Adds multiple folders to the current user's "Favorites" list.
|
void |
addFolderToFavorites(java.lang.Long foid_)
Deprecated.
Adds a folder to the current user's "Favorites" list.
|
java.lang.Long[] |
approveChangesForFolder(java.lang.Long foid_)
Deprecated.
Approves the creation or deletion of a folder (within a knowledge
center for which changes require approval).
|
java.lang.Long[] |
approveChangesForFolders(java.lang.Long[] foids_)
Deprecated.
Approves the creation or deletion of multiple folders (within a knowledge
center for which changes require approval).
|
java.lang.Long |
createFolder(Folder folder_)
Deprecated.
Creates a new folder
NOTE: The only fields that are actually used in the create are
name , searchable , knowledgeCenterId
and parentFolderId . |
java.lang.Long[] |
createFolders(Folder[] folders_)
Deprecated.
Creates multiple folders
NOTE: The only fields that are actually used in the create are
name , searchable , knowledgeCenterId
and parentFolderId . |
void |
deleteFolder(java.lang.Long foid_)
Deprecated.
Deletes a folder
|
void |
deleteFolders(java.lang.Long[] foids_)
Deprecated.
Deletes multiple folders
|
ResultPage |
findAdministratableFoldersPaging(java.lang.String folderName_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.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(java.lang.String folderName_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.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(java.lang.String folderName_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.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(java.lang.Long foid_)
Deprecated.
Retrieves the current user's access level for a folder
|
int[] |
getAccessLevelForFolders(java.lang.Long[] foids_)
Deprecated.
Retrieves the current user's access levels for multiple folders
|
Document[] |
getChildDocuments(java.lang.Long foid_,
java.lang.Integer sortOrder_,
java.lang.String sortColumn_,
int startIndex_,
int scrollLength_)
|
ResultPage |
getChildDocumentsPaging(java.lang.Long foid_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves the direct child documents of a folder
|
Folder[] |
getChildFolders(java.lang.Long foid_,
java.lang.Integer sortOrder_,
java.lang.String sortColumn_,
int startIndex_,
int scrollLength_)
|
ResultPage |
getChildFoldersPaging(java.lang.Long foid_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieves the direct child folders of a folder
|
java.lang.Long |
getContentIdForFolderId(java.lang.Long id)
Deprecated.
|
java.lang.Long[] |
getContentIdsForFolderIds(java.lang.Long[] id)
Deprecated.
|
ResultPage |
getDescendantDocumentsOfFolderPaging(java.lang.Long folderId_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a flat list of all documents in a given folder and its subfolders
|
ResultPage |
getDescendantDocumentsOfFoldersPaging(java.lang.Long[] folderIds_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Get a flat list of all documents in a list of folders and their subfolders
|
Document[] |
getDocumentsByName(java.lang.Long folderId,
java.lang.String name)
Deprecated.
This call will retrieve all documents of a given folder that have a given name.
|
Folder[] |
getFavoriteFolders(java.lang.Integer sortOrder_,
java.lang.String sortColumn_)
|
ResultPage |
getFavoriteFoldersPaging(int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Retrieve all the folders that are in the current user's "Favorites" list.
|
Folder |
getFolder(java.lang.Long foid_)
Deprecated.
Gets information about a folder
|
java.lang.Long |
getFolderIdForContentId(java.lang.Long id)
Deprecated.
|
java.lang.Long[] |
getFolderIdsForContentIds(java.lang.Long[] id)
Deprecated.
|
Folder[] |
getFolders(java.lang.Long[] foids_)
|
ResultList |
getFoldersList(java.lang.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(java.lang.Long[] foids_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.Integer sortOrder_)
Deprecated.
Gets Information about multiple folders
|
java.lang.String |
getFullPathStringToFolder(java.lang.Long folderId_,
java.lang.String pathSeparator_)
Deprecated.
Gets the path to a folder through the Collaboration navigation
tree.
|
java.lang.String[] |
getFullPathStringToFolders(java.lang.Long[] folderIds_,
java.lang.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(java.lang.Long foid_)
|
ResultPage |
getParentFoldersPaging(java.lang.Long foid_,
int startIndex_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.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(java.lang.Long foid_)
Deprecated.
Retrieves the
CollaborationRoleMap for a given folder |
java.lang.Long |
getSystemFolderId(java.lang.String name)
Deprecated.
|
TreePivot |
getTreeViewForFolder(java.lang.Long folderId_,
int descendantDepth_)
Deprecated.
Get the tree pivoted at a particular folder.
|
TreePivot[] |
getTreeViewForFolders(java.lang.Long[] folderIds_,
int descendantDepth_)
Deprecated.
Get the trees pivoted at particular folders.
|
ResultPage |
getWritableFoldersForFolderPaging(java.lang.Long folderId_,
int startPosition_,
int batchSize_,
java.lang.Integer sortProperty_,
java.lang.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(java.lang.Long foid_)
Deprecated.
Checks whether a folder contains any children (documents or sub-folders)
|
void |
rejectChangesForFolder(java.lang.Long foid_)
Deprecated.
Rejects the creation or deletion of a folder (within a knowledge
center for which changes require approval).
|
void |
rejectChangesForFolders(java.lang.Long[] foids_)
Deprecated.
Rejects the creation or deletion of multiple folders (within a knowledge
center for which changes require approval).
|
void |
removeFolderFromFavorites(java.lang.Long foid_)
Deprecated.
Removes a folder from the current user's "Favorites" list
|
void |
removeFoldersFromFavorites(java.lang.Long[] foids_)
Deprecated.
Removes multiple folders from the current user's "Favorites" list
|
void |
setRoleMapForFolder(java.lang.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(java.lang.String name,
java.lang.Long id)
Deprecated.
use
createFolder(Folder) with a pre-populated UUID |
java.lang.String |
suggest(java.lang.String query,
int maxItems,
SuggestParam[] params,
java.lang.Boolean groupResults)
Deprecated.
|
java.lang.String |
suggest(java.lang.String query,
int maxItems,
SuggestParam[] params,
java.lang.Boolean groupResults,
java.lang.Long[] allowList)
Deprecated.
|
void |
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
|
static final boolean getFolder$UPDATES
static final boolean getFolders$UPDATES
static final boolean getFoldersPaging$UPDATES
static final boolean createFolder$UPDATES
static final boolean createFolders$UPDATES
static final boolean updateFolder$UPDATES
static final boolean updateFolders$UPDATES
static final boolean updateForumForFolder$UPDATES
static final boolean updateForumForFolders$UPDATES
static final boolean deleteFolder$UPDATES
static final boolean deleteFolders$UPDATES
static final boolean approveChangesForFolder$UPDATES
static final boolean approveChangesForFolders$UPDATES
static final boolean rejectChangesForFolder$UPDATES
static final boolean rejectChangesForFolders$UPDATES
static final boolean isFolderEmpty$UPDATES
static final boolean getParentFolders$UPDATES
static final boolean getParentFoldersPaging$UPDATES
static final boolean getChildFolders$UPDATES
static final boolean getChildFoldersPaging$UPDATES
static final boolean getWritableFoldersForFolderPaging$UPDATES
static final boolean getChildDocuments$UPDATES
static final boolean getChildDocumentsPaging$UPDATES
static final boolean getFavoriteFolders$UPDATES
static final boolean getFavoriteFoldersPaging$UPDATES
static final boolean addFolderToFavorites$UPDATES
static final boolean addFoldersToFavorites$UPDATES
static final boolean removeFolderFromFavorites$UPDATES
static final boolean removeFoldersFromFavorites$UPDATES
static final boolean getAccessLevelForFolder$UPDATES
static final boolean getAccessLevelForFolders$UPDATES
static final boolean setRoleMapForFolder$UPDATES
static final boolean getRoleMapForFolder$UPDATES
static final boolean getTreeViewForFolder$UPDATES
static final boolean getTreeViewForFolders$UPDATES
static final boolean getDescendantDocumentsOfFolderPaging$UPDATES
static final boolean getDescendantDocumentsOfFoldersPaging$UPDATES
static final boolean findAdministratableFoldersPaging$UPDATES
static final boolean findWritableFoldersPaging$UPDATES
static final boolean findReadableFoldersPaging$UPDATES
static final boolean getFullPathStringToFolder$UPDATES
static final boolean getFullPathStringToFolders$UPDATES
static final boolean getFoldersList$UPDATES
static final boolean getSystemFolderId$UPDATES
static final boolean setSystemFolderId$UPDATES
static final boolean getMyTaskViewFolder$UPDATES
static final boolean getMyProcessViewFolder$UPDATES
static final boolean getMyReportsFolder$UPDATES
static final boolean getPersonalizedTaskViewsFolder$UPDATES
static final boolean getDocumentsByName$UPDATES
static final boolean getContentIdForFolderId$UPDATES
static final boolean getContentIdsForFolderIds$UPDATES
static final boolean getFolderIdForContentId$UPDATES
static final boolean getFolderIdsForContentIds$UPDATES
static final boolean suggest$UPDATES
Folder getFolder(java.lang.Long foid_) throws InvalidFolderException, InvalidUserException, PrivilegeException
foid_
- the unique ID of the folderFolder
object representing the folder with
unique IDInvalidFolderException
- 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 of Folder.ACCESS_LEVEL_READ_ONLY
,
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occurs@Deprecated Folder[] getFolders(java.lang.Long[] foids_) throws InvalidFolderException, InvalidUserException, PrivilegeException
foids_
- a list of unique IDs of the foldersFolder
objects representing the folders
with unique IDsInvalidFolderException
- 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 of Folder.ACCESS_LEVEL_READ_ONLY
,
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occursResultPage getFoldersPaging(java.lang.Long[] foids_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidFolderException, InvalidUserException, PrivilegeException
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.
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
Folder
objects
representing the folders with the unique IDsInvalidFolderException
- 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 of Folder.ACCESS_LEVEL_READ_ONLY
,
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occursjava.lang.Long createFolder(Folder folder_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
NOTE: The only fields that are actually used in the create are
name
, searchable
, knowledgeCenterId
and parentFolderId
. All other fields are ignored.
folder_
- a Folder
object which should contain
all of the information required to create a valid folder.
Minimum required fields: name
, searchable
,
knowledgeCenterId
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 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 centerServiceException
- if any system-level error occursjava.lang.Long[] createFolders(Folder[] folders_) throws InvalidUserException, PrivilegeException, InvalidKnowledgeCenterException
NOTE: The only fields that are actually used in the create are
name
, searchable
, knowledgeCenterId
and parentFolderId
. All other fields are ignored.
folders_
- an array of Folder
objects which should
contain all of the information required to create valid folders.
Minimum required fields: name
, searchable
,
knowledgeCenterId
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 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 centerServiceException
- if any system-level error occursvoid updateFolder(Folder folder_) throws InvalidFolderException, InvalidUserException, PrivilegeException
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.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 of Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occursvoid updateFolders(Folder[] folders_) throws InvalidFolderException, InvalidUserException, PrivilegeException
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.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 of Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
ServiceException
- if any system-level error occursvoid updateForumForFolder(Folder folder_) throws InvalidFolderException, PrivilegeException
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.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 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 folderServiceException
- if any system-level error occursvoid updateForumForFolders(Folder[] folders_) throws InvalidFolderException, PrivilegeException
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.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 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
folderServiceException
- if any system-level error occursvoid deleteFolder(java.lang.Long foid_) throws InvalidFolderException, InvalidUserException, NotEmptyException, PrivilegeException
foid_
- the unique ID of the folder to be deletedInvalidFolderException
- if the Folder
specified by
foid_
does not existInvalidUserException
- if the user calling this method is invalidNotEmptyException
- if the folders contains documents or sub-foldersPrivilegeException
- if the current User
is not an
administrator or the creator of the folder.ServiceException
- if any system-level error occursvoid deleteFolders(java.lang.Long[] foids_) throws InvalidFolderException, InvalidUserException, NotEmptyException, PrivilegeException
foids_
- a list containing the unique IDs of the Folder
objects to be deletedInvalidFolderException
- if any of the folders specified by
foids_
do not existInvalidUserException
- if the user calling this method is invalidNotEmptyException
- if any of the folders contain documents or
sub-foldersPrivilegeException
- if the current User
is not an
administrator or creator of all of the foldersServiceException
- if any system-level error occursjava.lang.Long[] approveChangesForFolder(java.lang.Long foid_) throws InvalidUserException, InvalidDataFormatException, PrivilegeException, InvalidFolderException
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 deletionInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
is not an
administrator of the KnowledgeCenter
to which this folder
belongsInvalidFolderException
- if the Folder
does not existInvalidDataFormatException
- if the folder id provided is
null
ServiceException
- if any system-level error occursjava.lang.Long[] approveChangesForFolders(java.lang.Long[] foids_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException
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 deletionfoids_
or any of their subfolders) which could not be deleted because they are
not empty (they contain documents or subfolders)InvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
is not an
administrator of the KnowledgeCenter
objects to which
these folders belongInvalidFolderException
- if any of the Folder
objects
specified by foids_
do not existInvalidDataFormatException
- if one or more folder ids provided are
null
ServiceException
- if any system-level error occursvoid rejectChangesForFolder(java.lang.Long foid_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException, NotEmptyException
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 deletionInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
is not an
administrator of the KnowledgeCenter
to which this folder
belongsInvalidFolderException
- if the Folder
specified by
foid_
does not existNotEmptyException
- 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 occursvoid rejectChangesForFolders(java.lang.Long[] foids_) throws InvalidUserException, PrivilegeException, InvalidFolderException, InvalidDataFormatException, NotEmptyException
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 deletionInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
is not an
administrator of the KnowledgeCenter
objects to which
these folders belongInvalidFolderException
- if any of the folders specified by
foids_
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 are
null
ServiceException
- if any system-level error occursboolean isFolderEmpty(java.lang.Long foid_) throws InvalidFolderException
foid_
- the unique ID of the folderFolder
is empty, false otherwiseInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occurs@Deprecated Folder[] getParentFolders(java.lang.Long foid_) throws InvalidFolderException
getParentFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
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.foid_
- the unique ID of the folder whose parents are to be retrievedfoid_
InvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursResultPage getParentFoldersPaging(java.lang.Long foid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidFolderException
foid_
will be returned.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.
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
ResultPage
containing an array of
Folder
objects representing the parents of the specified
folder,and also the folder referenced by foid_
InvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occurs@Deprecated Folder[] getChildFolders(java.lang.Long foid_, java.lang.Integer sortOrder_, java.lang.String sortColumn_, int startIndex_, int scrollLength_) throws InvalidFolderException, PrivilegeException
getChildFoldersPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
foid_
- the unique ID of the parent foldersortOrder_
- 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.foid_
InvalidFolderException
- if the folder specified by
foid_
does not existPrivilegeException
- if the current User
does not
have at least read access to the folder and its children.ResultPage getChildFoldersPaging(java.lang.Long foid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidFolderException, InvalidUserException, PrivilegeException
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.
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
ResultPage
containing an array of
Folder
objects representing the child folders of the folderInvalidFolderException
- if the folder specified by
foid_
does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if current User
does not
have at least read access to the folder and its children.ServiceException
- if any system-level error occursResultPage getWritableFoldersForFolderPaging(java.lang.Long folderId_, int startPosition_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, PrivilegeException
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
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.
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
ResultPage
containing an array of
Folder
objects which represent the writable folders for a
userInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if current User
does not
have at least read access to the folder and its children.ServiceException
- if any system-level error occurs@Deprecated Document[] getChildDocuments(java.lang.Long foid_, java.lang.Integer sortOrder_, java.lang.String sortColumn_, int startIndex_, int scrollLength_) throws InvalidFolderException, InvalidUserException, PrivilegeException
getChildDocumentsPaging(java.lang.Long, int, int, java.lang.Integer, java.lang.Integer)
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 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.InvalidFolderException
- if the folder specified by
foid_
does not existInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if current User
does not
have at least read access to the folder.ServiceException
- if any system-level error occursResultPage getChildDocumentsPaging(java.lang.Long foid_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidFolderException, InvalidDocumentException, PrivilegeException, InvalidKnowledgeCenterException
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.
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
ResultPage
containing an array of
Document
objects representing the child documents of the
folderInvalidFolderException
- if the folder specified by
foid_
does not existPrivilegeException
- if current User
does not
have at least read access to the folder.ServiceException
- if any system-level error occursInvalidDocumentException
InvalidKnowledgeCenterException
@Deprecated Folder[] getFavoriteFolders(java.lang.Integer sortOrder_, java.lang.String sortColumn_) throws InvalidUserException
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
InvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursResultPage getFavoriteFoldersPaging(int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException
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
ResultPage
containing an array of folders
in the current user's "Favorites" listInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursvoid addFolderToFavorites(java.lang.Long foid_) throws InvalidUserException, InvalidFolderException
foid_
- the unique ID of the folder to be addedInvalidFolderException
- if the Folder
specified by
foid_
does not existInvalidUserException
- if the user calling this method is invalidServiceException
- if any system-level error occursvoid addFoldersToFavorites(java.lang.Long[] foids_) throws InvalidUserException, InvalidFolderException, InvalidDataFormatException
foids_
- a list of unique IDs representing the folders to
be addedInvalidUserException
- 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
void removeFolderFromFavorites(java.lang.Long foid_) throws InvalidUserException, InvalidFolderException
foid_
- the unique ID of the folder to be removedInvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursvoid removeFoldersFromFavorites(java.lang.Long[] foids_) throws InvalidUserException, InvalidFolderException, InvalidDataFormatException
foids_
- a list of unique IDs for the folders to
be removedInvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the Folder
specified by
foid_
does not existServiceException
- if any system-level error occursInvalidDataFormatException
int getAccessLevelForFolder(java.lang.Long foid_) throws InvalidFolderException
foid_
- the unique ID of the folderInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursint[] getAccessLevelForFolders(java.lang.Long[] foids_) throws InvalidFolderException
foids_
- a list of unique IDs of the foldersInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursvoid setRoleMapForFolder(java.lang.Long foid_, CollaborationRoleMap crm_) throws InvalidFolderException, InvalidGroupException, InvalidUserException, PrivilegeException
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 centerfoid_
- the unique ID for a foldercrm_
- the CollaborationRoleMap
object containing the new
roles to setInvalidFolderException
- if the folder specified by
foid_
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 occursCollaborationRoleMap getRoleMapForFolder(java.lang.Long foid_) throws InvalidFolderException, PrivilegeException
CollaborationRoleMap
for a given folderfoid_
- the unique ID for a folderCollaborationRoleMap
object containing the
roles for the folderPrivilegeException
- if the current user does not have enough privileges
to view the role mapInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursTreePivot getTreeViewForFolder(java.lang.Long folderId_, int descendantDepth_) throws InvalidUserException, PrivilegeException, InvalidFolderException
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
)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.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 communityInvalidUserException
- if the user calling this method is invalidPrivilegeException
- 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 existServiceException
- if any system-level error occursTreePivot[] getTreeViewForFolders(java.lang.Long[] folderIds_, int descendantDepth_) throws InvalidUserException, PrivilegeException, InvalidFolderException
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
)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.TreePivot
objects, each of which
represents a tree whose root is the Folder
specified by
a folder IDInvalidUserException
- if the user calling this method is invalidPrivilegeException
- 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 existServiceException
- if any system-level error occursResultPage getDescendantDocumentsOfFolderPaging(java.lang.Long folderId_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidFolderException
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
Document
objects
representing the document descendants of the folder with ID
folderId_
InvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the Folder
specified by
foid_
does not existServiceException
- if any system-level error occursResultPage getDescendantDocumentsOfFoldersPaging(java.lang.Long[] folderIds_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_) throws InvalidUserException, InvalidFolderException
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.
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
Document
objects
representing the document descendants of the foldersInvalidUserException
- if the user calling this method is invalidInvalidFolderException
- if the folder specified by
foid_
does not existServiceException
- if any system-level error occursResultPage findAdministratableFoldersPaging(java.lang.String folderName_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
Folder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match
the given folder name.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
ResultPage
containing an array of
Folder
objects which match the given criteriaServiceException
- if any system-level error occursResultPage findWritableFoldersPaging(java.lang.String folderName_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given
folder name.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
ResultPage
containing an array of
Folder
objects which match the given criteriaServiceException
- if any system-level error occursResultPage findReadableFoldersPaging(java.lang.String folderName_, int startIndex_, int batchSize_, java.lang.Integer sortProperty_, java.lang.Integer sortOrder_)
Folder.ACCESS_LEVEL_READ_ONLY
or
Folder.ACCESS_LEVEL_READ_WRITE
or
Folder.ACCESS_LEVEL_ADMINISTRATIVE
) and which match the given
folder name.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
ResultPage
containing an array of
Folder
objects which match the given criteriaServiceException
- if any system-level error occursjava.lang.String getFullPathStringToFolder(java.lang.Long folderId_, java.lang.String pathSeparator_) throws InvalidUserException, PrivilegeException, InvalidFolderException
pathSeparator_
of "/". If the Folder
existed within a private
KnowledgeCenter
, the return value would be
"/myKC/myFolder/mySubfolder".folderId_
- the unique ID of the folderpathSeparator_
- the string which will be used to separate entries
in the pathInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
does not have
at least read access to the folderInvalidFolderException
- if the folder specified by
folderId_
does not existServiceException
- if any system-level error occursjava.lang.String[] getFullPathStringToFolders(java.lang.Long[] folderIds_, java.lang.String pathSeparator_) throws InvalidUserException, PrivilegeException, InvalidFolderException
pathSeparator_
of "/". If the folder existed within a private
knowledge center, the return value would be "/myKC/myFolder/mySubfolder".folderIds_
- the unique IDs of the folderspathSeparator_
- the string which will be used to separate entries
in the pathsInvalidUserException
- if the user calling this method is invalidPrivilegeException
- if the current User
does not have
at least read access to all the folders passed to this methodInvalidFolderException
- if any of folderIds
does not
refer to a valid folderServiceException
- if any system-level error occursResultList getFoldersList(java.lang.Long[] folderIds_) throws InvalidDataFormatException
Folder
objects for each value which corresponds
to a valid folderfolderIds_
- unique Ids of folders to retrieveInteger
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
InvalidDataFormatException
- if null is passed in@Deprecated java.lang.Long getSystemFolderId(java.lang.String name) throws InvalidFolderException
ContentService.getIdByUuid(String)
and
getFolderIdForContentId(Long)
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_idInvalidFolderException
- if the string is not recognized.@Deprecated void setSystemFolderId(java.lang.String name, java.lang.Long id) throws InvalidFolderException
createFolder(Folder)
with a pre-populated UUIDid
value with the specified
name
key.name
- A case-insensitive system name.id
- The folder id.InvalidFolderException
- if the string is not recognized.Folder getMyTaskViewFolder()
Folder
.Folder getMyProcessViewFolder()
Folder
.Folder getMyReportsFolder()
Folder
.Folder getPersonalizedTaskViewsFolder()
Folder
.Document[] getDocumentsByName(java.lang.Long folderId, java.lang.String name)
folderId
- The unique ID of the foldername
- The name of the documents that are to be retrievedDocument
sjava.lang.Long getContentIdForFolderId(java.lang.Long id)
java.lang.Long[] getContentIdsForFolderIds(java.lang.Long[] id)
java.lang.Long getFolderIdForContentId(java.lang.Long id)
java.lang.Long[] getFolderIdsForContentIds(java.lang.Long[] id)
java.lang.String suggest(java.lang.String query, int maxItems, SuggestParam[] params, java.lang.Boolean groupResults)
query
- maxItems
- params
- list of information on what is being suggested and what format the results should be in. valid types are 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.java.lang.String suggest(java.lang.String query, int maxItems, SuggestParam[] params, java.lang.Boolean groupResults, java.lang.Long[] allowList)
query
- maxItems
- params
- list of information on what is being suggested and what format the results should be in. valid types are 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.Copyright © 2003-2024 Appian Corporation. All Rights Reserved.