com.plumtree.remote.prc
Interface IUserGroupManager

All Superinterfaces:

IObjectManager

public interface IUserGroupManager

extends IObjectManager

Interface that enables management of user groups.

Method Summary

void	addMemberGroups(int parentGroupID, int[] memberGroupIDs) Adds groups to a group.
void	addMemberUsers(int groupID, int[] memberUserIDs) Adds users to a group.
int	createGroup(java.lang.String name, java.lang.String description, int adminFolderID, int[] memberUserIDs, int[] memberGroupIDs) Creates a new user group.
void	deleteGroups(int[] groupIDs) Deletes specified user groups.
int	getMemberGroupCount(int nGroupID) Queries and gets total number of the groups in a given group.
int[]	getMemberGroupIds(int nGroupID) Returns an array containing the ids of member groups in the group specified by groupID.
IObjectQuery	getMemberGroups(int nGroupID, int startIndex, int endIndex) Returns the groups and their properties with in a given user group, and gets all the member groups with in the given startIndex and endIndex, when the group with the specified id is not found we return a null value.
int	getMemberUserCount(int nGroupID, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) Queries and gets total number of the users in a given group.
int[]	getMemberUserIds(int nGroupID, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) Returns an array containing the ids of users in the group specified by groupID.
IObjectQuery	getMemberUsers(int nGroupID, int startIndex, int endIndex, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) Returns the users and their properties with in a given UserGroup, and gets all the member users with in the given startIndex and endIndex, when the group with the specified id is not found we return a null value.
void	removeMemberGroups(int parentGroupID, int[] memberGroupIDs) Removes groups from a group.
void	removeMemberUsers(int groupID, int[] memeberUserIDs) Removes users from a group.

Methods inherited from interface com.plumtree.remote.prc.IObjectManager

lookupObjectID, lookupUUID, queryACL, queryCommunitiesForPortlet, queryExtendedData, queryObjects, queryObjects, queryObjects, queryObjects, queryObjects, querySingleObject, updateACL

Method Detail

createGroup

public int createGroup(java.lang.String name,
                       java.lang.String description,
                       int adminFolderID,
                       int[] memberUserIDs,
                       int[] memberGroupIDs)
                throws PortalException,
                       java.rmi.RemoteException

Creates a new user group. Note: Any invalid user or group IDs will be silently ignored.

Parameters:

name - the name for the new group

description - the description for the new group

adminFolderID - the admin folder ID to create the group in; cannot be negative

memberUserIDs - an array of user IDs to include as members

memberGroupIDs - an array of group IDs to include as subgroups

Returns:

the ID of the newly created user group

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

deleteGroups

public void deleteGroups(int[] groupIDs)
                  throws PortalException,
                         java.rmi.RemoteException

Deletes specified user groups. Passing any invalid or non-existent group IDs (or any duplicates) will result in a PortalException. Note: Since this method performs multiple operations, any exception thrown will have details of each failure.

Parameters:

groupIDs - an array of group IDs to delete

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

addMemberUsers

public void addMemberUsers(int groupID,
                           int[] memberUserIDs)
                    throws PortalException,
                           java.rmi.RemoteException

Adds users to a group. Any invalid user IDs will be silently ignored. Passing a non-existent group ID will result in a PortalException. Note: Since this method performs multiple operations, any exception thrown will have details of each failure.

Parameters:

groupID - the ID of the group to add the users to

memberUserIDs - an array of user IDs to add to the group

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

java.lang.IllegalArgumentException - if the method passed an invalid group ID

removeMemberUsers

public void removeMemberUsers(int groupID,
                              int[] memeberUserIDs)
                       throws PortalException,
                              java.rmi.RemoteException

Removes users from a group. Any invalid memberUserIDs will be silently ignored. Passing a non-existent groupID will result in a PortalException. Note: Since this method performs multiple operations, any exception thrown will have details of each failure.

Parameters:

groupID - the ID of the group to remove the users from

memeberUserIDs - an array of user IDs to remove from the group

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

java.lang.IllegalArgumentException - if the method passed an invalid group ID

addMemberGroups

public void addMemberGroups(int parentGroupID,
                            int[] memberGroupIDs)
                     throws PortalException,
                            java.rmi.RemoteException

Adds groups to a group. Any invalid memberGroupIDs will be silently ignored. Passing a non-existent parentGroupID will result in a PortalException. Note: Since this method performs multiple operations, any exception thrown will have details of each failure.

Parameters:

parentGroupID - the ID of the parent group to add the groups to

memberGroupIDs - an array of group IDs to add to the parent group

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

java.lang.IllegalArgumentException - if the method passed an invalid parent group ID

removeMemberGroups

public void removeMemberGroups(int parentGroupID,
                               int[] memberGroupIDs)
                        throws PortalException,
                               java.rmi.RemoteException

Removes groups from a group. Any invalid memberGroupIDs will be silently ignored. Passing a non-existent parentGroupID will result in a PortalException. Note: Since this method performs multiple operations, any exception thrown will have details of each failure.

Parameters:

parentGroupID - the ID of the parent group to remove the groups from

memberGroupIDs - an array of group IDs to remove from the parent group

Throws:

PortalException - if the operation resulted in an error on the portal

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

java.lang.IllegalArgumentException - if the method passed an invalid parent group ID

getMemberUserIds

public int[] getMemberUserIds(int nGroupID,
                              boolean bIncludeDynamicMembers,
                              boolean bIncludeStaticMembers)
                       throws java.rmi.RemoteException

Returns an array containing the ids of users in the group specified by groupID. If there are no users in the specified group, a 0-length array will be returned. when the group with the specified id is not found we return a null value.

Returns:

Array of Object ID values of the users in given group

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getMemberGroupIds

public int[] getMemberGroupIds(int nGroupID)
                        throws java.rmi.RemoteException

Returns an array containing the ids of member groups in the group specified by groupID. If there are no member groups in the specified group, a 0-length array will be returned. when the group with the specified id is not found we return a null value.

Returns:

Array of Object ID values of the users in given group

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0

java.rmi.RemoteException

getMemberUserCount

public int getMemberUserCount(int nGroupID,
                              boolean bIncludeDynamicMembers,
                              boolean bIncludeStaticMembers)
                       throws java.rmi.RemoteException

Queries and gets total number of the users in a given group.

Returns:

Total number of the users in a given group

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getMemberGroupCount

public int getMemberGroupCount(int nGroupID)
                        throws java.rmi.RemoteException

Queries and gets total number of the groups in a given group.

Returns:

Total number of the groups in a given UserGroup

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getMemberUsers

public IObjectQuery getMemberUsers(int nGroupID,
                                   int startIndex,
                                   int endIndex,
                                   boolean bIncludeDynamicMembers,
                                   boolean bIncludeStaticMembers)
                            throws java.rmi.RemoteException

Returns the users and their properties with in a given UserGroup, and gets all the member users with in the given startIndex and endIndex, when the group with the specified id is not found we return a null value. IObjectQuery returned by this method contains list of User Objects for each user in the UserGroup Each IObjectQueryRow objects in the IObjectQuery represents a user and has the following values, OBJECTID, NAME, DESCRIPTION, ISLOCALIZED, UNIQUENAME and LOGINNAME.

Parameters:

startIndex - is the index from which list of returned users should start, it should be less than or equal to endIndex.

endIndex - is the index upto which the list of returned users should end, it should be greater than or equal to startIndex

Returns:

the member users within this UserGroup

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0 or startIndex is less than endIndex.

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call

getMemberGroups

public IObjectQuery getMemberGroups(int nGroupID,
                                    int startIndex,
                                    int endIndex)
                             throws java.rmi.RemoteException

Returns the groups and their properties with in a given user group, and gets all the member groups with in the given startIndex and endIndex, when the group with the specified id is not found we return a null value. IObjectQuery returned by this method contains list of Group objects. Each IObjectQueryRow objects in the IObjectQuery represents a group and has the following values, OBJECTID, NAME, DESCRIPTION and URI

Parameters:

startIndex - is the index from which list of returned groupsshould start, it should be less than or equal to endIndex.

endIndex - is the index upto which the list of returned groups should end, it should be greater than or equal to startIndex

Returns:

the member groups within this UserGroup

Throws:

java.lang.IllegalArgumentException - if groupID is <= 0 or startIndex is less than endIndex.

java.rmi.RemoteException - if there was a communication problem during the execution of the remote method call