|
Jive Forums API (5.5.20.2-oracle) Core Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Group
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.
For example, CREATE_THREAD permissions can be set per forum. A forum administrator may wish to create a "Thread Posters" group that has CREATE_THREAD permissions in the forum. Then, users can be added to that group and will automatically receive CREATE_THREAD permissions in that forum.
Security for Group objects is provide by GroupProxy protection proxy objects.
User
Method Summary | |
---|---|
void |
addAdministrator(User user)
Grants administrator privileges of the group to a user. |
void |
addMember(User user)
Adds a member to the group. |
void |
deleteProperty(java.lang.String name)
Deletes an extended property. |
int |
getAdministratorCount()
Returns the number of group administrators. |
java.util.Iterator |
getAdministrators()
An iterator for all the users that are administrators of the group. |
java.util.Date |
getCreationDate()
Returns the date that the group was created. |
java.lang.String |
getDescription()
Returns the description of the group. |
long |
getID()
Returns the id of the group. |
int |
getMemberCount()
Returns the number of group members. |
java.util.Iterator |
getMembers()
An iterator for all the users that are members of the group. |
java.util.Date |
getModificationDate()
Returns the date that the group was last modified. |
java.lang.String |
getName()
Returns the name of the group. |
Permissions |
getPermissions(AuthToken authToken)
Returns the permissions for the group that correspond to the passed-in AuthToken. |
java.lang.String |
getProperty(java.lang.String name)
Returns an extended property of the group. |
java.util.Iterator |
getPropertyNames()
Returns an Iterator for all the names of the extended group properties. |
boolean |
isAdministrator(User user)
Returns true if the User has group administrator permissions. |
boolean |
isAuthorized(long permissionType)
Returns true if the handle on the object has the permission specified. |
boolean |
isMember(User user)
Returns true if if the User is a member of the group. |
void |
removeAdministrator(User user)
Revokes administrator privileges of the group to a user. |
void |
removeMember(User user)
Removes a member from the group. |
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 |
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. |
void |
setProperty(java.lang.String name,
java.lang.String value)
Sets an extended property of the group. |
Method Detail |
---|
long getID()
java.lang.String getName()
void setName(java.lang.String name) throws UnauthorizedException
name
- the name for the group.
UnauthorizedException
- if does not have group administrator permissions.java.lang.String getDescription()
void setDescription(java.lang.String description) throws UnauthorizedException
description
- the description of the group.
UnauthorizedException
- if does not have group administrator permissions.java.util.Date getCreationDate()
void setCreationDate(java.util.Date creationDate) throws UnauthorizedException
creationDate
- the date the group was created.
UnauthorizedException
- if does not have administrator permissions.java.util.Date getModificationDate()
void setModificationDate(java.util.Date modificationDate) throws UnauthorizedException
modificationDate
- the date the group was modified.
UnauthorizedException
- if does not have administrator permissions.java.lang.String getProperty(java.lang.String name)
name
- the name of the property to get.
void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if not allowed to change the group.void deleteProperty(java.lang.String name) throws UnauthorizedException
name
does not exist,
this method will do nothing.
name
- the name of the property to delete.
UnauthorizedException
- if not allowed to edit messages.java.util.Iterator getPropertyNames()
void addAdministrator(User user) throws UnauthorizedException
user
- the User to grant adminstrative privileges to.
UnauthorizedException
- if does not have group administrator permissions.void removeAdministrator(User user) throws UnauthorizedException
user
- the User to grant adminstrative privileges to.
UnauthorizedException
- if does not have group administrator permissions.void addMember(User user) throws UnauthorizedException
user
- the User to add to the group.
UnauthorizedException
- if does not have group administrator permissions.void removeMember(User user) throws UnauthorizedException
user
- the User to remove from the group.
UnauthorizedException
- if does not have group administrator permissions.boolean isAdministrator(User user)
boolean isMember(User user)
int getAdministratorCount()
int getMemberCount()
java.util.Iterator getMembers()
java.util.Iterator getAdministrators()
Permissions getPermissions(AuthToken authToken)
authToken
- the auth token to lookup permissions for.
Permissions
boolean isAuthorized(long permissionType)
permissionType
- a permission type.
Permissions
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |