Package com.appiancorp.suiteapi.collaboration

Interface CollaborationSearchService

All Superinterfaces:
com.appiancorp.services.ContextSensitiveService, Service
@Deprecated public interface CollaborationSearchService extends com.appiancorp.services.ContextSensitiveService
Deprecated.
Use the class ContentService instead.
Provides search functionality related to the Collaboration application

Method generateSearchIndex(java.sql.Timestamp) will generate an index file for all collaboration entities (documents, folders, knowledge centers, communities) created or updated after a particular time. This index file can be used by the search engine to facilitate searching on the entities

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

    • INVALID

      static final int INVALID
      Deprecated.
      See Also:

    • CANTSEE

      static final int CANTSEE
      Deprecated.
      See Also:

    • READER

      static final int READER
      Deprecated.
      See Also:

    • EDITOR

      static final int EDITOR
      Deprecated.
      See Also:

    • ADMIN

      static final int ADMIN
      Deprecated.
      See Also:

    • generateSearchIndex$UPDATES

      @Deprecated(forRemoval=true) static final boolean generateSearchIndex$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForDocumentIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForDocumentIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForDocumentIdsForUser$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForDocumentIdsForUser$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForFolderIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForFolderIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForFolderIdsForUser$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForFolderIdsForUser$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForKnowledgeCenterIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForKnowledgeCenterIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForKnowledgeCenterIdsForUser$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForKnowledgeCenterIdsForUser$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForCommunityIds$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForCommunityIds$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

    • getPermissionsForCommunityIdsForUser$UPDATES

      @Deprecated(forRemoval=true) static final boolean getPermissionsForCommunityIdsForUser$UPDATES
      Deprecated, for removal: This API element is subject to removal in a future version.
      See Also:

  • Method Details

    • generateSearchIndex

      @Write({K_COLLAB_FORCE_PRIMARY,DISK_FILE}) @Deprecated String generateSearchIndex(Timestamp timeStamp_)
      Deprecated.
      generates large files on disk (not object store)
      Generates search index bodies for: Documents, Folders, KnowledgeCenters, and Communitys
      Parameters:
      timeStamp_ - only include entities modified since this time. Pass null to perform a full index generation
      Returns:
      filename of search index output, the caller is responsible for deleting this file once done with it
      Throws:
      ServiceException - if any system-level error occurs

    • getPermissionsForDocumentIds

      @Read(K_COLLAB) int[] getPermissionsForDocumentIds(Long[] documentIds_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the current user has for a list of document IDs
      Parameters:
      documentIds_ - the IDs of the documents for which to return the permission levels
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the document with the given ID. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForDocumentIdsForUser

      @Read(K_COLLAB) int[] getPermissionsForDocumentIdsForUser(Long[] documentIds_, String userName_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of document IDs
      Parameters:
      documentIds_ - the IDs of the documents for which to return the permission levels
      userName_ - the username of the user for whom to check permissions
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the document with the given id. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForFolderIds

      @Read(K_COLLAB) int[] getPermissionsForFolderIds(Long[] folderIds_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of folder IDs
      Parameters:
      folderIds_ - the IDs of the folders for which to return the permission levels
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the folder with given ID. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForFolderIdsForUser

      @Read(K_COLLAB) int[] getPermissionsForFolderIdsForUser(Long[] folderIds_, String userName_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of folder IDs
      Parameters:
      folderIds_ - the IDs of the folders for which to return the permission levels
      userName_ - the username of the user for whom to check permissions
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the folder with the given id. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForKnowledgeCenterIds

      @Read(K_COLLAB) int[] getPermissionsForKnowledgeCenterIds(Long[] knowledgeCenterIds_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of knowledge center IDs
      Parameters:
      knowledgeCenterIds_ - the IDs of the knowledge centers for which to return the permission levels
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the knowledge center with the given id. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForKnowledgeCenterIdsForUser

      @Read(K_COLLAB) int[] getPermissionsForKnowledgeCenterIdsForUser(Long[] knowledgeCenterIds_, String userName_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of knowledge center IDs
      Parameters:
      knowledgeCenterIds_ - the IDs of the knowledge centers for which to return the permission levels
      userName_ - the username of the user for whom to check permissions
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the knowledge center with the given ID. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForCommunityIds

      @Read(K_COLLAB) int[] getPermissionsForCommunityIds(Long[] communityIds_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of community IDs
      Parameters:
      communityIds_ - the IDs of the communities for which to return the permission levels. If communityIds_ is null the the method will get the permission levels for all communities.
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the community with the given ID. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs

    • getPermissionsForCommunityIdsForUser

      @Read(K_COLLAB) int[] getPermissionsForCommunityIdsForUser(Long[] communityIds_, String userName_) throws InvalidUserException
      Deprecated.
      Gets the permissions which the specified user has for a list of community IDs
      Parameters:
      communityIds_ - the IDs of the communities for which to return the permission levels
      userName_ - the username of the user for whom to check permissions
      Returns:
      array of same size as input array, where each member is a constant representing access capabilities for the current user to the community with the given id. The constant values are as follows:
      Throws:
      InvalidUserException - if the user calling this method does not exist
      ServiceException - if any system-level error occurs