com.plumtree.remote.auth
Interface IGroup

public interface IGroup

An interface that allows a synchronization service to query for the users and groups under a group.

Method Summary

ChildGroupList	getChildGroups() Returns a ChildGroupList object with an array of ChildGroups inside.
ChildUserList	getChildUsers() Returns a ChildUserList object with an array of ChildUsers inside.

Method Detail

getChildGroups

public ChildGroupList getChildGroups()
                              throws ServiceException

Returns a ChildGroupList object with an array of ChildGroups inside. The portal will continue calling getChildGroups until it receives a ChildGroupList with the isDone flag set to true. This is done using the constructor ChildGroupList(ChildGroup[] list, boolean isDone) If the IGroup implementation returns the ChildGroups in batches, it must maintain state internally and return isDone=false until the last batch.

Returns:

a ChildGroupList object containing ChildGroups

Throws:

ServiceException - if an error occurred

See Also:

ChildGroupList

getChildUsers

public ChildUserList getChildUsers()
                            throws ServiceException

Returns a ChildUserList object with an array of ChildUsers inside. The portal will continue calling getChildUsers until it receives a ChildUserList with the isDone flag set to true. This is done using the constructor ChildUserList(ChildUser[] list, boolean isDone) If the IUser implementation returns the ChildUsers in batches, it must maintain state internally and return isDone=false until the last batch.

Returns:

a ChildUserList object containing ChildUsers

Throws:

ServiceException - if an error occurred

See Also:

ChildUserList