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:
  • Field Details

    • getFolder$UPDATES

      static final boolean getFolder$UPDATES
      Deprecated.
      See Also:
    • getFolders$UPDATES

      static final boolean getFolders$UPDATES
      Deprecated.
      See Also:
    • getFoldersPaging$UPDATES

      static final boolean getFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • createFolder$UPDATES

      static final boolean createFolder$UPDATES
      Deprecated.
      See Also:
    • createFolders$UPDATES

      static final boolean createFolders$UPDATES
      Deprecated.
      See Also:
    • updateFolder$UPDATES

      static final boolean updateFolder$UPDATES
      Deprecated.
      See Also:
    • updateFolders$UPDATES

      static final boolean updateFolders$UPDATES
      Deprecated.
      See Also:
    • updateForumForFolder$UPDATES

      static final boolean updateForumForFolder$UPDATES
      Deprecated.
      See Also:
    • updateForumForFolders$UPDATES

      static final boolean updateForumForFolders$UPDATES
      Deprecated.
      See Also:
    • deleteFolder$UPDATES

      static final boolean deleteFolder$UPDATES
      Deprecated.
      See Also:
    • deleteFolders$UPDATES

      static final boolean deleteFolders$UPDATES
      Deprecated.
      See Also:
    • approveChangesForFolder$UPDATES

      static final boolean approveChangesForFolder$UPDATES
      Deprecated.
      See Also:
    • approveChangesForFolders$UPDATES

      static final boolean approveChangesForFolders$UPDATES
      Deprecated.
      See Also:
    • rejectChangesForFolder$UPDATES

      static final boolean rejectChangesForFolder$UPDATES
      Deprecated.
      See Also:
    • rejectChangesForFolders$UPDATES

      static final boolean rejectChangesForFolders$UPDATES
      Deprecated.
      See Also:
    • isFolderEmpty$UPDATES

      static final boolean isFolderEmpty$UPDATES
      Deprecated.
      See Also:
    • getParentFolders$UPDATES

      static final boolean getParentFolders$UPDATES
      Deprecated.
      See Also:
    • getParentFoldersPaging$UPDATES

      static final boolean getParentFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • getChildFolders$UPDATES

      static final boolean getChildFolders$UPDATES
      Deprecated.
      See Also:
    • getChildFoldersPaging$UPDATES

      static final boolean getChildFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • getWritableFoldersForFolderPaging$UPDATES

      static final boolean getWritableFoldersForFolderPaging$UPDATES
      Deprecated.
      See Also:
    • getChildDocuments$UPDATES

      static final boolean getChildDocuments$UPDATES
      Deprecated.
      See Also:
    • getChildDocumentsPaging$UPDATES

      static final boolean getChildDocumentsPaging$UPDATES
      Deprecated.
      See Also:
    • getFavoriteFolders$UPDATES

      static final boolean getFavoriteFolders$UPDATES
      Deprecated.
      See Also:
    • getFavoriteFoldersPaging$UPDATES

      static final boolean getFavoriteFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • addFolderToFavorites$UPDATES

      static final boolean addFolderToFavorites$UPDATES
      Deprecated.
      See Also:
    • addFoldersToFavorites$UPDATES

      static final boolean addFoldersToFavorites$UPDATES
      Deprecated.
      See Also:
    • removeFolderFromFavorites$UPDATES

      static final boolean removeFolderFromFavorites$UPDATES
      Deprecated.
      See Also:
    • removeFoldersFromFavorites$UPDATES

      static final boolean removeFoldersFromFavorites$UPDATES
      Deprecated.
      See Also:
    • getAccessLevelForFolder$UPDATES

      static final boolean getAccessLevelForFolder$UPDATES
      Deprecated.
      See Also:
    • getAccessLevelForFolders$UPDATES

      static final boolean getAccessLevelForFolders$UPDATES
      Deprecated.
      See Also:
    • setRoleMapForFolder$UPDATES

      static final boolean setRoleMapForFolder$UPDATES
      Deprecated.
      See Also:
    • getRoleMapForFolder$UPDATES

      static final boolean getRoleMapForFolder$UPDATES
      Deprecated.
      See Also:
    • getTreeViewForFolder$UPDATES

      static final boolean getTreeViewForFolder$UPDATES
      Deprecated.
      See Also:
    • getTreeViewForFolders$UPDATES

      static final boolean getTreeViewForFolders$UPDATES
      Deprecated.
      See Also:
    • getDescendantDocumentsOfFolderPaging$UPDATES

      static final boolean getDescendantDocumentsOfFolderPaging$UPDATES
      Deprecated.
      See Also:
    • getDescendantDocumentsOfFoldersPaging$UPDATES

      static final boolean getDescendantDocumentsOfFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • findAdministratableFoldersPaging$UPDATES

      static final boolean findAdministratableFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • findWritableFoldersPaging$UPDATES

      static final boolean findWritableFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • findReadableFoldersPaging$UPDATES

      static final boolean findReadableFoldersPaging$UPDATES
      Deprecated.
      See Also:
    • getFullPathStringToFolder$UPDATES

      static final boolean getFullPathStringToFolder$UPDATES
      Deprecated.
      See Also:
    • getFullPathStringToFolders$UPDATES

      static final boolean getFullPathStringToFolders$UPDATES
      Deprecated.
      See Also:
    • getFoldersList$UPDATES

      static final boolean getFoldersList$UPDATES
      Deprecated.
      See Also:
    • getSystemFolderId$UPDATES

      static final boolean getSystemFolderId$UPDATES
      Deprecated.
      See Also:
    • setSystemFolderId$UPDATES

      static final boolean setSystemFolderId$UPDATES
      Deprecated.
      See Also:
    • getMyTaskViewFolder$UPDATES

      static final boolean getMyTaskViewFolder$UPDATES
      Deprecated.
      See Also:
    • getMyProcessViewFolder$UPDATES

      static final boolean getMyProcessViewFolder$UPDATES
      Deprecated.
      See Also:
    • getMyReportsFolder$UPDATES

      static final boolean getMyReportsFolder$UPDATES
      Deprecated.
      See Also:
    • getPersonalizedTaskViewsFolder$UPDATES

      static final boolean getPersonalizedTaskViewsFolder$UPDATES
      Deprecated.
      See Also:
    • getDocumentsByName$UPDATES

      static final boolean getDocumentsByName$UPDATES
      Deprecated.
      See Also:
    • getContentIdForFolderId$UPDATES

      static final boolean getContentIdForFolderId$UPDATES
      Deprecated.
      See Also:
    • getContentIdsForFolderIds$UPDATES

      static final boolean getContentIdsForFolderIds$UPDATES
      Deprecated.
      See Also:
    • getFolderIdForContentId$UPDATES

      static final boolean getFolderIdForContentId$UPDATES
      Deprecated.
      See Also:
    • getFolderIdsForContentIds$UPDATES

      static final boolean getFolderIdsForContentIds$UPDATES
      Deprecated.
      See Also:
    • suggest$UPDATES

      static final boolean suggest$UPDATES
      Deprecated.
      See Also:
  • Method Details