com.ibm.pim.utils
Interface RoutingManager

All Superinterfaces:
Manager

public interface RoutingManager
extends Manager

This interface defines methods for RoutingManager.


Field Summary
static java.lang.String copyright
           
 
Method Summary
 DataSource createDataSource(java.lang.String name, DataSource.Type type)
          Creates a datasource for MDMPIM
 Distribution createDistribution(java.lang.String name, Distribution.Type type)
          Creates MDMPIM Distributions with a given type Returns the created Distribution Object
 DistributionGroup createDistributionGroup(java.lang.String name)
          Creates MDMPIM DistributionGroup with a given Name Returns the created DistributionGroup Object
 DataSource getDataSource(java.lang.String name)
          Returns DataSource with the given name
 java.util.Collection<DataSource> getDataSources()
          Retrieve a collection of all the DataSources
 Distribution getDistribution(java.lang.String name)
          Returns Distribution with the given name
 DistributionGroup getDistributionGroup(java.lang.String name)
          Returns DistributionGroup with the given name
 java.util.Collection<DistributionGroup> getDistributionGroups()
          Retrieve a collection of all the DistributionGroups
 java.util.Collection<Distribution> getDistributions()
          Retrieve a collection of all the Distributions
 
Methods inherited from interface com.ibm.pim.common.Manager
getManagerName
 

Field Detail

copyright

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

createDataSource

DataSource createDataSource(java.lang.String name,
                            DataSource.Type type)
Creates a datasource for MDMPIM

Throws:
PIMInternalException - If there is an internal MDMPIM problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty arguments are passed

createDistribution

Distribution createDistribution(java.lang.String name,
                                Distribution.Type type)
Creates MDMPIM Distributions with a given type Returns the created Distribution Object

Parameters:
name - The name of the Distribution
type - The type of Distribution to be created
Returns:
The created Distribution Object
Throws:
PIMInternalException - If there is an internal MDMPIM problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty arguments are passed

createDistributionGroup

DistributionGroup createDistributionGroup(java.lang.String name)
Creates MDMPIM DistributionGroup with a given Name Returns the created DistributionGroup Object

Parameters:
name - The name of the DistributionGroup
Throws:
PIMInternalException - If there is an internal MDMPIM problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty name argument is passed

getDistributionGroup

DistributionGroup getDistributionGroup(java.lang.String name)
Returns DistributionGroup with the given name

Parameters:
name - The name of the DistributionGroup
Returns:
The DistributionGroup Object or null if the DistributionGroup with the name does not exist.
Throws:
PIMInternalException - If there is an internal problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty name argument is passed

getDistribution

Distribution getDistribution(java.lang.String name)
Returns Distribution with the given name

Parameters:
name - The name of the Distribution
Returns:
The Distribution Object or null if the Distribution with the name does not exist.
Throws:
PIMInternalException - If there is an internal problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty name argument is passed

getDataSource

DataSource getDataSource(java.lang.String name)
Returns DataSource with the given name

Parameters:
name - The name of the DataSource or null if the Datasource with the name does not exist.
Returns:
The DataSource Object
Throws:
PIMInternalException - If there is an internal MDMPIM problem
PIMAuthorizationException - If the user is not authorized to perform this operation
java.lang.IllegalArgumentException - If null or empty name argument is passed

getDataSources

java.util.Collection<DataSource> getDataSources()
Retrieve a collection of all the DataSources

Returns:
a Collection of DataSource objects, or an empty Collection if no DataSources are present
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not authorized to perform this operation

getDistributions

java.util.Collection<Distribution> getDistributions()
Retrieve a collection of all the Distributions

Returns:
a Collection of Distribution objects, or an empty Collection if no Distributions are present
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not authorized to perform this operation

getDistributionGroups

java.util.Collection<DistributionGroup> getDistributionGroups()
Retrieve a collection of all the DistributionGroups

Returns:
a Collection of DistributionGroup objects, or an empty Collection if no DistributionGroups are present
Throws:
PIMInternalException - If an internal error occurs
PIMAuthorizationException - If the user is not authorized to perform this operation