Interface PortalSearchService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
Method generateSearchIndex(java.sql.Timestamp)
wil generate an index file for all
pages and portlets created or updated after a particular time. This index
file can be used by the search engine to facilitate searching on pages
and portlets.
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 Integer
Deprecated.Constant for indicating that the current user has administrative access to the page or portletstatic final Integer
Deprecated.Constant for indicating that the current user cannot see the page or portletstatic final Integer
Deprecated.Constant for indicating that the current user has editor access to the page or portletstatic final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final boolean
Deprecated.static final Integer
Deprecated.Constant indicating that the page is in draft statestatic final Integer
Deprecated.Constant indicating that the page is in published statestatic final Integer
Deprecated.Constant for indicating that the current user has read-only access to the page or portletFields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptiongenerateSearchIndex
(Timestamp timeStamp_) int[]
getPermissionsForPageIds
(Long[] ids_) Deprecated.Gets the permissions for the current user for the pages with the specified idsint[]
getPermissionsForPageIdsForUser
(Long[] ids_, String userName_) Deprecated.Gets the permissions for the given user for the pages with the specified idsint[]
getPermissionsForPortletIds
(Long[] ids_) Deprecated.Gets the permissions for the current user for the portlets with the specified idsint[]
getPermissionsForPortletIdsForUser
(Long[] ids_, String userName_) Deprecated.Gets the permissions for the given user for the portlets with the specified idsMethods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
CANTSEE
Deprecated.Constant for indicating that the current user cannot see the page or portlet -
READER
Deprecated.Constant for indicating that the current user has read-only access to the page or portlet -
EDITOR
Deprecated.Constant for indicating that the current user has editor access to the page or portlet -
ADMIN
Deprecated.Constant for indicating that the current user has administrative access to the page or portlet -
PAGE_VER_DRAFT
Deprecated.Constant indicating that the page is in draft state -
PAGE_VER_PUBLISHED
Deprecated.Constant indicating that the page is in published state -
generateSearchIndex$UPDATES
static final boolean generateSearchIndex$UPDATESDeprecated.- See Also:
-
getPermissionsForPageIds$UPDATES
static final boolean getPermissionsForPageIds$UPDATESDeprecated.- See Also:
-
getPermissionsForPageIdsForUser$UPDATES
static final boolean getPermissionsForPageIdsForUser$UPDATESDeprecated.- See Also:
-
getPermissionsForPortletIds$UPDATES
static final boolean getPermissionsForPortletIds$UPDATESDeprecated.- See Also:
-
getPermissionsForPortletIdsForUser$UPDATES
static final boolean getPermissionsForPortletIdsForUser$UPDATESDeprecated.- See Also:
-
-
Method Details
-
generateSearchIndex
Deprecated.- Parameters:
timeStamp_
- only include portlets and pagess modified since this time; passnull
to do a full indexing- Returns:
- filename of search index output
- Throws:
ServiceException
- if any system-level error occurs
-
getPermissionsForPageIds
int[] getPermissionsForPageIds(Long[] ids_) throws InvalidUserException, InvalidAnonymousUserException Deprecated.Gets the permissions for the current user for the pages with the specified ids- Parameters:
ids_
- of pages for which to return the permission levels- Returns:
- array of same size as
ids_
, where each element is a constant representing access privileges for the current user to the given page. The possible return values are: - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the user calling this method is invalidInvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabled
-
getPermissionsForPageIdsForUser
int[] getPermissionsForPageIdsForUser(Long[] ids_, String userName_) throws InvalidUserException, InvalidAnonymousUserException Deprecated.Gets the permissions for the given user for the pages with the specified ids- Parameters:
ids_
- of pages for which to return the permission levelsuserName_
- the user name to find the access privileges of- Returns:
- array of same size as
ids_
, where each element is a constant representing access permissions for the user with the given user name to the page with the given id. The possible return values are: - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the user calling this method is invalidInvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabled
-
getPermissionsForPortletIds
int[] getPermissionsForPortletIds(Long[] ids_) throws InvalidUserException, InvalidAnonymousUserException Deprecated.Gets the permissions for the current user for the portlets with the specified ids- Parameters:
ids_
- of portlets for which to return the permission levels- Returns:
- array of same size as ids, where each member is a constant representing access capabilities for the current user to the given portlet. The possible return values are:
- Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the user calling this method is invalidInvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabled
-
getPermissionsForPortletIdsForUser
int[] getPermissionsForPortletIdsForUser(Long[] ids_, String userName_) throws InvalidUserException, InvalidAnonymousUserException Deprecated.Gets the permissions for the given user for the portlets with the specified ids- Parameters:
ids_
- IDs of portlets for which to return the permission levelsuserName_
- user name to find the access capabilities for- Returns:
- array of same size as
ids_
, where each element is a constant representing access permissions for the user with the given userName to the given portlet. The possible return values are: - Throws:
ServiceException
- if any system-level error occursInvalidUserException
- if the user calling this method is invalidInvalidAnonymousUserException
- if the user calling this method is anonymous, but anonymous access has not been enabled
-