Oracle® Collaboration Suite Workspaces API Reference
10g Release 1 (10.1.2)

B25479-01


oracle.workspaces.authorization
Class CwSubgroup

java.lang.Object
  extended byoracle.workspaces.authorization.CwSubgroup


public final class CwSubgroup
extends java.lang.Object

This class represents a subgroup defined in a workspace which is a collection of members in this workspace. Those members can be either individual users or group members. This subgroup entity can be a target to grant permissions/roles in the workspace. To create a subgroup in a workspace, please use oracle.workspaces.container.CwWorkspace.createSubgroup. To get a subgroup in a workspace, please use CwWorkspace.getSubgroupById(java.lang.String).


Method Summary
CwAddSubgroupMembersResponse addMembers(CwMember[] members)
Add a workspace member to a group.
CwDeleteSubgroupMembersResponse dropMembers(CwMember[] members)
Drop a workspace member to a group.
java.lang.String getDistinguishedName()
int getGranteeType()
Get the type of the grantee.
java.lang.String getId()
CwSubgroupProperties getProperties()
Return the properties in the group
CwWorkspace getWorkspace()
Return the workspace for this member
boolean isMember(CwUser identity)
Check if a user is the member of this subgroup.
CwMember[] listMembers()
List the members of the subgroup.
void storeProperties()
Set the new properties.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

addMembers

public CwAddSubgroupMembersResponse addMembers(CwMember[] members)
                                        throws CwException
Add a workspace member to a group. After the operation, all the grantable for this group is granted to the member and the member is added to the group.
Throws:
CwException

dropMembers

public CwDeleteSubgroupMembersResponse dropMembers(CwMember[] members)
                                            throws CwException
Drop a workspace member to a group.
Throws:
CwException

getDistinguishedName

public java.lang.String getDistinguishedName()

getGranteeType

public int getGranteeType()
Get the type of the grantee.
Returns:
the type of the grantee.

getId

public java.lang.String getId()

getProperties

public CwSubgroupProperties getProperties()
                                   throws CwException
Return the properties in the group
Throws:
CwException

getWorkspace

public CwWorkspace getWorkspace()
Return the workspace for this member
Returns:
the workspace for this member

isMember

public boolean isMember(CwUser identity)
                 throws CwException
Check if a user is the member of this subgroup. It is used to support the case when a CwGroupMember is added to a subgroup, then all the members of this CwGroupMember should be able to know this subgroup
Throws:
CwException

listMembers

public CwMember[] listMembers()
                       throws CwException
List the members of the subgroup.
Throws:
CwException

storeProperties

public void storeProperties()
                     throws CwException
Set the new properties. The new properties include
Throws:
CwException

Copyright © 2001, 2005, Oracle. All rights reserved.