com.netegrity.llsdk6.imsapi.abstractinterface
Interface GroupableObject

All Known Subinterfaces:

Group, User

public interface GroupableObject

Defines an object that can become a member of a group.

Since:

IdentityMinder 6.0

Method Summary

void	addToGroup(Group group) Adds the current object to the specified group.
java.util.Vector	getGroups(java.util.Enumeration attribs) Retrieves all the groups that this object is a member of.
java.util.Vector	getGroups(java.util.Enumeration attribs, GroupReturnType gType)
boolean	isInGroup(Group group) Determines whether the current object is a member of the specified group.
void	removeFromGroup(Group group) Removes the current object from the specified group.

Method Detail

addToGroup

void addToGroup(Group group)
                throws SmApiException

Adds the current object to the specified group.

Parameters:

group - The group to which the current object is being added.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this GroupableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this GroupableObject represents an object which can be deleted, that has already been deleted

com.netegrity.sdk.apiutil.SmApiException

SmApiException

removeFromGroup

void removeFromGroup(Group group)
                     throws SmApiException

Removes the current object from the specified group.

Parameters:

group - The group from which the current object is being removed.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this GroupableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this GroupableObject represents an object which can be deleted, that has already been deleted

com.netegrity.sdk.apiutil.SmApiException

SmApiException

isInGroup

boolean isInGroup(Group group)
                  throws SmApiException

Determines whether the current object is a member of the specified group.

Parameters:

group - The group in question.

Returns:

true if the object is a member of the group, or false otherwise.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this GroupableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this GroupableObject represents an object which can be deleted, that has already been deleted

SmApiException

getGroups

java.util.Vector getGroups(java.util.Enumeration attribs)
                           throws com.netegrity.sdk.apiutil.SmApiException

Retrieves all the groups that this object is a member of.

All groups are returned wether explictly a member of a group or implicitly as a result of a nested group or a dynamic group.

Parameters:

attributes - An Enumeration of Strings containing names of the attributes to include in the retrieved objects. If you pass an empty Enumeration, no attributes are included. If you pass null, all attributes are included.

Returns:

The group objects that the current object is a member of.

Throws:

com.netegrity.llsdk6.imsapi.exception.NoSessionException - - If this GroupableObject is also a ConnectableObject that is not connected to a session (i.e. isConnected() would return false).

com.netegrity.llsdk6.imsapi.exception.DeletedObjectException - - If this GroupableObject represents an object which can be deleted, that has already been deleted

com.netegrity.sdk.apiutil.SmApiException

getGroups

java.util.Vector getGroups(java.util.Enumeration attribs,
                           GroupReturnType gType)
                           throws com.netegrity.sdk.apiutil.SmApiException

Throws:

com.netegrity.sdk.apiutil.SmApiException