|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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 |
public int createGroup(java.lang.String name, java.lang.String description, int adminFolderID, int[] memberUserIDs, int[] memberGroupIDs) throws PortalException, java.rmi.RemoteException
name
- the name for the new groupdescription
- the description for the new groupadminFolderID
- the admin folder ID to create the group in; cannot be negativememberUserIDs
- an array of user IDs to include as membersmemberGroupIDs
- an array of group IDs to include as subgroups
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 callpublic void deleteGroups(int[] groupIDs) throws PortalException, java.rmi.RemoteException
PortalException
.
Note: Since this method performs multiple operations, any exception thrown will have details of
each failure.
groupIDs
- an array of group IDs to delete
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 callpublic void addMemberUsers(int groupID, int[] memberUserIDs) throws PortalException, java.rmi.RemoteException
PortalException
.
Note: Since this method performs multiple operations, any exception thrown will have details of
each failure.
groupID
- the ID of the group to add the users tomemberUserIDs
- an array of user IDs to add to the group
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 IDpublic void removeMemberUsers(int groupID, int[] memeberUserIDs) throws PortalException, java.rmi.RemoteException
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.
groupID
- the ID of the group to remove the users frommemeberUserIDs
- an array of user IDs to remove from the group
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 IDpublic void addMemberGroups(int parentGroupID, int[] memberGroupIDs) throws PortalException, java.rmi.RemoteException
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.
parentGroupID
- the ID of the parent group to add the groups tomemberGroupIDs
- an array of group IDs to add to the parent group
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 IDpublic void removeMemberGroups(int parentGroupID, int[] memberGroupIDs) throws PortalException, java.rmi.RemoteException
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.
parentGroupID
- the ID of the parent group to remove the groups frommemberGroupIDs
- an array of group IDs to remove from the parent group
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 IDpublic int[] getMemberUserIds(int nGroupID, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) throws java.rmi.RemoteException
java.lang.IllegalArgumentException
- if groupID is <= 0
java.rmi.RemoteException
- if there was a communication problem during the
execution of the remote method callpublic int[] getMemberGroupIds(int nGroupID) throws java.rmi.RemoteException
java.lang.IllegalArgumentException
- if groupID is <= 0
java.rmi.RemoteException
public int getMemberUserCount(int nGroupID, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) throws java.rmi.RemoteException
java.lang.IllegalArgumentException
- if groupID is <= 0
java.rmi.RemoteException
- if there was a communication problem during the
execution of the remote method callpublic int getMemberGroupCount(int nGroupID) throws java.rmi.RemoteException
java.lang.IllegalArgumentException
- if groupID is <= 0
java.rmi.RemoteException
- if there was a communication problem during the
execution of the remote method callpublic IObjectQuery getMemberUsers(int nGroupID, int startIndex, int endIndex, boolean bIncludeDynamicMembers, boolean bIncludeStaticMembers) throws java.rmi.RemoteException
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
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 callpublic IObjectQuery getMemberGroups(int nGroupID, int startIndex, int endIndex) throws java.rmi.RemoteException
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
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
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright ©2010 Oracle® Corporation. All Rights Reserved.