com.ibm.pim.utils
Interface Distribution


public interface Distribution

This interface defines methods for Distribution.

Since:
6.0.0

Nested Class Summary
static class Distribution.Property
          Distribution Property Type
static class Distribution.Type
          Distribution Type
 
Field Summary
static java.lang.String copyright
           
 
Method Summary
 void delete()
          Deletes the Distribution
 java.lang.String getName()
          Returns the name of this distribution
 java.lang.String getProperty(Distribution.Property propertyName)
          Retrieves the properties of this distribution
 Distribution.Type getType()
          Retrieves the distribution type
 void save()
          Saves the changes made to this distribution
 void setProperty(Distribution.Property propertyName, java.lang.String propertyValue)
          Sets the distribution properties
 

Field Detail

copyright

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

getName

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

Returns:
Name of the distribution
Throws:
PIMInternalException - If an internal error occurs

getType

Distribution.Type getType()
Retrieves the distribution type

Returns:
The Distribution Type
Throws:
PIMInternalException - If an internal error occurs

getProperty

java.lang.String getProperty(Distribution.Property propertyName)
Retrieves the properties of this distribution

Parameters:
propertyName - The name of the property
Returns:
The value for the property
Throws:
PIMInternalException - If an internal error occurs
java.lang.UnsupportedOperationException - If the user tries to fetch invalid Property which does not apply to a type of Distribution
java.lang.IllegalArgumentException - If null propertyName is passed.

setProperty

void setProperty(Distribution.Property propertyName,
                 java.lang.String propertyValue)
Sets the distribution properties

Parameters:
propertyName - The name of the property to be set
propertyValue - The value for the property
Throws:
PIMInternalException - If an internal error occurs
java.lang.UnsupportedOperationException - If the user tries to set Property which is not valid for a type of Distribution
java.lang.IllegalArgumentException - If null, empty or an invalid value is passed as arguments.

delete

void delete()
Deletes the Distribution

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

save

void save()
Saves the changes made to this distribution

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