microsoft.hawaii.sdk.relayService.ServiceContracts

Class Groups

java.lang.Object

microsoft.hawaii.sdk.relayService.ServiceContracts.Groups

All Implemented Interfaces:

java.lang.Iterable<GroupResult>

public class Groups
extends java.lang.Object
implements java.lang.Iterable<GroupResult>

A container class for Group objects.

Constructor Summary

Constructors

Constructor and Description
Groups() Initializes an instance of the Groups class

Method Summary

Methods

Modifier and Type	Method and Description
void	Add(GroupResult group) Method top add a Group object into the container.
void	Clear() Clears all item from the container.
java.lang.Boolean	Exists(java.lang.String groupId) Method to check whether a group exists in the container.
GroupResult	Find(java.lang.String groupId) Method to retrieve a Group item from the container.
int	getItemCount() Gets the number of items.
java.util.Iterator<GroupResult>	iterator()
void	Remove(java.lang.String groupId) Method to remove a group from the container based on its id.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Groups

public Groups()

Initializes an instance of the Groups class

Method Detail

iterator

public java.util.Iterator<GroupResult> iterator()

Specified by:

iterator in interface java.lang.Iterable<GroupResult>

getItemCount

public int getItemCount()

Gets the number of items.

Returns:

int Returns the items count

Add

public void Add(GroupResult group)

Method top add a Group object into the container.

Parameters:

group - the GroupResult object.

Exists

public java.lang.Boolean Exists(java.lang.String groupId)

Method to check whether a group exists in the container.

Parameters:

GroupId - the group Id.

Returns:

Boolean Returns Boolean value indicating whether this group is in the container.

Find

public GroupResult Find(java.lang.String groupId)

Method to retrieve a Group item from the container.

Parameters:

groupId - the group Id.

Returns:

Group Returns the group if it exists.

Remove

public void Remove(java.lang.String groupId)

Method to remove a group from the container based on its id.

Parameters:

groupId - the group Id

Clear

public void Clear()

Clears all item from the container.