|
Jive Forums API (5.5.20.2-oracle) Developer Javadocs | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jivesoftware.base.GroupProxy
public class GroupProxy
Protection proxy for the Group interface. It restricts access of certain methods to those that have the proper permissions to administer this object.
Constructor Summary | |
---|---|
GroupProxy(Group group,
AuthToken authToken,
Permissions permissions)
|
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. |
boolean |
equals(java.lang.Object obj)
|
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. |
int |
hashCode()
|
boolean |
isAddAdministratorSupported()
Indicates whether adding an administrator to this group is supported. |
boolean |
isAddMemberSupported()
Indicates whether adding a member to this group is supported. |
boolean |
isAdministrator(User user)
Returns true if the User has group administrator permissions. |
boolean |
isAdministratorListSupported()
Indicates whether returning a list of group administrators is supported. |
boolean |
isAuthorized(long type)
Returns true if the handle on the object has the permission specified. |
boolean |
isGetAdministratorCountSupported()
Indicates whether getting a count of administrators is supported. |
boolean |
isGetMemberCountSupported()
Indicates whether getting a count of members is supported. |
boolean |
isMember(User user)
Returns true if if the User is a member of the group. |
boolean |
isMembersSupported()
Indicates whether returning a list of group members is supported. |
boolean |
isPropertyEditSupported()
Indicates whether the property methods (get, set, delete, etc.) are supported. |
boolean |
isReadOnly()
|
boolean |
isRemoveAdministratorSupported()
Indicates whether removing a group administrator is supported. |
boolean |
isRemoveMemberSupported()
Indicates whether removing a group member is supported. |
boolean |
isSetDescriptionSupported()
Indicates whether modifying the group description is supported. |
boolean |
isSetNameSupported()
Indicates whether modifying the group name is supported. |
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. |
java.lang.String |
toString()
|
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public GroupProxy(Group group, AuthToken authToken, Permissions permissions)
Method Detail |
---|
public long getID()
Group
getID
in interface Group
public java.lang.String getName()
Group
getName
in interface Group
public void setName(java.lang.String name) throws UnauthorizedException
Group
setName
in interface Group
name
- the name for the group.
UnauthorizedException
- if does not have group administrator permissions.public java.lang.String getDescription()
Group
getDescription
in interface Group
public void setDescription(java.lang.String description) throws UnauthorizedException
Group
setDescription
in interface Group
description
- the description of the group.
UnauthorizedException
- if does not have group administrator permissions.public java.util.Date getCreationDate()
Group
getCreationDate
in interface Group
public void setCreationDate(java.util.Date creationDate) throws UnauthorizedException
Group
setCreationDate
in interface Group
creationDate
- the date the group was created.
UnauthorizedException
- if does not have administrator permissions.public java.util.Date getModificationDate()
Group
getModificationDate
in interface Group
public void setModificationDate(java.util.Date modificationDate) throws UnauthorizedException
Group
setModificationDate
in interface Group
modificationDate
- the date the group was modified.
UnauthorizedException
- if does not have administrator permissions.public java.lang.String getProperty(java.lang.String name)
Group
getProperty
in interface Group
name
- the name of the property to get.
public void setProperty(java.lang.String name, java.lang.String value) throws UnauthorizedException
Group
setProperty
in interface Group
name
- the name of the property to set.value
- the new value for the property.
UnauthorizedException
- if not allowed to change the group.public void deleteProperty(java.lang.String name) throws UnauthorizedException
Group
name
does not exist,
this method will do nothing.
deleteProperty
in interface Group
name
- the name of the property to delete.
UnauthorizedException
- if not allowed to edit messages.public java.util.Iterator getPropertyNames()
Group
getPropertyNames
in interface Group
public void addAdministrator(User user) throws UnauthorizedException
Group
addAdministrator
in interface Group
user
- the User to grant adminstrative privileges to.
UnauthorizedException
- if does not have group administrator permissions.public void removeAdministrator(User user) throws UnauthorizedException
Group
removeAdministrator
in interface Group
user
- the User to grant adminstrative privileges to.
UnauthorizedException
- if does not have group administrator permissions.public void addMember(User user) throws UnauthorizedException
Group
addMember
in interface Group
user
- the User to add to the group.
UnauthorizedException
- if does not have group administrator permissions.public void removeMember(User user) throws UnauthorizedException
Group
removeMember
in interface Group
user
- the User to remove from the group.
UnauthorizedException
- if does not have group administrator permissions.public boolean isAdministrator(User user)
Group
isAdministrator
in interface Group
public boolean isMember(User user)
Group
isMember
in interface Group
public int getAdministratorCount()
Group
getAdministratorCount
in interface Group
public int getMemberCount()
Group
getMemberCount
in interface Group
public java.util.Iterator getMembers()
Group
getMembers
in interface Group
public java.util.Iterator getAdministrators()
Group
getAdministrators
in interface Group
public Permissions getPermissions(AuthToken authToken)
Group
getPermissions
in interface Group
authToken
- the auth token to lookup permissions for.
Permissions
public boolean isAuthorized(long type)
Group
isAuthorized
in interface Group
type
- a permission type.
Permissions
public boolean isAddAdministratorSupported()
IntrospectiveGroup
isAddAdministratorSupported
in interface IntrospectiveGroup
public boolean isAddMemberSupported()
IntrospectiveGroup
isAddMemberSupported
in interface IntrospectiveGroup
public boolean isAdministratorListSupported()
IntrospectiveGroup
isAdministratorListSupported
in interface IntrospectiveGroup
public boolean isMembersSupported()
IntrospectiveGroup
isMembersSupported
in interface IntrospectiveGroup
public boolean isRemoveAdministratorSupported()
IntrospectiveGroup
isRemoveAdministratorSupported
in interface IntrospectiveGroup
public boolean isRemoveMemberSupported()
IntrospectiveGroup
isRemoveMemberSupported
in interface IntrospectiveGroup
public boolean isSetDescriptionSupported()
IntrospectiveGroup
isSetDescriptionSupported
in interface IntrospectiveGroup
public boolean isSetNameSupported()
IntrospectiveGroup
isSetNameSupported
in interface IntrospectiveGroup
public boolean isGetMemberCountSupported()
IntrospectiveGroup
isGetMemberCountSupported
in interface IntrospectiveGroup
public boolean isGetAdministratorCountSupported()
IntrospectiveGroup
isGetAdministratorCountSupported
in interface IntrospectiveGroup
public boolean isPropertyEditSupported()
IntrospectiveGroup
isPropertyEditSupported
in interface IntrospectiveGroup
public boolean isReadOnly()
isReadOnly
in interface IntrospectiveGroup
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
toString
in class java.lang.Object
|
Jive Forums Project Page | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |