com.appiancorp.suiteapi.collaboration

Interface CollaborationSearchService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

Deprecated.

Use the class ContentService instead.

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

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:

AdministrationService, CommunityService, DocumentService, FolderService, KnowledgeCenterService, ReportingService, StatisticsService

Field Summary

Fields

Modifier and Type	Field and Description
static int	ADMIN Deprecated.
static int	CANTSEE Deprecated.
static int	EDITOR Deprecated.
static boolean	generateSearchIndex$UPDATES Deprecated.
static boolean	getPermissionsForCommunityIds$UPDATES Deprecated.
static boolean	getPermissionsForCommunityIdsForUser$UPDATES Deprecated.
static boolean	getPermissionsForDocumentIds$UPDATES Deprecated.
static boolean	getPermissionsForDocumentIdsForUser$UPDATES Deprecated.
static boolean	getPermissionsForFolderIds$UPDATES Deprecated.
static boolean	getPermissionsForFolderIdsForUser$UPDATES Deprecated.
static boolean	getPermissionsForKnowledgeCenterIds$UPDATES Deprecated.
static boolean	getPermissionsForKnowledgeCenterIdsForUser$UPDATES Deprecated.
static int	INVALID Deprecated.
static int	READER Deprecated.

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
java.lang.String	generateSearchIndex(java.sql.Timestamp timeStamp_) Deprecated. Generates search index bodies for: Documents, Folders, KnowledgeCenters, and Communitys
int[]	getPermissionsForCommunityIds(java.lang.Long[] communityIds_) Deprecated. Gets the permissions which the specified user has for a list of community IDs
int[]	getPermissionsForCommunityIdsForUser(java.lang.Long[] communityIds_, java.lang.String userName_) Deprecated. Gets the permissions which the specified user has for a list of community IDs
int[]	getPermissionsForDocumentIds(java.lang.Long[] documentIds_) Deprecated. Gets the permissions which the current user has for a list of document IDs
int[]	getPermissionsForDocumentIdsForUser(java.lang.Long[] documentIds_, java.lang.String userName_) Deprecated. Gets the permissions which the specified user has for a list of document IDs
int[]	getPermissionsForFolderIds(java.lang.Long[] folderIds_) Deprecated. Gets the permissions which the specified user has for a list of folder IDs
int[]	getPermissionsForFolderIdsForUser(java.lang.Long[] folderIds_, java.lang.String userName_) Deprecated. Gets the permissions which the specified user has for a list of folder IDs
int[]	getPermissionsForKnowledgeCenterIds(java.lang.Long[] knowledgeCenterIds_) Deprecated. Gets the permissions which the specified user has for a list of knowledge center IDs
int[]	getPermissionsForKnowledgeCenterIdsForUser(java.lang.Long[] knowledgeCenterIds_, java.lang.String userName_) Deprecated. Gets the permissions which the specified user has for a list of knowledge center IDs

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

INVALID

static final int INVALID

Deprecated.

See Also:

Constant Field Values

CANTSEE

static final int CANTSEE

Deprecated.

See Also:

Constant Field Values

READER

static final int READER

Deprecated.

See Also:

Constant Field Values

EDITOR

static final int EDITOR

Deprecated.

See Also:

Constant Field Values

ADMIN

static final int ADMIN

Deprecated.

See Also:

Constant Field Values

generateSearchIndex$UPDATES

static final boolean generateSearchIndex$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForDocumentIds$UPDATES

static final boolean getPermissionsForDocumentIds$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForDocumentIdsForUser$UPDATES

static final boolean getPermissionsForDocumentIdsForUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForFolderIds$UPDATES

static final boolean getPermissionsForFolderIds$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForFolderIdsForUser$UPDATES

static final boolean getPermissionsForFolderIdsForUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForKnowledgeCenterIds$UPDATES

static final boolean getPermissionsForKnowledgeCenterIds$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForKnowledgeCenterIdsForUser$UPDATES

static final boolean getPermissionsForKnowledgeCenterIdsForUser$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForCommunityIds$UPDATES

static final boolean getPermissionsForCommunityIds$UPDATES

Deprecated.

See Also:

Constant Field Values

getPermissionsForCommunityIdsForUser$UPDATES

static final boolean getPermissionsForCommunityIdsForUser$UPDATES

Deprecated.

See Also:

Constant Field Values

Method Detail

generateSearchIndex

java.lang.String generateSearchIndex(java.sql.Timestamp timeStamp_)

Deprecated.

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

Throws:

ServiceException - if any system-level error occurs

getPermissionsForDocumentIds

int[] getPermissionsForDocumentIds(java.lang.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:

• INVALID - If no document with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForDocumentIdsForUser

int[] getPermissionsForDocumentIdsForUser(java.lang.Long[] documentIds_,
                                          java.lang.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:

• INVALID - If no document with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForFolderIds

int[] getPermissionsForFolderIds(java.lang.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:

• INVALID - If no folder with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForFolderIdsForUser

int[] getPermissionsForFolderIdsForUser(java.lang.Long[] folderIds_,
                                        java.lang.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:

• INVALID - If no folder with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForKnowledgeCenterIds

int[] getPermissionsForKnowledgeCenterIds(java.lang.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:

• INVALID - If no knowledge center with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForKnowledgeCenterIdsForUser

int[] getPermissionsForKnowledgeCenterIdsForUser(java.lang.Long[] knowledgeCenterIds_,
                                                 java.lang.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:

• INVALID - If no knowledge center with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForCommunityIds

int[] getPermissionsForCommunityIds(java.lang.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:

• INVALID - If no community with the given ID exists, or the ID is null
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs

getPermissionsForCommunityIdsForUser

int[] getPermissionsForCommunityIdsForUser(java.lang.Long[] communityIds_,
                                           java.lang.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:

• INVALID - If no community with the given ID exists
• CANTSEE - No Access
• READER - Reader
• EDITOR - Editor
• ADMIN - Admin

Throws:

InvalidUserException - if the user calling this method does not exist

ServiceException - if any system-level error occurs