com.jivesoftware.community.webservices
Class Group

java.lang.Object
  com.jivesoftware.community.webservices.JiveObject
      com.jivesoftware.community.webservices.Group

public class Group
extends JiveObject

Organizes users into a group for easier permissions management. In this way, groups essentially serve the same purpose that they do in Unix or Windows.

Field Summary

Fields inherited from class com.jivesoftware.community.webservices.JiveObject

id, objectType

Constructor Summary

Group()

Method Summary

boolean	equals(java.lang.Object o)
java.util.Date	getCreationDate() Returns the date that the group was created.
java.lang.String	getDescription() Returns the description of the group.
int	getMemberCount() Returns the number of users that belon gto this group.
java.util.Date	getModificationDate() Returns the date that the group was last modified.
java.lang.String	getName() Returns the name of the group.
int	hashCode()
void	setCreationDate(java.util.Date creationDate) Sets the creation date of the group.
void	setDescription(java.lang.String description) Sets the description of the group.
void	setMemberCount(int memberCount) Sets the number of users that belon gto this group.
void	setModificationDate(java.util.Date modificationDate) Sets the date the group was last modified.
void	setName(java.lang.String name) Sets the name of the group.
java.lang.String	toString()

Methods inherited from class com.jivesoftware.community.webservices.JiveObject

getID, getObjectType, setID, setObjectType

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Group

public Group()

Method Detail

getName

public java.lang.String getName()

Returns the name of the group. For example, 'XYZ Admins'.

Returns:

the name of the group.

setName

public void setName(java.lang.String name)

Sets the name of the group. For example, 'XYZ Admins'. This method is restricted to those with group administration permission.

Parameters:

name - the name for the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

getDescription

public java.lang.String getDescription()

Returns the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ community'.

Returns:

the description of the group.

setDescription

public void setDescription(java.lang.String description)

Sets the description of the group. The description often summarizes a group's function, such as 'Administrators of the XYZ community'. This method is restricted to those with group administration permission.

Parameters:

description - the description of the group.

Throws:

UnauthorizedException - if does not have group administrator permissions.

getCreationDate

public java.util.Date getCreationDate()

Returns the date that the group was created.

Returns:

the date the group was created.

setCreationDate

public void setCreationDate(java.util.Date creationDate)

Sets the creation date of the group. In most cases, the creation date will default to when the group was entered into the system. However, the date needs to be set manually when importing data. In other words, skin authors should ignore this method since it only intended for system maintenance.

Parameters:

creationDate - the date the group was created.

Throws:

UnauthorizedException - if does not have administrator permissions.

getModificationDate

public java.util.Date getModificationDate()

Returns the date that the group was last modified.

Returns:

the date the group record was last modified.

setModificationDate

public void setModificationDate(java.util.Date modificationDate)

Sets the date the group was last modified. Skin authors should ignore this method since it only intended for system maintenance.

Parameters:

modificationDate - the date the group was modified.

Throws:

UnauthorizedException - if does not have administrator permissions.

getMemberCount

public int getMemberCount()

Returns the number of users that belon gto this group.

Returns:

the number of users that belon gto this group.

setMemberCount

public void setMemberCount(int memberCount)

Sets the number of users that belon gto this group.

Parameters:

memberCount - the number of users that belon gto this group.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class JiveObject

hashCode

public int hashCode()

Overrides:

hashCode in class JiveObject

toString

public java.lang.String toString()

Overrides:

toString in class JiveObject