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

public interface IConfiguredService

This interface provides access to the configuration information of a service that is running on a server.

Note that this information can be retrieved from the repository by querying for either the server or the service. A server query must include the SI_HOSTED_SERVICES property. A service query must include the SI_SERVICE_HOSTS property.

See Also:

IService, IServer

Method Summary

java.lang.Integer	getConfigError() Returns the ID of the error that resulted in the "stopped" or "starting error" state of the service status.
java.lang.String	getCUID() Returns the CUID of the Service object.
IServiceDeploymentConfig	getDeploymentConfig() For internal use only.
int	getServiceClass() Returns the service class.
java.lang.Integer	getServiceStatus() Deprecated. Use IConfiguredService.getServiceStatusEnum() instead
ServiceState	getServiceStatusEnum() Returns the status of the service.
int	getServiceVersion() Returns the version of the service.
java.lang.String	getType() Returns the type of the service.
boolean	isUsingServiceConfigProps() Returns whether this configured service is using the configuration property values of the associated service.
void	resetToServiceConfigProps() Resets the configuration properties to the current values of the associated service.
void	setConfigError(int errorState) Set the ID of the error that is preventing the service from running.
void	setCUID(java.lang.String cuid) Set CUID to identify the service object associated with this IConfiguredService.
void	setServiceStatus(int status) Deprecated. Use IConfiguredService.setServiceStatusEnum(com.businessobjects.sdk.plugin.desktop.common.ServiceState) instead
void	setServiceStatusEnum(ServiceState status) Sets the status of the service.
void	setServiceVersion(int version) Sets the version of the service.
void	setType(java.lang.String type) Sets the type of the service.
void	useServiceConfigProps() Sets this configured service to use the configuration property values of the associated service.

Method Detail

getDeploymentConfig

IServiceDeploymentConfig getDeploymentConfig()

For internal use only.

getServiceStatus

java.lang.Integer getServiceStatus()

Deprecated. Use IConfiguredService.getServiceStatusEnum() instead

Returns the status of the service.

Returns:

The service status.

Since:

4.0

getServiceStatusEnum

ServiceState getServiceStatusEnum()

Returns the status of the service.

Returns:

The service status.

Since:

4.0

setServiceStatus

void setServiceStatus(int status)

Deprecated. Use IConfiguredService.setServiceStatusEnum(com.businessobjects.sdk.plugin.desktop.common.ServiceState) instead

Sets the status of the service.

Parameters:

status - The service status.

Since:

4.0

setServiceStatusEnum

void setServiceStatusEnum(ServiceState status)

Sets the status of the service.

Parameters:

status - The service status.

Since:

4.0

getConfigError

java.lang.Integer getConfigError()

Returns the ID of the error that resulted in the "stopped" or "starting error" state of the service status.

Returns:

ID of the error preventing the service from running.

setConfigError

void setConfigError(int errorState)

Set the ID of the error that is preventing the service from running.

Parameters:

errorState - The ID of the error.

getServiceVersion

int getServiceVersion()

Returns the version of the service.

Returns:

The service version.

setServiceVersion

void setServiceVersion(int version)

Sets the version of the service.

Parameters:

version - The service version.

getType

java.lang.String getType()

Returns the type of the service.

Returns:

The service type.

setType

void setType(java.lang.String type)

Sets the type of the service.

Parameters:

type - The service type.

getCUID

java.lang.String getCUID()

Returns the CUID of the Service object.

Returns:

CUID of the service.

setCUID

void setCUID(java.lang.String cuid)

Set CUID to identify the service object associated with this IConfiguredService.

Parameters:

cuid - The CUID of the service object.

isUsingServiceConfigProps

boolean isUsingServiceConfigProps()

Returns whether this configured service is using the configuration property values of the associated service.

Returns:

true if using the configuration property values of the associated service, false otherwise.

See Also:

IConfiguredService.useServiceConfigProps()

useServiceConfigProps

void useServiceConfigProps()
                           throws SDKException

Sets this configured service to use the configuration property values of the associated service. If the configuration properties of the service are modified, those changes are automatically propagated to this configured service.

Throws:

SDKException - if the process is unsuccessful.

See Also:

IConfiguredService.isUsingServiceConfigProps()

resetToServiceConfigProps

void resetToServiceConfigProps()
                               throws SDKException

Resets the configuration properties to the current values of the associated service.

This method has no effect if IConfiguredService.isUsingServiceConfigProps() is true.

Throws:

SDKException - if the process is unsuccessful.

See Also:

#resetToFactoryConfigProps

getServiceClass

int getServiceClass()

Returns the service class. The possible values that can be returned are defined in the IServiceBase.ServiceClass interface.

Returns:

The service class.