Interface CollaborationSearchService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final int
Deprecated.static final int
Deprecated.static final int
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final int
Deprecated.static final int
Deprecated.Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptiongenerateSearchIndex
(Timestamp timeStamp_) Deprecated.int[]
getPermissionsForCommunityIds
(Long[] communityIds_) Deprecated.Gets the permissions which the specified user has for a list of community IDsint[]
getPermissionsForCommunityIdsForUser
(Long[] communityIds_, String userName_) Deprecated.Gets the permissions which the specified user has for a list of community IDsint[]
getPermissionsForDocumentIds
(Long[] documentIds_) Deprecated.Gets the permissions which the current user has for a list of document IDsint[]
getPermissionsForDocumentIdsForUser
(Long[] documentIds_, String userName_) Deprecated.Gets the permissions which the specified user has for a list of document IDsint[]
getPermissionsForFolderIds
(Long[] folderIds_) Deprecated.Gets the permissions which the specified user has for a list of folder IDsint[]
getPermissionsForFolderIdsForUser
(Long[] folderIds_, String userName_) Deprecated.Gets the permissions which the specified user has for a list of folder IDsint[]
getPermissionsForKnowledgeCenterIds
(Long[] knowledgeCenterIds_) Deprecated.Gets the permissions which the specified user has for a list of knowledge center IDsint[]
getPermissionsForKnowledgeCenterIdsForUser
(Long[] knowledgeCenterIds_, String userName_) Deprecated.Gets the permissions which the specified user has for a list of knowledge center IDsMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
INVALID
static final int INVALIDDeprecated.- See Also:
-
CANTSEE
static final int CANTSEEDeprecated.- See Also:
-
READER
static final int READERDeprecated.- See Also:
-
EDITOR
static final int EDITORDeprecated.- See Also:
-
ADMIN
static final int ADMINDeprecated.- See Also:
-
generateSearchIndex$UPDATES
static final boolean generateSearchIndex$UPDATESDeprecated.- See Also:
-
getPermissionsForDocumentIds$UPDATES
static final boolean getPermissionsForDocumentIds$UPDATESDeprecated.- See Also:
-
getPermissionsForDocumentIdsForUser$UPDATES
static final boolean getPermissionsForDocumentIdsForUser$UPDATESDeprecated.- See Also:
-
getPermissionsForFolderIds$UPDATES
static final boolean getPermissionsForFolderIds$UPDATESDeprecated.- See Also:
-
getPermissionsForFolderIdsForUser$UPDATES
static final boolean getPermissionsForFolderIdsForUser$UPDATESDeprecated.- See Also:
-
getPermissionsForKnowledgeCenterIds$UPDATES
static final boolean getPermissionsForKnowledgeCenterIds$UPDATESDeprecated.- See Also:
-
getPermissionsForKnowledgeCenterIdsForUser$UPDATES
static final boolean getPermissionsForKnowledgeCenterIdsForUser$UPDATESDeprecated.- See Also:
-
getPermissionsForCommunityIds$UPDATES
static final boolean getPermissionsForCommunityIds$UPDATESDeprecated.- See Also:
-
getPermissionsForCommunityIdsForUser$UPDATES
static final boolean getPermissionsForCommunityIdsForUser$UPDATESDeprecated.- See Also:
-
-
Method Details
-
generateSearchIndex
Deprecated.- Parameters:
timeStamp_
- only include entities modified since this time. Passnull
to perform a full index generation- Returns:
- filename of search index output
- Throws:
ServiceException
- if any system-level error occurs
-
getPermissionsForDocumentIds
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 existServiceException
- if any system-level error occurs
-
getPermissionsForDocumentIdsForUser
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 levelsuserName_
- 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 existServiceException
- if any system-level error occurs
-
getPermissionsForFolderIds
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 existServiceException
- if any system-level error occurs
-
getPermissionsForFolderIdsForUser
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 levelsuserName_
- 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 existServiceException
- if any system-level error occurs
-
getPermissionsForKnowledgeCenterIds
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 existServiceException
- if any system-level error occurs
-
getPermissionsForKnowledgeCenterIdsForUser
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 levelsuserName_
- 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 existServiceException
- if any system-level error occurs
-
getPermissionsForCommunityIds
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 existServiceException
- if any system-level error occurs
-
getPermissionsForCommunityIdsForUser
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 levelsuserName_
- 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 existServiceException
- if any system-level error occurs
-
ContentService
instead.