Class GroupSummary
java.lang.Object
com.appiancorp.suiteapi.personalization.GroupSummary
- All Implemented Interfaces:
LocalId
,Serializable
Title: GroupSummary
Description: Holds a user's Group Summary data
Copyright: Copyright (c) 2002
Company: Appian Corporation
- See Also:
-
Field Summary
Modifier and TypeFieldDescriptionstatic final Integer
Constant indicating results should be sorted by the Group Name property.static final Integer
Constant indicating results should be sorted by the Group Security Type Name property.static final Integer
Constant indicating results should be sorted by the ID property.static final Integer
Constant indicating results should be sorted by the User Status property.static final String
Constant indicating that the user is an admin of this group.static final String
Constant indicating that the user is a member of this group. -
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionboolean
Returns the group description.getId()
Returns this object's local identifier,null
if the object was not identified locally using aLong
Id.String[]
Gets the logged-in user's status relative to this group.void
setFavorite
(boolean favorite_) void
setGroupDescription
(String groupDescription_) void
setGroupName
(String gn_) void
setGroupSecurityTypeName
(String gstnm_) void
Sets this object's local identifier.void
setNumberOfAdministrators
(Long tota_) void
setNumberOfMembers
(Long totm_) void
setNumberOfViewers
(Long totv_) void
setUserStatus
(String[] status_) Sets the logged-in user's status relative to this group.
-
Field Details
-
SORT_BY_ID
Constant indicating results should be sorted by the ID property. -
SORT_BY_GROUP_NAME
Constant indicating results should be sorted by the Group Name property. -
SORT_BY_GROUP_SECURITY_TYPE_NAME
Constant indicating results should be sorted by the Group Security Type Name property. -
SORT_BY_USER_STATUS
Constant indicating results should be sorted by the User Status property. -
USER_STATUS_MEMBER
Constant indicating that the user is a member of this group. Used with getUserStatus and setUserStatus.- See Also:
-
USER_STATUS_ADMIN
Constant indicating that the user is an admin of this group. Used with getUserStatus and setUserStatus.- See Also:
-
-
Constructor Details
-
GroupSummary
public GroupSummary()
-
-
Method Details
-
getId
Description copied from interface:LocalId
Returns this object's local identifier,null
if the object was not identified locally using aLong
Id. -
setId
Description copied from interface:LocalId
Sets this object's local identifier. -
getFavorite
public boolean getFavorite() -
setFavorite
public void setFavorite(boolean favorite_) -
setGroupName
-
getGroupName
-
setGroupSecurityTypeName
-
getGroupSecurityTypeName
-
setNumberOfMembers
-
getNumberOfMembers
-
setNumberOfAdministrators
-
getNumberOfAdministrators
-
setNumberOfViewers
-
getNumberOfViewers
-
setUserStatus
Sets the logged-in user's status relative to this group.- Parameters:
status_
- an array of the USER_STATUS_XXX constants, indicating whether the user is a member or admin of this group (or both).
-
getUserStatus
Gets the logged-in user's status relative to this group.- Returns:
- an array of the USER_STATUS_XXX constants, indicating whether the user is a member or admin of this group (or both).
-
getGroupDescription
Returns the group description. -
setGroupDescription
-