Difference between revisions of "GetSocialGroup"

From LongJump Support Wiki
imported>Aeric
(Created page with "{{subst: Java API}}")
 
imported>Aeric
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:__apiName__}}
{{DISPLAYTITLE:getSocialGroup}}
Description...
 
Get group details.


;Syntax:
;Syntax:
:<syntaxhighlight lang="java" enclose="div">
:<syntaxhighlight lang="java" enclose="div">
Result result = Functions.__apiName__(String objectName, String fields, String criteria);
SocialGroupBean sgb = Functions.getSocialGroup(String id);  
Result result = Functions.__apiName__(String objectName, String fields, String criteria
                            [, Parameters params] );
Result result = Functions.__apiName__(String objectName, String fields, String criteria);
Result result = Functions.__apiName__(String objectName, String fields, String criteria,
                            String sortBy, String sortOrder,
                            String sortBy2, String sortOrder2,
                            int offset, int numberOfRows);
</syntaxhighlight>
</syntaxhighlight>


;Parameters:
;Parameters:
:;objectName:The object name or identifier
:;id:The ID of the group
:;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 [{{DOCHOST}}/javadocs/com/platform/beans/SocialGroupBean.html <tt>SocialGroupBean</tt>] object containing group information.
--or--
:An integer containing ...
:A string containing ...


;Throws:
;Throws:
:Exception
:Exception
;Example:This example ....
:<syntaxhighlight lang="java" enclose="div">
...
</syntaxhighlight>
<!--ACTIVATE THE CATEGORY BELOW
<noinclude>
[[Category:Java API | __apiName__]]
</noinclude>
-->

Latest revision as of 20:50, 14 May 2012


Get group details.

Syntax
SocialGroupBean sgb = Functions.getSocialGroup(String id);
Parameters
id
The ID of the group
Returns
A SocialGroupBean object containing group information.
Throws
Exception