com.appiancorp.suiteapi.personalization

Class GroupSummary

java.lang.Object

com.appiancorp.suiteapi.personalization.GroupSummary

All Implemented Interfaces:

LocalId, java.io.Serializable

public class GroupSummary
extends java.lang.Object
implements LocalId

Title: GroupSummary

Description: Holds a user's Group Summary data

Copyright: Copyright (c) 2002

Company: Appian Corporation

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Integer	SORT_BY_GROUP_NAME Constant indicating results should be sorted by the Group Name property.
static java.lang.Integer	SORT_BY_GROUP_SECURITY_TYPE_NAME Constant indicating results should be sorted by the Group Security Type Name property.
static java.lang.Integer	SORT_BY_ID Constant indicating results should be sorted by the ID property.
static java.lang.Integer	SORT_BY_USER_STATUS Constant indicating results should be sorted by the User Status property.
static java.lang.String	USER_STATUS_ADMIN Constant indicating that the user is an admin of this group.
static java.lang.String	USER_STATUS_MEMBER Constant indicating that the user is a member of this group.

Constructor Summary

Constructors

Constructor and Description
GroupSummary()

Method Summary

Modifier and Type	Method and Description
boolean	getFavorite()
java.lang.String	getGroupDescription() Returns the group description.
java.lang.String	getGroupName()
java.lang.String	getGroupSecurityTypeName()
java.lang.Long	getId() Returns this object's local identifier, null if the object was not identified locally using a Long Id.
java.lang.Long	getNumberOfAdministrators()
java.lang.Long	getNumberOfMembers()
java.lang.Long	getNumberOfViewers()
java.lang.String[]	getUserStatus() Gets the logged-in user's status relative to this group.
void	setFavorite(boolean favorite_)
void	setGroupDescription(java.lang.String groupDescription_) See getGroupDescription().
void	setGroupName(java.lang.String gn_)
void	setGroupSecurityTypeName(java.lang.String gstnm_)
void	setId(java.lang.Long p_) Sets this object's local identifier.
void	setNumberOfAdministrators(java.lang.Long tota_)
void	setNumberOfMembers(java.lang.Long totm_)
void	setNumberOfViewers(java.lang.Long totv_)
void	setUserStatus(java.lang.String[] status_) Sets the logged-in user's status relative to this group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SORT_BY_ID

public static final java.lang.Integer SORT_BY_ID

Constant indicating results should be sorted by the ID property.

SORT_BY_GROUP_NAME

public static final java.lang.Integer SORT_BY_GROUP_NAME

Constant indicating results should be sorted by the Group Name property.

SORT_BY_GROUP_SECURITY_TYPE_NAME

public static final java.lang.Integer SORT_BY_GROUP_SECURITY_TYPE_NAME

Constant indicating results should be sorted by the Group Security Type Name property.

SORT_BY_USER_STATUS

public static final java.lang.Integer SORT_BY_USER_STATUS

Constant indicating results should be sorted by the User Status property.

USER_STATUS_MEMBER

public static final java.lang.String USER_STATUS_MEMBER

Constant indicating that the user is a member of this group. Used with getUserStatus and setUserStatus.

See Also:

Constant Field Values

USER_STATUS_ADMIN

public static final java.lang.String USER_STATUS_ADMIN

Constant indicating that the user is an admin of this group. Used with getUserStatus and setUserStatus.

See Also:

Constant Field Values

Constructor Detail

GroupSummary

public GroupSummary()

Method Detail

getId

public java.lang.Long getId()

Description copied from interface: LocalId

Returns this object's local identifier, null if the object was not identified locally using a Long Id.

Specified by:

getId in interface LocalId

Returns:

Object's Id

See Also:

LocalId.setId(Long)

setId

public void setId(java.lang.Long p_)

Description copied from interface: LocalId

Sets this object's local identifier.

Specified by:

setId in interface LocalId

Parameters:

p_ - Id to set

See Also:

LocalId.getId()

getFavorite

public boolean getFavorite()

setFavorite

public void setFavorite(boolean favorite_)

setGroupName

public void setGroupName(java.lang.String gn_)

getGroupName

public java.lang.String getGroupName()

setGroupSecurityTypeName

public void setGroupSecurityTypeName(java.lang.String gstnm_)

getGroupSecurityTypeName

public java.lang.String getGroupSecurityTypeName()

setNumberOfMembers

public void setNumberOfMembers(java.lang.Long totm_)

getNumberOfMembers

public java.lang.Long getNumberOfMembers()

setNumberOfAdministrators

public void setNumberOfAdministrators(java.lang.Long tota_)

getNumberOfAdministrators

public java.lang.Long getNumberOfAdministrators()

setNumberOfViewers

public void setNumberOfViewers(java.lang.Long totv_)

getNumberOfViewers

public java.lang.Long getNumberOfViewers()

setUserStatus

public void setUserStatus(java.lang.String[] status_)

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

public java.lang.String[] 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

public java.lang.String getGroupDescription()

Returns the group description.

setGroupDescription

public void setGroupDescription(java.lang.String groupDescription_)

See getGroupDescription().