com.businessobjects.sdk.plugin.desktop.service
Interface IServiceBase

All Superinterfaces:

IInfoObject, IServiceCommon

All Known Subinterfaces:

IService

public interface IServiceBase
extends IServiceCommon

This interface represents a service that can be hosted by a BusinessObjects Enterprise server.

Nested Class Summary

static interface

IServiceBase.ServiceClass

Nested classes/interfaces inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

IInfoObject.CommitLevel, IInfoObject.Delta, IInfoObject.LocaleOption, IInfoObject.LockStatus, IInfoObject.PropertySet

Field Summary

static java.lang.String	KIND
static java.lang.String	PROGID
static int	TYPEID The TypeId for Service objects.

Method Summary

IConfigProperties	addConfigProps() Returns a new, empty collection of configuration properties for this service or returns the existing configuration properties if they exist.
java.util.Set	getContainers() Returns a collection containing the IDs of the service containers that are configured to load this service.
java.util.Set	getDependingServices() Returns the IDs of the services that have dependencies on this service.
IConfigProperties	getGlobalConfigProps() Returns the global configuration properties that are defined for this service, or returns a new, empty collection of configuration properties if there are no configuration properties defined.
java.lang.String	getOCAServiceName() Returns the OCA service name To read this value, this object must contain the SI_OCASERVICE_NAME property.
java.util.Set	getParentService() Returns the IDs for the services on which this service has dependencies.
java.util.Set	getServiceCategories() Returns the IDs of the service categories to which this service belongs.
int	getServiceClass() Returns the service class.
IConfiguredServices	getServiceHosts() Returns a collection containing the service configuration information for each server that hosts this service.
IInstalledObjects	getServiceInstalls() Returns a collection containing the service configuration information for each install that includes this service.
java.util.Set	getServicesNeededAtRuntime() Returns IDs for the non-core-categorized services that are needed by this service at run time.
java.util.Set	getServicesUsingThisServiceAtRuntime() Returns the IDs for services that are using this service at runtime.
int	getServiceVersion() Returns the service version.
java.lang.String	getType() Returns the service type.
void	resetToGlobalConfigProps() Resets the configuration properties to the global default values
void	setDescription(java.lang.String description, java.util.Locale locale) Adds a description corresponding to the provided locale.

Methods inherited from interface com.businessobjects.sdk.plugin.desktop.servicecommon.IServiceCommon

getConfigProps, getDescription, getMessageString, getServerKind, getSupportedAuditEvents

Methods inherited from interface com.crystaldecisions.sdk.occa.infostore.IInfoObject

applyDelta, applyDelta, clearTenantID, deleteNow, getCommitLevel, getCUID, getDelta, getDelta, getDescription, getDescription, getDescriptionLocales, getFileLocales, getFiles, getFiles, getGUID, getID, getKeyword, getKind, getLockInfo, getOwner, getOwnerID, getParent, getParent, getParentCUID, getParentID, getProcessingInfo, getProgID, getRUID, getSchedulingInfo, getSecurityInfo, getSecurityInfo2, getSourceFiles, getSpecificKind, getSpecificProgID, getTenantID, getTitle, getTitle, getTitle, getTitleLocales, getUpdateTimeStamp, isDirty, isInstance, isLockHeld, isMarkedAsRead, isReadOnly, properties, propertyIDs, releaseLock, removeFiles, removeSourceFiles, retrievePropertySet, save, setCommitLevel, setDescription, setKeyword, setMarkedAsRead, setParentID, setTenantID, setTitle, unlockNow

Field Detail

TYPEID

static final int TYPEID

The TypeId for Service objects.

See Also:

Constant Field Values

KIND

static final java.lang.String KIND

See Also:

Constant Field Values

PROGID

static final java.lang.String PROGID

See Also:

Constant Field Values

Method Detail

addConfigProps

IConfigProperties addConfigProps()

Returns a new, empty collection of configuration properties for this service or returns the existing configuration properties if they exist.

To read this value, this object must contain the SI_CONFIG property.

Specified by:

addConfigProps in interface IServiceCommon

Returns:

The configuration property collection for this service.

InfoObject properties to query for:

SI_CONFIG

getGlobalConfigProps

IConfigProperties getGlobalConfigProps()

Returns the global configuration properties that are defined for this service, or returns a new, empty collection of configuration properties if there are no configuration properties defined.

To read this value, this object must contain the SI_GLOBAL_CONFIG property.

Returns:

The configuration property collection for this service.

Since:

4.0

InfoObject properties to query for:

SI_GLOBAL_CONFIG

resetToGlobalConfigProps

void resetToGlobalConfigProps()
                              throws SDKException

Resets the configuration properties to the global default values

Throws:

SDKException - if the process is unsuccessful.

Since:

4.0

getDependingServices

java.util.Set getDependingServices()
                                   throws SDKException

Returns the IDs of the services that have dependencies on this service.

To read this value, this object must contain the SI_DEPENDENT_SERVICES property.

Returns:

The set of IDs for the services that are dependent on this service.

Throws:

SDKException - if the process was unsuccessful.

InfoObject properties to query for:

SI_DEPENDENT_SERVICES

getParentService

java.util.Set getParentService()
                               throws SDKException

Returns the IDs for the services on which this service has dependencies.

To read this value, this object must contain the SI_SERVICE_DEPENDENCIES property.

Returns:

The set of IDs for the services this service is dependent upon.

Throws:

SDKException - if the process was unsuccessful.

InfoObject properties to query for:

SI_SERVICE_DEPENDENCIES

getServicesUsingThisServiceAtRuntime

java.util.Set getServicesUsingThisServiceAtRuntime()
                                                   throws SDKException

Returns the IDs for services that are using this service at runtime. This information is likely incomplete and you will likely need to supplement it with information outside this method.

Returns:

the IDs of the service(s) that use this service at runtime

Throws:

SDKException - if the process was unsuccessful

Since:

4.1

InfoObject properties to query for:

SI_USES_THIS_SERVICE_AT_RUNTIME

getServicesNeededAtRuntime

java.util.Set getServicesNeededAtRuntime()
                                         throws SDKException

Returns IDs for the non-core-categorized services that are needed by this service at run time. This information is likely incomplete and you will likely need to supplement it with information outside this method.

Returns:

the IDs of the service(s) required by this service at run time

Throws:

SDKException - if the process was unsuccessful

Since:

4.1

InfoObject properties to query for:

SI_SERVICE_NEEDS_AT_RUNTIME

getServiceHosts

IConfiguredServices getServiceHosts()
                                    throws SDKException

Returns a collection containing the service configuration information for each server that hosts this service.

To read this value, this object must contain the SI_SERVICE_HOSTS property.

Returns:

com.businessobjects.sdk.plugin.desktop.common.IConfiguredServices containing configuration information for servers hosting this service.return IConfiguredServices that provide an interface to the service-server edges.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_CONFIG
SI_SERVICE_HOSTS

getServiceInstalls

IInstalledObjects getServiceInstalls()
                                     throws SDKException

Returns a collection containing the service configuration information for each install that includes this service.

To read this value, this object must contain the SI_SERVICE_INSTALLS property.

Returns:

com.businessobjects.sdk.plugin.desktop.common.IInstalledObjects containing configuration information for installs that contain this service.

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVICE_INSTALLS

getContainers

java.util.Set getContainers()
                            throws SDKException

Returns a collection containing the IDs of the service containers that are configured to load this service.

To read this value, this object must contain the SI_SERVICEC4SERVICE property.

Returns:

A collection of service container IDs

Throws:

SDKException

InfoObject properties to query for:

SI_SERVICEC4SERVICE

getServiceVersion

int getServiceVersion()

Returns the service version.

To read this value, this object must contain the SI_SERVICE_VERSION property.

Returns:

The service version.

InfoObject properties to query for:

SI_SERVICE_VERSION

getType

java.lang.String getType()

Returns the service type.

To read this value, this object must contain the SI_SERVICE_TYPE property.

Returns:

The service type.

InfoObject properties to query for:

SI_SERVICE_TYPE

setDescription

void setDescription(java.lang.String description,
                    java.util.Locale locale)

Adds a description corresponding to the provided locale. If a string already exists for the locale, it will be overwritten.

Parameters:

description - The description for this service.

locale - The locale corresponding to the language of the string.

getServiceClass

int getServiceClass()

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

To read this value, this object must contain the SI_SERVICE_CLASS property.

Returns:

The service class.

InfoObject properties to query for:

SI_SERVICE_CLASS

getServiceCategories

java.util.Set getServiceCategories()

Returns the IDs of the service categories to which this service belongs.

To read this value, this object must contain the SI_SERVICE_CATEGORY property.

Returns:

The collection of service category IDs.

InfoObject properties to query for:

SI_SERVICE_CATEGORIES

getOCAServiceName

java.lang.String getOCAServiceName()

Returns the OCA service name

To read this value, this object must contain the SI_OCASERVICE_NAME property.

Returns:

OCA service name

Since:

4.0

InfoObject properties to query for:

SI_OCASERVICE_NAME