com.businessobjects.sdk.plugin.desktop.servicecontainer
Interface IServiceContainerBase

All Superinterfaces:

IInfoObject, IServiceCommon

All Known Subinterfaces:

IServiceContainer

public interface IServiceContainerBase
extends IServiceCommon

This interface represents an executable binary that can be configured to load services.

Nested Class Summary

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 ServiceContainer objects.

Method Summary

IConfigProperties	addConfigProps() Returns a new, empty collection of configuration properties for this service container or returns the existing configuration properties if they exist.
IInstalledObjects	getContainerInstalls() Returns a collection containing the service container configuration information for each install that includes this service container.
IConfiguredContainers	getContainerInstances() Returns a collection containing the service container configuration information for each server that hosts this service container.
int	getMaxServiceCount() Returns the maximum number of primary services supported by this service container.
java.lang.String	getServerAbbreviation() Returns the abbreviated name that is assigned to servers that use this service container.
java.util.Set	getServices() Returns the IDs of the services that this service container supports.
void	setServerAbbreviation(java.lang.String abbreviation) Sets the abbreviated name that is assigned to servers that use this service container.
void	setServerKind(java.lang.String serverKind) Sets the server kind that is assigned to servers that use this service container.

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 ServiceContainer 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 container 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 container.

InfoObject properties to query for:

SI_CONFIG

getServices

java.util.Set getServices()
                          throws SDKException

Returns the IDs of the services that this service container supports.

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

Returns:

A set of IDs for the services that are supported by this service container.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_SERVICE4SC

getContainerInstances

IConfiguredContainers getContainerInstances()
                                            throws SDKException

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

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

Returns:

com.businessobjects.sdk.plugin.desktop.common.IConfiguredContainers containing configuration information for servers using this service container.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_CONTAINER_INSTANCES
SI_CONFIG

getContainerInstalls

IInstalledObjects getContainerInstalls()
                                       throws SDKException

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

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

Returns:

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

Throws:

SDKException - This is thrown if the process is unsuccessful.

InfoObject properties to query for:

SI_CONTAINER_INSTALLS

setServerKind

void setServerKind(java.lang.String serverKind)

Sets the server kind that is assigned to servers that use this service container.

getServerAbbreviation

java.lang.String getServerAbbreviation()

Returns the abbreviated name that is assigned to servers that use this service container.

To read this value, this object must contain the SI_SERVER_ABBREVIATION and SI_SERVER_KIND properties.

Returns:

The server abbreviation.

Since:

4.0

InfoObject properties to query for:

SI_SERVER_ABBREVIATION
SI_SERVER_KIND

setServerAbbreviation

void setServerAbbreviation(java.lang.String abbreviation)

Sets the abbreviated name that is assigned to servers that use this service container.

Since:

4.0

getMaxServiceCount

int getMaxServiceCount()

Returns the maximum number of primary services supported by this service container. If the value is 0, the container can host an unlimited number of primary services.

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

Returns:

The maximum number of services supported.

See Also:

IServiceBase.getServiceClass()

InfoObject properties to query for:

SI_MAX_SERVICE_COUNT