public interface IRoomsSearchFactory
The Rooms Search API provides methods to search and find rooms matching application defined filter criteria. Note: The methods provided by this API only work correctly if useTRex is enabled in the Rooms Search Configuration and if all rooms are indexed in the configured index.
This interface is part of the Rooms API. It is public to all customers.
The whole Rooms API (including this Interface) is covered by a KM Service. You can get acess to an instance of this class by using the following code:
import com.sapportals.wcm.service.ServiceFactory; IRooms roomsAPI = (IRooms) ServiceFactory.getInstance().getService(IRooms.KM_SERVICE_ID); IRoomsSearchFactory roomsSearchFactory = roomsAPI.getRoomsSearchFactory();The Rooms API (including this Interface) is also covered by a Portal Service. To get access to an instance of this class through the Portal Service you may use the following code:
import com.sapportals.portal.prt.runtime.PortalRuntime; IRooms roomsAPI = (IRooms) PortalRuntime.getRuntimeResources().getService(IRooms.PORTAL_SERVICE_ID); IRoomsSearchFactory roomsSearchFactory = roomsAPI.getRoomsSearchFactory();
Modifier and Type | Method and Description |
---|---|
IRoomsSearchProperties |
getAdvancedSearchProperties(String name,
String description,
String ownerId,
String ownerName,
String creatorId,
String lastModifierId,
IUser roomUser,
String roomUserRoleName,
Date fromCreationDate,
Date toCreationDate,
Date fromLastModifiedDate,
Date toLastModifiedDate,
Date fromLastVisitDate,
Date toLastVisitDate,
boolean findHiddenRooms,
boolean findUnHiddenRooms,
boolean findLockedRooms,
boolean findUnLockedRooms,
boolean findAllTemplates,
boolean positiveTemplates,
String[] templates,
boolean findAllPrivacyTypes,
boolean positivePrivacyTypes,
RoomPrivacyType[] privacyTypes,
boolean findAllCategories,
boolean positiveCategories,
boolean combinePositiveCategories,
String[] categories,
boolean findAllCustomProperties,
boolean positiveCustomProperties,
boolean combinePositiveCustomProperties,
ICustomProperty[] customProperties,
String sortPropertyName,
int sortOrder)
This is a convenience method.
|
IRoomsSearchProperties |
getComboSearchProperties(String searchText,
boolean findInName,
boolean findInDescription,
boolean findInOwnerId,
boolean findInOwnerName,
boolean findInCreatorId,
boolean findInLastModifierId,
boolean findInTemplates,
boolean findInPrivacyTypes,
boolean findInCategories,
boolean findInCustomProperties,
ICustomProperty[] customProperties,
String sortPropertyName,
int sortOrder)
This is a convenience method.
|
IRoomsSearchProperties |
getGenericSearchProperties()
Creates a new instance of
IRoomsSearchProperties with generic search criteria. |
IRoomsSearch |
getSearchInstance(IRoomsSearchProperties roomsSearchProperties,
IUser contextUser,
Locale locale)
Creates a new instance of
IRoomsSearch without performing the search immediately |
IRoomsSearch |
searchRooms(IRoomsSearchProperties roomsSearchProperties,
IUser contextUser,
Locale locale)
Performs the search and returns an instance of
IRoomsSearch |
IRoomsSearch getSearchInstance(IRoomsSearchProperties roomsSearchProperties, IUser contextUser, Locale locale) throws WcmException
IRoomsSearch
without performing the search immediatelyroomsSearchProperties
- an instance of IRoomsSearchProperties
defining the search criteriacontextUser
- the context user for the result list - usually the logged in userlocale
- the locale for the result list - usually the locale of the logged in userIRoomsSearch
WcmException
- WcmExceptionIRoomsSearch searchRooms(IRoomsSearchProperties roomsSearchProperties, IUser contextUser, Locale locale) throws WcmException
IRoomsSearch
roomsSearchProperties
- an instance of IRoomsSearchProperties
defining the search criteriacontextUser
- the context user for the result list - usually the logged in userlocale
- the locale for the result list - usually the locale of the logged in userIRoomsSearch
WcmException
- WcmExceptionIRoomsSearchProperties getGenericSearchProperties()
IRoomsSearchProperties
with generic search criteria.
This means performing a search using this object without calling any
filter...() or set...() methods on it before, results in finding ALL rooms.
This is the standard method if you don't want to perform a Combo Search.
You can call several filter...() or set...() methods on the returned
instance of IRoomsSearchProperties
to define all required search criteria before searching with method searchRooms(IRoomsSearchProperties, IUser, Locale)
IRoomsSearchProperties
IRoomsSearchProperties getComboSearchProperties(String searchText, boolean findInName, boolean findInDescription, boolean findInOwnerId, boolean findInOwnerName, boolean findInCreatorId, boolean findInLastModifierId, boolean findInTemplates, boolean findInPrivacyTypes, boolean findInCategories, boolean findInCustomProperties, ICustomProperty[] customProperties, String sortPropertyName, int sortOrder)
IRoomsSearchProperties
and helps you define all appropriate search criteria for a so called Combo Search.
With a Combo Search it is possible to search in multiple room properties for one single
search term (OR-related).searchText
- searchTextfindInName
- findInNamefindInDescription
- findInDescriptionfindInOwnerId
- findInOwnerIdfindInOwnerName
- findInOwnerNamefindInCreatorId
- findInCreatorIdfindInLastModifierId
- findInLastModifierIdfindInTemplates
- findInTemplatesfindInPrivacyTypes
- findInPrivacyTypesfindInCategories
- findInCategoriesfindInCustomProperties
- findInCustomPropertiescustomProperties
- customPropertiessortPropertyName
- sortPropertyNamesortOrder
- sortOrderIRoomsSearchProperties
IRoomsSearchProperties getAdvancedSearchProperties(String name, String description, String ownerId, String ownerName, String creatorId, String lastModifierId, IUser roomUser, String roomUserRoleName, Date fromCreationDate, Date toCreationDate, Date fromLastModifiedDate, Date toLastModifiedDate, Date fromLastVisitDate, Date toLastVisitDate, boolean findHiddenRooms, boolean findUnHiddenRooms, boolean findLockedRooms, boolean findUnLockedRooms, boolean findAllTemplates, boolean positiveTemplates, String[] templates, boolean findAllPrivacyTypes, boolean positivePrivacyTypes, RoomPrivacyType[] privacyTypes, boolean findAllCategories, boolean positiveCategories, boolean combinePositiveCategories, String[] categories, boolean findAllCustomProperties, boolean positiveCustomProperties, boolean combinePositiveCustomProperties, ICustomProperty[] customProperties, String sortPropertyName, int sortOrder)
IRoomsSearchProperties
and helps you define all appropriate search criteria for a None-Combo-Search.
The result is the same as with calling first getGenericSearchProperties()
and then calling multiple set...() methods on the
returned instance of IRoomsSearchProperties
name
- namedescription
- descriptionownerId
- ownerIdownerName
- ownerNamecreatorId
- creatorIdlastModifierId
- lastModifierIdroomUser
- roomUserroomUserRoleName
- roomUserRoleNamefromCreationDate
- fromCreationDatetoCreationDate
- toCreationDatefromLastModifiedDate
- fromLastModifiedDatetoLastModifiedDate
- toLastModifiedDatefromLastVisitDate
- fromLastVisitDatetoLastVisitDate
- toLastVisitDatefindHiddenRooms
- findHiddenRoomsfindUnHiddenRooms
- findUnHiddenRoomsfindLockedRooms
- findLockedRoomsfindUnLockedRooms
- findUnLockedRoomsfindAllTemplates
- findAllTemplatespositiveTemplates
- positiveTemplatestemplates
- templatesfindAllPrivacyTypes
- findAllPrivacyTypespositivePrivacyTypes
- positivePrivacyTypesprivacyTypes
- privacyTypesfindAllCategories
- findAllCategoriespositiveCategories
- positiveCategoriescombinePositiveCategories
- combinePositiveCategoriescategories
- categoriesfindAllCustomProperties
- findAllCustomPropertiespositiveCustomProperties
- positiveCustomPropertiescombinePositiveCustomProperties
- combinePositiveCustomPropertiescustomProperties
- customPropertiessortPropertyName
- sortPropertyNamesortOrder
- sortOrderIRoomsSearchProperties
Access Rights |
---|
SC | DC | Public Part | ACH |
---|---|---|---|
[sap.com] KMC-COLL
|
[sap.com] tc/kmc/coll/room
|
api
|
EP-KM-CRS
|
Copyright 2018 SAP AG Complete Copyright Notice