Difference between revisions of "SearchSocialGroups"

From LongJump Support Wiki
imported>Aeric
imported>Aeric
 
(5 intermediate revisions by the same user not shown)
Line 4: Line 4:
;Syntax:
;Syntax:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
Result result = Functions.searchSocialGroups(SearchContext sc);  
List groups = Functions.searchSocialGroups(SearchContext sc);  
</syntaxhighlight>
</syntaxhighlight>


;Parameters:
;Parameters:
:;objectName:The object name or identifier
:;sc:A [[Java_API:Support_Classes_and_Objects#SearchContext_Class|SearchContext]] object that defines the search.
:;fields:A comma-separated list of names of the fields to retrieve
:;criteria:A [[JAVA API:Filter Expressions in JAVA APIs|filter expression]] that specifies records to select.
:;params: An optional [[Parameters Class|Parameters]] object that contains additional parameters:
:::*''' param -''' ...


;Returns:
;Returns:
:[[Result Class|<tt>Result</tt>]] object<br/>
:A list of strings containing IDs of groups.
--or--
:An integer containing ...
:A string containing ...


;Throws:
;Throws:
:Exception
:Exception


;Example:This example ....
;Example:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
SearchContext searchContext = new SearchContext();
SearchContext searchContext = new SearchContext();
searchContext.setFieldList("*");
searchContext.setFieldList("*");
searchContext.setFilter("x = y"); //criteria
searchContext.setFilter("privateGroup equals '1'"); //criteria
searchContext.setPage(0);
searchContext.setPage(0);
searchContext.setPageSize(5000);
searchContext.setPageSize(5000);
Line 34: Line 28:
searchContext.setSortOrder("DESC");
searchContext.setSortOrder("DESC");
searchContext.setSortOrder2("");
searchContext.setSortOrder2("");
List<SocialBean<SocialGroupBean>> results = searchSocialGroups(searchContext);
</syntaxhighlight>
</syntaxhighlight>
<!--ACTIVATE THE CATEGORY BELOW
<noinclude>
[[Category:Java API | __apiName__]]
</noinclude>
-->

Latest revision as of 20:50, 14 May 2012

Search groups.

Syntax
List groups = Functions.searchSocialGroups(SearchContext sc);
Parameters
sc
A SearchContext object that defines the search.
Returns
A list of strings containing IDs of groups.
Throws
Exception
Example
SearchContext searchContext = new SearchContext();

searchContext.setFieldList("*");
searchContext.setFilter("privateGroup equals '1'"); //criteria
searchContext.setPage(0);
searchContext.setPageSize(5000);
searchContext.setSortBy("date_created");
searchContext.setSortBy2("");
searchContext.setSortOrder("DESC");
searchContext.setSortOrder2("");

List<SocialBean<SocialGroupBean>> results = searchSocialGroups(searchContext);