com.ibm.pim.utils
Interface DistributionGroup


public interface DistributionGroup

This interface defines methods for DistributionGroup.

Since:
6.0.0

Field Summary
static java.lang.String copyright
           
 
Method Summary
 void addDistribution(Distribution distribution)
          Adds a distribution to this distribution group
 void delete()
          Deletes this distribution group Note that any distribution contained in the distribution group will not be deleted.
 java.util.Collection<Distribution> getDistributions()
          Returns the collection of all distributions in this distribution group
 java.lang.String getName()
          Retrieves the name of this distribution
 void removeDistribution(Distribution distribution)
          Removes a distribution from this distribution group
 void save()
          Saves the changes done to this distribution group
 

Field Detail

copyright

static final java.lang.String copyright
See Also:
Constant Field Values
Method Detail

addDistribution

void addDistribution(Distribution distribution)
Adds a distribution to this distribution group

Parameters:
distribution - The distribution to be added to this group
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the distribution argument passed is null
java.lang.IllegalStateException - If the distribution argument passed has not been saved

removeDistribution

void removeDistribution(Distribution distribution)
Removes a distribution from this distribution group

Parameters:
distribution - The distribution to be removed from this group
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use
java.lang.IllegalArgumentException - If the distribution argument passed is null
java.lang.IllegalStateException - If the distribution argument passed has not been saved

getName

java.lang.String getName()
Retrieves the name of this distribution

Returns:
The name of this distribution group
Throws:
PIMInternalException - If an internal error occurs

getDistributions

java.util.Collection<Distribution> getDistributions()
Returns the collection of all distributions in this distribution group

Returns:
The collection of distributions in this distribution group
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - Reserved for future use

delete

void delete()
Deletes this distribution group Note that any distribution contained in the distribution group will not be deleted.

Throws:
PIMInternalException - If an internal error occurs while performing this operation
PIMAuthorizationException - Reserved for future use

save

void save()
Saves the changes done to this distribution group

Throws:
PIMInternalException - If an internal error occurs while performing this operation
PIMAuthorizationException - Reserved for future use