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

All Superinterfaces:

IRestartRequired

public interface IConfiguredServices
extends IRestartRequired

This collection provides access to configuration information for services running on servers in a BusinessObjects Enterprise deployment.

Service configuration information can be retrieved from the repository by querying for either a server or a service. A server query must include the SI_HOSTED_SERVICES property. A service query must include the SI_SERVICE_HOSTS property.

See Also:

IServer, IService

Method Summary

IConfiguredService	add(int id) Creates a set of configuration properties for the service associated with the server, or returns the existing set if one exists.
IConfiguredService	get(int id) Returns the configuration properties for the service associated with the server.
java.util.Set	getConfiguredServiceIDs() Returns either server IDs or service IDs.
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 service associated with the server.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.common.IRestartRequired

checkRestartRequired

Method Detail

getConfiguredServiceIDs

java.util.Set getConfiguredServiceIDs()

Returns either server IDs or service IDs. If this object was returned by IServerBase.getHostedServices(), this method returns the IDs of the services hosted on that server. If this object was returned by IServiceBase.getServiceHosts(), this method returns the IDs of the server that host this service.

Returns:

Set containing the IDs of either the servers or the services.

add

IConfiguredService add(int id)

Creates a set of configuration properties for the service associated with the server, or returns the existing set if one exists.

Parameters:

id - The ID of the server or service

Returns:

IConfiguredService containing the configuration properties.

See Also:

IConfiguredServices.getConfiguredServiceIDs()

get

IConfiguredService get(int id)

Returns the configuration properties for the service associated with the server.

Parameters:

id - The ID of the service or server

Returns:

IConfiguredService containing the configuration properties, or null if the configuration properties have not been set.

See Also:

IConfiguredServices.getConfiguredServiceIDs()

remove

boolean remove(int id)

Removes the configuration properties for the service associated with the server.

Parameters:

id - The ID of the service or server

Returns:

true if the configuration properties are removed successfully, false otherwise.

See Also:

IConfiguredServices.getConfiguredServiceIDs()

iterator

java.util.Iterator iterator()

Returns an iterator that can be used to iterate over the IConfiguredService objects in this collection.