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

public interface IInstalledObjects

This interface provides access to configuration information for services and service containers associated with install objects.

See Also:

IInstall, IService, IServiceContainer

Method Summary

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

Method Detail

getInstalledObjectIDs

java.util.Set getInstalledObjectIDs()

Returns the IDs of the associated objects.

The type of each associated object is determined by the method that returned this IInstalledObjects collection:

IInstalledObjects Returned By	getInstalledObjectIDs Returns
IInstallBase.getInstalledContainers()	IDs of the associated IServiceContainer objects
IInstallBase.getInstalledServices()	IDs of the associated IService objects
IServiceBase.getServiceInstalls()	IDs of the associated IInstall objects
IServiceContainerBase.getContainerInstalls()	IDs of the associated IInstall objects

Returns:

A Set containing the IDs of the associated objects.

add

IInstalledObject add(int id)

Creates a set of configuration properties for the service or service container associated with the install, or returns the existing set if one exists. The type of the object with the specified ID must match the type of the other objects in the collection.

Parameters:

id - The ID of the install, service, or service container

Returns:

IInstalledObject containing the configuration properties.

See Also:

IInstalledObjects.getInstalledObjectIDs()

get

IInstalledObject get(int id)

Returns the configuration properties for the service or service container associated with the install.

Parameters:

id - The ID of the install, service, or service container

Returns:

IInstalledObject 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 service or service container associated with the install.

Parameters:

id - The ID of the install, service, or service container

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 objects in the collection.