public interface IRoomsSearchProperties
IRoomsSearchFactory
. Using this factory
applications can instantiate an instance of IRoomsSearchProperties
which is used to define all relevant search criteria.Modifier and Type | Field and Description |
---|---|
static byte |
CASE_INSENSITIVE |
static byte |
CASE_SENSITIVE
The constants CASE_SENSITIVE and CASE_INSENSITIVE can be used as
parameter in the methods setCaseSensitivity(...) and setCaseSensitivityForAll(...)
|
static byte |
CASE_SENSITIVITY_DEFAULT |
static String |
SPECIAL_ROLE_ADMIN
The constant SPECIAL_ROLE_ADMIN can be used as a parameter in the methods
filterMembers(IUser, String) and
setRoomUserRoleName(String) to
search only for rooms where the specified user is assigned to the
room role which is marked as "Admin" role in the room template. |
static String |
SPECIAL_ROLE_ANYROLE
The constant SPECIAL_ROLE_ANYROLE can be used as a parameter in the methods
filterMembers(IUser, String) and
setRoomUserRoleName(String) to
search only for rooms where the specified user is assigned to any
room role (rooms which the user is "member of"). |
static byte |
TERM_ACTION_EXACT
The TERM_ACTION_... constants can be used in all methods starting with
setTermAction...() to define a search method for each property of type String
which is used in the search filter.
|
static byte |
TERM_ACTION_FUZZY |
static byte |
TERM_ACTION_LINGUISTIC |
static byte |
TERM_ACTION_NEAR_WIDTH |
static byte |
TERM_ACTION_SOUNDEX |
Modifier and Type | Method and Description |
---|---|
void |
filterCategories(boolean findAllCategories,
boolean positiveCategories,
boolean combinePositiveCategories,
String[] categories)
Convenience method to set a filter for the room categories
|
void |
filterCustomProperties(boolean findAllCustomProperties,
boolean positiveCustomProperties,
boolean combinePositiveCustomProperties,
ICustomProperty[] customProperties)
Convenience method to set a filter for the room custom properties
|
void |
filterDates(Date fromCreationDate,
Date toCreationDate,
Date fromLastModifiedDate,
Date toLastModifiedDate,
Date fromLastVisitDate,
Date toLastVisitDate)
Convenience method to set a filter for the several room properties of type Date.
|
void |
filterHeaderData(String name,
String description,
String ownerId,
String ownerName,
String creatorId,
String lastModifierId)
Convenience method to set filters for several room properties.
|
void |
filterMembers(IUser roomUser,
String roleName)
Convenience method to set a filter for the room members.
|
void |
filterPrivacyTypes(boolean findAllPrivacyTypes,
boolean positivePrivacyTypes,
RoomPrivacyType[] privacyTypes)
Convenience method to set a filter for the room privacy types
|
void |
filterTemplates(boolean findAllTemplates,
boolean positiveTemplates,
String[] templates)
Convenience method to set a filter for the room templates
|
void |
filterVisibility(boolean findHiddenRooms,
boolean findUnhiddenRooms,
boolean findLockedRooms,
boolean findUnlockedRooms)
Convenience method to set a filter for the properties "hidden" and "locked" of rooms.
|
byte |
getCaseSensitivityCategories()
Method used internally
|
byte |
getCaseSensitivityCreatorId()
Method used internally
|
byte |
getCaseSensitivityCustomProperties()
Method used internally
|
byte |
getCaseSensitivityDescription()
Method used internally
|
byte |
getCaseSensitivityLastModifierId()
Method used internally
|
byte |
getCaseSensitivityName()
Method used internally
|
byte |
getCaseSensitivityOwnerId()
Method used internally
|
byte |
getCaseSensitivityOwnerName()
Method used internally
|
byte |
getCaseSensitivityTemplates()
Method used internally
|
String[] |
getCategories()
Method used internally
|
boolean |
getCombinePositiveCategories()
Method used internally
|
boolean |
getCombinePositiveCustomProperties()
Method used internally
|
ICustomProperty[] |
getComboCustomProperties()
Method used internally
|
boolean |
getComboFindInCategories()
Method used internally
|
boolean |
getComboFindInCreatorId()
Method used internally
|
boolean |
getComboFindInCustomProperties()
Method used internally
|
boolean |
getComboFindInDescription()
Method used internally
|
boolean |
getComboFindInLastModifierId()
Method used internally
|
boolean |
getComboFindInName()
Method used internally
|
boolean |
getComboFindInOwnerId()
Method used internally
|
boolean |
getComboFindInOwnerName()
Method used internally
|
boolean |
getComboFindInPrivacyTypes()
Method used internally
|
boolean |
getComboFindInTemplates()
Method used internally
|
String |
getComboSearchText()
Method used internally
|
String |
getCreatorId()
Method used internally
|
ICustomProperty[] |
getCustomProperties()
Method used internally
|
String |
getDescription()
Method used internally
|
boolean |
getFindAllCategories()
Method used internally
|
boolean |
getFindAllCustomProperties()
Method used internally
|
boolean |
getFindAllPrivacyTypes()
Method used internally
|
boolean |
getFindAllTemplates()
Method used internally
|
boolean |
getFindHiddenRooms()
Method used internally
|
boolean |
getFindLockedRooms()
Method used internally
|
boolean |
getFindUnHiddenRooms()
Method used internally
|
boolean |
getFindUnLockedRooms()
Method used internally
|
Date |
getFromCreationDate()
Method used internally
|
Date |
getFromLastModifiedDate()
Method used internally
|
Date |
getFromLastVisitDate()
Method used internally
|
String |
getLastModifierId()
Method used internally
|
String |
getName()
Method used internally
|
boolean |
getOverrideCacheConfig()
Method used internally
|
String |
getOwnerId()
Method used internally
|
String |
getOwnerName()
Method used internally
|
boolean |
getPositiveCategories()
Method used internally
|
boolean |
getPositiveCustomProperties()
Method used internally
|
boolean |
getPositivePrivacyTypes()
Method used internally
|
boolean |
getPositiveTemplates()
Method used internally
|
RoomPrivacyType[] |
getPrivacyTypes()
Method used internally
|
String[] |
getRoomIDs()
Method used internally
|
IUser |
getRoomUser()
Method used internally
|
String |
getRoomUserRoleName()
Method used internally
|
int |
getSortOrder()
Method used internally
|
String |
getSortPropertyName()
Method used internally
|
String[] |
getTemplates()
Method used internally
|
byte |
getTermActionCategories()
Method used internally
|
byte |
getTermActionCreatorId()
Method used internally
|
byte |
getTermActionCustomProperties()
Method used internally
|
byte |
getTermActionDescription()
Method used internally
|
byte |
getTermActionLastModifierId()
Method used internally
|
byte |
getTermActionName()
Method used internally
|
byte |
getTermActionOwnerId()
Method used internally
|
byte |
getTermActionOwnerName()
Method used internally
|
byte |
getTermActionTemplates()
Method used internally
|
Date |
getToCreationDate()
Method used internally
|
Date |
getToLastModifiedDate()
Method used internally
|
Date |
getToLastVisitDate()
Method used internally
|
boolean |
getUseCache()
Method used internally
|
void |
setCaseSensitivity(byte caseSensitivityName,
byte caseSensitivityDescription,
byte caseSensitivityOwnerId,
byte caseSensitivityOwnerName,
byte caseSensitivityCreatorId,
byte caseSensitivityLastModifierId,
byte caseSensitivityTemplates,
byte caseSensitivityCategories,
byte caseSensitivityCustomProperties)
Set the case sensitivity mode for each searchable properties of type String individually.
|
void |
setCaseSensitivityForAll(byte caseSensitivity)
Set the case sensitivity mode for all searchable properties of type String
|
void |
setCategories(String[] categories)
Set the room categories to be included or excluded in a rooms search.
|
void |
setCombinePositiveCategories(boolean combinePositiveCategories)
Enables or disables finding a combination of categories in a rooms search.
|
void |
setCombinePositiveCustomProperties(boolean combinePositiveCustomProperties)
Enables or disables finding a combination of custom properties in a rooms search.
|
void |
setComboCustomProperties(ICustomProperty[] comboCustomProperties)
Defines the room custom properties to be searched in a combo search
|
void |
setComboFindInCategories(boolean comboFindInCategories)
Defines whether the room categories property should be searched in a combo search
|
void |
setComboFindInCreatorId(boolean comboFindInCreatorId)
Defines whether the room creator uniqueId property should be searched in a combo search
|
void |
setComboFindInCustomProperties(boolean comboFindInCustomProperties)
Defines whether the room custom properties should be searched in a combo search
|
void |
setComboFindInDescription(boolean comboFindInDescription)
Defines whether the room description property should be searched in a combo search
|
void |
setComboFindInLastModifierId(boolean comboFindInLastModifierId)
Defines whether the room last modifier uniqueId property should be searched in a combo search
|
void |
setComboFindInName(boolean comboFindInName)
Defines whether the room name property should be searched in a combo search
|
void |
setComboFindInOwnerId(boolean comboFindInOwnerId)
Defines whether the room owner uniqueId property should be searched in a combo search
|
void |
setComboFindInOwnerName(boolean comboFindInOwnerName)
Defines whether the room owner name property should be searched in a combo search
|
void |
setComboFindInPrivacyTypes(boolean comboFindInPrivacyTypes)
Defines whether the room privacy type property should be searched in a combo search
|
void |
setComboFindInTemplates(boolean comboFindInTemplates)
Defines whether the room template property should be searched in a combo search
|
void |
setComboSearchText(String comboSearchText)
Set the search term for a combo search.
|
void |
setCreatorId(String creatorId)
Set the search term for the room creator uniqueId property in a rooms search.
|
void |
setCustomProperties(ICustomProperty[] customProperties)
Set the room custom properties to be included or excluded in a rooms search.
|
void |
setDescription(String description)
Set the search term for the room description property in a rooms search.
|
void |
setFindAllCategories(boolean findAllCategories)
Switch on and off the filtering of categories in a rooms search.
|
void |
setFindAllCustomProperties(boolean findAllCustomProperties)
Switch on and off the filtering of custom properties in a rooms search.
|
void |
setFindAllPrivacyTypes(boolean findAllPrivacyTypes)
Switch on and off the filtering of privacy types in a rooms search.
|
void |
setFindAllTemplates(boolean findAllTemplates)
Switch on and off the filtering of templates in a rooms search.
|
void |
setFindHiddenRooms(boolean findHiddenRooms)
Defines whether hidden rooms should be found in a rooms search or not.
|
void |
setFindLockedRooms(boolean findLockedRooms)
Defines whether locked rooms should be found in a rooms search or not.
|
void |
setFindUnHiddenRooms(boolean findUnHiddenRooms)
Defines whether unhidden rooms should be found in a rooms search or not.
|
void |
setFindUnLockedRooms(boolean findUnLockedRooms)
Defines whether unlocked rooms should be found in a rooms search or not.
|
void |
setFromCreationDate(Date fromCreationDate)
Set the starting date for the creation date of rooms to be found in a rooms search.
|
void |
setFromLastModifiedDate(Date fromLastModifiedDate)
Set the starting date for the last modification date of rooms to be found in a rooms search.
|
void |
setFromLastVisitDate(Date fromLastVisitDate)
Set the starting date for the last visit date of rooms to be found in a rooms search.
|
void |
setLastModifierId(String lastModifierId)
Set the search term for the room last modifier uniqueId property in a rooms search.
|
void |
setName(String name)
Set the search term for the room name property in a rooms search.
|
void |
setOverrideCacheConfig(boolean overrideCacheConfig)
Method used internally
|
void |
setOwnerId(String ownerId)
Set the search term for the room owner uniqueId property in a rooms search.
|
void |
setOwnerName(String ownerName)
Set the search term for the room owner name property in a rooms search.
|
void |
setPositiveCategories(boolean positiveCategories)
Switch between positive and negative list of categories for the rooms search.
|
void |
setPositiveCustomProperties(boolean positiveCustomProperties)
Switch between positive and negative list of custom properties for the rooms search.
|
void |
setPositivePrivacyTypes(boolean positivePrivacyTypes)
Switch between positive and negative list of privacy types for the rooms search.
|
void |
setPositiveTemplates(boolean positiveTemplates)
Switch between positive and negative list of templates for the rooms search.
|
void |
setPrivacyTypes(RoomPrivacyType[] privacyTypes)
Set the room privacy types to be included or excluded in a rooms search.
|
void |
setRoomIDs(String[] roomIDs)
Set a list of roomIDs of rooms to be searched.
|
void |
setRoomUser(IUser roomUser)
Set the user who's membership should be required in a rooms search.
|
void |
setRoomUserRoleName(String roomUserRoleName)
Set the name of the room role the user should be member of in a rooms search.
|
void |
setSortOrder(int sortOrder)
By calling this method before searching the application can define
the sort order for the search results.
|
void |
setSortPropertyName(String sortPropertyName)
By calling this method before searching the application can define
the sort property name for the search results.
|
void |
setTemplates(String[] templates)
Set the room templates to be included or excluded in a rooms search.
|
void |
setTermActionCategories(byte termActionCategories)
Set the TERM_ACTION for the search in the room categories property.
|
void |
setTermActionCreatorId(byte termActionCreatorId)
Set the TERM_ACTION for the search in the room creator uniqueId property.
|
void |
setTermActionCustomProperties(byte termActionCustomProperties)
Set the TERM_ACTION for the search in the room custom properties.
|
void |
setTermActionDescription(byte termActionDescription)
Set the TERM_ACTION for the search in the room description property.
|
void |
setTermActionLastModifierId(byte termActionLastModifierId)
Set the TERM_ACTION for the search in the room last modifier uniqueId property.
|
void |
setTermActionName(byte termActionName)
Set the TERM_ACTION for the search in the room name property.
|
void |
setTermActionOwnerId(byte termActionOwnerId)
Set the TERM_ACTION for the search in the room owner uniqueId property.
|
void |
setTermActionOwnerName(byte termActionOwnerName)
Set the TERM_ACTION for the search in the room owner name property.
|
void |
setTermActions(byte termActionName,
byte termActionDescription,
byte termActionOwnerId,
byte termActionOwnerName,
byte termActionCreatorId,
byte termActionLastModifierId,
byte termActionTemplates,
byte termActionCategories,
byte termActionCustomProperties)
TERM_ACTIONS are different search methods.
|
void |
setTermActionTemplates(byte termActionTemplates)
Set the TERM_ACTION for the search in the room template property.
|
void |
setToCreationDate(Date toCreationDate)
Set the end date for the creation date of rooms to be found in a rooms search.
|
void |
setToLastModifiedDate(Date toLastModifiedDate)
Set the end date for the last modification date of rooms to be found in a rooms search.
|
void |
setToLastVisitDate(Date toLastVisitDate)
Set the end date for the last visit date of rooms to be found in a rooms search.
|
void |
setUseCache(boolean useCache)
By calling this method before searching the application can
enable or disable the usage of the TRex cache for the rooms search
Searching with enabled caching is faster but in the default
configuration it takes up to 5 minutes, until the latest changes
in rooms can be found.
|
static final String SPECIAL_ROLE_ADMIN
filterMembers(IUser, String)
and
setRoomUserRoleName(String)
to
search only for rooms where the specified user is assigned to the
room role which is marked as "Admin" role in the room template.static final String SPECIAL_ROLE_ANYROLE
filterMembers(IUser, String)
and
setRoomUserRoleName(String)
to
search only for rooms where the specified user is assigned to any
room role (rooms which the user is "member of").static final byte TERM_ACTION_EXACT
static final byte TERM_ACTION_FUZZY
static final byte TERM_ACTION_LINGUISTIC
static final byte TERM_ACTION_NEAR_WIDTH
static final byte TERM_ACTION_SOUNDEX
static final byte CASE_SENSITIVE
static final byte CASE_INSENSITIVE
static final byte CASE_SENSITIVITY_DEFAULT
void filterHeaderData(String name, String description, String ownerId, String ownerName, String creatorId, String lastModifierId)
null
as the corresponding search string.
Note: The property LastModifierId can be searched using this API but it is
not updated properly in the actual versions when a room is modified. So the search
support for this property is for future use only.name
- - a search string for the room namedescription
- - a search string for the room descriptionownerId
- - a search string for the uniqueId of the room ownerownerName
- - a search string for the display name of the room ownercreatorId
- - a search string for the uniqueId of the room creatorlastModifierId
- - a search string for the uniqueId of the last modifier of the roomvoid filterMembers(IUser roomUser, String roleName)
roomUser
- - the user who's membership is requiredroleName
- - the name of a room role to be required for the roomUser
or one of the constants SPECIAL_ROLE_ADMIN
or SPECIAL_ROLE_ANYROLE
void filterDates(Date fromCreationDate, Date toCreationDate, Date fromLastModifiedDate, Date toLastModifiedDate, Date fromLastVisitDate, Date toLastVisitDate)
fromCreationDate
- - the starting date for the creation date of rooms to be foundtoCreationDate
- - the end date for the creation date of rooms to be foundfromLastModifiedDate
- - the starting date for the last modification date of rooms to be foundtoLastModifiedDate
- - the end date for the last modification date of rooms to be foundfromLastVisitDate
- - the starting date for the last visit date of rooms to be foundtoLastVisitDate
- - the end date for the last visit date of rooms to be foundvoid filterVisibility(boolean findHiddenRooms, boolean findUnhiddenRooms, boolean findLockedRooms, boolean findUnlockedRooms)
findHiddenRooms
- - should hidden rooms be found?findUnhiddenRooms
- - should unhidden rooms be found?findLockedRooms
- - should locked rooms be found?findUnlockedRooms
- - should unlocked rooms be found?void filterTemplates(boolean findAllTemplates, boolean positiveTemplates, String[] templates)
findAllTemplates
- - if true, the other two parameters are ignored (can be null)positiveTemplates
- - true if templates contains a list of templates to be found,
false if templates contains a list of templates to be not foundtemplates
- - a list of templates to be included or excluded in the search resultvoid filterPrivacyTypes(boolean findAllPrivacyTypes, boolean positivePrivacyTypes, RoomPrivacyType[] privacyTypes)
findAllPrivacyTypes
- - if true, the other two parameters are ignored (can be null)positivePrivacyTypes
- - true if privacyTypes contains a list of privacy types to be found,
false if privacyTypes contains a list of privacy types to be not foundprivacyTypes
- - a list of privacy types to be included or excluded in the search resultvoid filterCategories(boolean findAllCategories, boolean positiveCategories, boolean combinePositiveCategories, String[] categories)
findAllCategories
- - if true, the other three parameters are ignored (can be null)positiveCategories
- - true if categories contains a list of categories to be found,
false if categories contains a list of categories to be not foundcombinePositiveCategories
- - if positiveCategories is true, this parameter controls whether
a room must be assigned to all specified categories
or only one of them to match the search criteria.categories
- - a list of categories to be included or excluded in the search resultvoid filterCustomProperties(boolean findAllCustomProperties, boolean positiveCustomProperties, boolean combinePositiveCustomProperties, ICustomProperty[] customProperties)
findAllCustomProperties
- - if true, the other three parameters are ignored (can be null)positiveCustomProperties
- - true if customProperties contains a list of custom properties to be found,
false if customProperties contains a list of custom properties to be not foundcombinePositiveCustomProperties
- - if positiveCustomProperties is true, this parameter controls whether
a room must have assigned all specified customProperties
or only one of them to match the search criteria.customProperties
- customPropertiesboolean getOverrideCacheConfig()
setUseCache(boolean)
has been called,
false otherwisevoid setOverrideCacheConfig(boolean overrideCacheConfig)
overrideCacheConfig
- overrideCacheConfigboolean getUseCache()
setUseCache(boolean)
void setUseCache(boolean useCache)
useCache
- - true if the cache should be used, false otherwiseString getSortPropertyName()
void setSortPropertyName(String sortPropertyName)
sortPropertyName
- sortPropertyNameint getSortOrder()
void setSortOrder(int sortOrder)
sortOrder
- - 0 (ascending) or 1 (descending)void setTermActions(byte termActionName, byte termActionDescription, byte termActionOwnerId, byte termActionOwnerName, byte termActionCreatorId, byte termActionLastModifierId, byte termActionTemplates, byte termActionCategories, byte termActionCustomProperties)
termActionName
- - the term action for searching the room name propertytermActionDescription
- - the term action for searching the room description propertytermActionOwnerId
- - the term action for searching the room owner uniqueId propertytermActionOwnerName
- - the term action for searching the room owner name propertytermActionCreatorId
- - the term action for searching the room creator uniqueId propertytermActionLastModifierId
- - the term action for searching the room last modifier uniqueId propertytermActionTemplates
- - the term action for searching the room template propertytermActionCategories
- - the term action for searching the room categories propertytermActionCustomProperties
- - the term action for searching the room custom propertiesbyte getTermActionName()
void setTermActionName(byte termActionName)
termActionName
- termActionNamesetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionDescription()
void setTermActionDescription(byte termActionDescription)
termActionDescription
- termActionDescriptionsetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionOwnerId()
void setTermActionOwnerId(byte termActionOwnerId)
termActionOwnerId
- termActionOwnerIdsetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionOwnerName()
void setTermActionOwnerName(byte termActionOwnerName)
termActionOwnerName
- termActionOwnerNamesetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionCreatorId()
void setTermActionCreatorId(byte termActionCreatorId)
termActionCreatorId
- termActionCreatorIdsetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionLastModifierId()
void setTermActionLastModifierId(byte termActionLastModifierId)
termActionLastModifierId
- termActionLastModifierIdsetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionTemplates()
void setTermActionTemplates(byte termActionTemplates)
termActionTemplates
- termActionTemplatessetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionCategories()
void setTermActionCategories(byte termActionCategories)
termActionCategories
- termActionCategoriessetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
byte getTermActionCustomProperties()
void setTermActionCustomProperties(byte termActionCustomProperties)
termActionCustomProperties
- termActionCustomPropertiessetTermActions(byte, byte, byte, byte, byte, byte, byte, byte, byte)
void setCaseSensitivityForAll(byte caseSensitivity)
caseSensitivity
- - true means case sensitive search, false means case insensitive searchvoid setCaseSensitivity(byte caseSensitivityName, byte caseSensitivityDescription, byte caseSensitivityOwnerId, byte caseSensitivityOwnerName, byte caseSensitivityCreatorId, byte caseSensitivityLastModifierId, byte caseSensitivityTemplates, byte caseSensitivityCategories, byte caseSensitivityCustomProperties)
caseSensitivityName
- caseSensitivityNamecaseSensitivityDescription
- caseSensitivityDescriptioncaseSensitivityOwnerId
- caseSensitivityOwnerIdcaseSensitivityOwnerName
- caseSensitivityOwnerNamecaseSensitivityCreatorId
- caseSensitivityCreatorIdcaseSensitivityLastModifierId
- caseSensitivityLastModifierIdcaseSensitivityTemplates
- caseSensitivityTemplatescaseSensitivityCategories
- caseSensitivityCategoriescaseSensitivityCustomProperties
- caseSensitivityCustomPropertiesbyte getCaseSensitivityName()
byte getCaseSensitivityDescription()
byte getCaseSensitivityOwnerId()
byte getCaseSensitivityOwnerName()
byte getCaseSensitivityCreatorId()
byte getCaseSensitivityLastModifierId()
byte getCaseSensitivityTemplates()
byte getCaseSensitivityCategories()
byte getCaseSensitivityCustomProperties()
String getComboSearchText()
void setComboSearchText(String comboSearchText)
IRoomsSearchFactory.getComboSearchProperties(...)
.
Note: A combo search is triggered by setting a comboSearchText != null
.
If the comboSearchText is null
then a standard search is triggered.
Note2: The TERM_ACTIONS set with the setTermAction...() methods also apply
for a combo search.comboSearchText
- - the search term (may include '*' and '?')boolean getComboFindInName()
void setComboFindInName(boolean comboFindInName)
comboFindInName
- comboFindInNameboolean getComboFindInDescription()
void setComboFindInDescription(boolean comboFindInDescription)
comboFindInDescription
- comboFindInDescriptionboolean getComboFindInOwnerId()
void setComboFindInOwnerId(boolean comboFindInOwnerId)
comboFindInOwnerId
- comboFindInOwnerIdboolean getComboFindInOwnerName()
void setComboFindInOwnerName(boolean comboFindInOwnerName)
comboFindInOwnerName
- comboFindInOwnerNameboolean getComboFindInCreatorId()
void setComboFindInCreatorId(boolean comboFindInCreatorId)
comboFindInCreatorId
- comboFindInCreatorIdboolean getComboFindInLastModifierId()
void setComboFindInLastModifierId(boolean comboFindInLastModifierId)
comboFindInLastModifierId
- comboFindInLastModifierIdboolean getComboFindInTemplates()
void setComboFindInTemplates(boolean comboFindInTemplates)
comboFindInTemplates
- comboFindInTemplatesboolean getComboFindInPrivacyTypes()
void setComboFindInPrivacyTypes(boolean comboFindInPrivacyTypes)
comboFindInPrivacyTypes
- comboFindInPrivacyTypesboolean getComboFindInCategories()
void setComboFindInCategories(boolean comboFindInCategories)
comboFindInCategories
- comboFindInCategoriesboolean getComboFindInCustomProperties()
void setComboFindInCustomProperties(boolean comboFindInCustomProperties)
comboFindInCustomProperties
- comboFindInCustomPropertiesICustomProperty[] getComboCustomProperties()
void setComboCustomProperties(ICustomProperty[] comboCustomProperties)
comboCustomProperties
- comboCustomPropertiesString getName()
void setName(String name)
IRoomsSearchFactory.getAdvancedSearchProperties(...)
.
Note2: The TERM_ACTIONS set with the setTermAction...() methods also apply
for a standard rooms search.name
- - the search term (may include '*' and '?')String getDescription()
void setDescription(String description)
description
- - the search term (may include '*' and '?')String getOwnerId()
void setOwnerId(String ownerId)
ownerId
- - the search term (may include '*' and '?')String getOwnerName()
void setOwnerName(String ownerName)
ownerName
- - the search term (may include '*' and '?')String getCreatorId()
void setCreatorId(String creatorId)
creatorId
- - the search term (may include '*' and '?')String getLastModifierId()
void setLastModifierId(String lastModifierId)
lastModifierId
- - the search term (may include '*' and '?')IUser getRoomUser()
void setRoomUser(IUser roomUser)
roomUser
- - the user who should be room memberString getRoomUserRoleName()
void setRoomUserRoleName(String roomUserRoleName)
roomUserRoleName
- - the name of the room roleDate getFromCreationDate()
void setFromCreationDate(Date fromCreationDate)
fromCreationDate
- - the starting date for the creation date of rooms to be foundDate getToCreationDate()
void setToCreationDate(Date toCreationDate)
toCreationDate
- - the end date for the creation date of rooms to be foundDate getFromLastModifiedDate()
void setFromLastModifiedDate(Date fromLastModifiedDate)
fromLastModifiedDate
- - the starting date for the last modification date of rooms to be foundDate getToLastModifiedDate()
void setToLastModifiedDate(Date toLastModifiedDate)
toLastModifiedDate
- - the end date for the last modification date of rooms to be foundDate getFromLastVisitDate()
void setFromLastVisitDate(Date fromLastVisitDate)
fromLastVisitDate
- - the starting date for the last visit date of rooms to be foundDate getToLastVisitDate()
void setToLastVisitDate(Date toLastVisitDate)
toLastVisitDate
- - the end date for the last visit date of rooms to be foundboolean getFindHiddenRooms()
void setFindHiddenRooms(boolean findHiddenRooms)
findHiddenRooms
- - true to include hidden rooms, false to exclude themboolean getFindUnHiddenRooms()
void setFindUnHiddenRooms(boolean findUnHiddenRooms)
findUnHiddenRooms
- - true to include unhidden rooms, false to exclude themboolean getFindLockedRooms()
void setFindLockedRooms(boolean findLockedRooms)
findLockedRooms
- - true to include locked rooms, false to exclude themboolean getFindUnLockedRooms()
void setFindUnLockedRooms(boolean findUnLockedRooms)
findUnLockedRooms
- - true to include unlocked rooms, false to exclude themboolean getFindAllTemplates()
void setFindAllTemplates(boolean findAllTemplates)
findAllTemplates
- - if true, filtering of templates is disabled,
if false, the filtering of templates is enabled and can be
controlled by calling two more methods.boolean getPositiveTemplates()
void setPositiveTemplates(boolean positiveTemplates)
positiveTemplates
- - flag whether the templates specified
with the method call setTemplates(String[]) are to be
included or excluded in the search resultsString[] getTemplates()
void setTemplates(String[] templates)
templates
- - the templates to be searchedboolean getFindAllPrivacyTypes()
void setFindAllPrivacyTypes(boolean findAllPrivacyTypes)
findAllPrivacyTypes
- - if true, filtering of privacy types is disabled,
if false, the filtering of privacy types is enabled and can be
controlled by calling two more methods.boolean getPositivePrivacyTypes()
void setPositivePrivacyTypes(boolean positivePrivacyTypes)
positivePrivacyTypes
- - flag whether the privacy types specified
with the method call setPrivacyTypes(RoomPrivacyType[]) are to be
included or excluded in the search resultsRoomPrivacyType[] getPrivacyTypes()
void setPrivacyTypes(RoomPrivacyType[] privacyTypes)
privacyTypes
- - the privacy types to be searchedboolean getFindAllCategories()
void setFindAllCategories(boolean findAllCategories)
findAllCategories
- - if true, filtering of categories is disabled,
if false, the filtering of categories is enabled and can be
controlled by calling three more methods.boolean getPositiveCategories()
void setPositiveCategories(boolean positiveCategories)
positiveCategories
- - flag whether the categories specified
with the method call setCategories(String[]) are to be
included or excluded in the search resultsboolean getCombinePositiveCategories()
void setCombinePositiveCategories(boolean combinePositiveCategories)
combinePositiveCategories
- - true if the combination of categories should be found, false otherwiseString[] getCategories()
void setCategories(String[] categories)
categories
- - the categories to be searchedboolean getFindAllCustomProperties()
void setFindAllCustomProperties(boolean findAllCustomProperties)
findAllCustomProperties
- - if true, filtering of custom properties is disabled,
if false, the filtering of custom properties is enabled and can be
controlled by calling three more methods.boolean getPositiveCustomProperties()
void setPositiveCustomProperties(boolean positiveCustomProperties)
positiveCustomProperties
- - flag whether the custom properties specified
with the method call setCustomProperties(ICustomProperty[]) are to be
included or excluded in the search resultsboolean getCombinePositiveCustomProperties()
void setCombinePositiveCustomProperties(boolean combinePositiveCustomProperties)
combinePositiveCustomProperties
- - true if the combination of custom properties should be found, false otherwiseICustomProperty[] getCustomProperties()
void setCustomProperties(ICustomProperty[] customProperties)
customProperties
- - the custom properties to be searchedvoid setRoomIDs(String[] roomIDs)
roomIDs
- an array containing the roomIDs of all rooms to be searched.String[] getRoomIDs()
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