com.businessobjects.sdk.plugin.desktop.common
Interface IConfiguredContainers


public interface IConfiguredContainers

This collection provides access to configuration information for servers associated with a service container in a BusinessObjects Enterprise deployment.

Service container configuration information can be retrieved from the repository by querying for the service container. The query must include the SI_CONTAINER_INSTANCES property.

See Also:
IServer, IServiceContainer

Method Summary
 IConfiguredContainer add(int id)
          Creates a set of configuration properties for the server associated with the service container, or returns the existing set if one exists.
 IConfiguredContainer get(int id)
          Returns the configuration properties for the server associated with the service container.
 java.util.Set getConfiguredContainerIDs()
          Returns the IDs of the servers associated with the service container.
 java.util.Iterator iterator()
          Returns an iterator that can be used to iterate over the IConfiguredService objects in this collection.
 boolean remove(int id)
          Removes the configuration properties for the server associated with the service container.
 

Method Detail

getConfiguredContainerIDs

java.util.Set getConfiguredContainerIDs()
Returns the IDs of the servers associated with the service container.

Returns:
Set containing the IDs of the servers.

add

IConfiguredContainer add(int id)
Creates a set of configuration properties for the server associated with the service container, or returns the existing set if one exists.

Parameters:
id - The ID of the server
Returns:
IConfiguredContainer containing the configuration properties.

get

IConfiguredContainer get(int id)
Returns the configuration properties for the server associated with the service container.

Parameters:
id - The ID of the server
Returns:
IConfiguredContainer containing the configuration properties, or null if the configuration properties have not been set.

remove

boolean remove(int id)
Removes the configuration properties for the server associated with the service container.

Parameters:
id - The ID of the server
Returns:
true if the configuration properties are removed successfully, false otherwise.

iterator

java.util.Iterator iterator()
Returns an iterator that can be used to iterate over the IConfiguredService objects in this collection.