|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
@PublicApi public interface SharedEntitySearchParameters
Interface for the passing parameters when searching for SharedEntity instances.
Nested Class Summary | |
---|---|
static class |
SharedEntitySearchParameters.TextSearchMode
A type safe enumeration for specify text searching mode. |
Method Summary | |
---|---|
String |
getDescription()
Returns the description fragments to search for. |
SharedEntitySearchContext |
getEntitySearchContext()
Returns the SharedEntitySearchContext under which this search is to be executed. |
Boolean |
getFavourite()
Returns a tri-state Boolean indicating how favourites are to be searched. |
String |
getName()
Returns the name fragments to search for. |
ShareTypeSearchParameter |
getShareTypeParameter()
Returns the ShareTypeSearchParameter object to be used. |
SharedEntityColumn |
getSortColumn()
Returns the SharedEntityColumn to sort the results by. |
SharedEntitySearchParameters.TextSearchMode |
getTextSearchMode()
This controls how the text fragment parameters (name and description) are combined and searched. |
String |
getUserName()
Returns the user name to search for. |
boolean |
isAscendingSort()
|
Method Detail |
---|
String getName()
String getDescription()
SharedEntitySearchParameters.TextSearchMode getTextSearchMode()
String getUserName()
Boolean getFavourite()
boolean isAscendingSort()
SharedEntityColumn getSortColumn()
SharedEntityColumn.NAME
will be used by default.
The following constants MUST be used SharedEntityColumn.DESCRIPTION
SharedEntityColumn.FAVOURITE_COUNT
SharedEntityColumn.ID
SharedEntityColumn.NAME
SharedEntityColumn.OWNER
ShareTypeSearchParameter getShareTypeParameter()
SharedEntitySearchContext getEntitySearchContext()
SharedEntitySearchContext.ADMINISTER
or
SharedEntitySearchContext.USE
.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |