|
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.MockGroup
public class MockGroup
A mock implementation of the Group interface - developers should subclass this class to provide more functionality in their test cases.
Constructor Summary | |
---|---|
MockGroup(long groupID)
|
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. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MockGroup(long groupID)
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 permissionType)
Group
isAuthorized
in interface Group
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 |