com.businessobjects.sdk.plugin.desktop.servicecommon
Interface IServiceCommon

All Superinterfaces:

IInfoObject

All Known Subinterfaces:

IService, IServiceBase, IServiceContainer, IServiceContainerBase

All Known Implementing Classes:

ServiceCommon

public interface IServiceCommon
extends IInfoObject

Methods common to both IServiceBase and IServiceContainerBase

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

Method Summary

IConfigProperties	addConfigProps() Returns a new, empty collection of configuration properties for this service/service container or returns the existing configuration properties if they exist.
IConfigProperties	getConfigProps() Returns the configuration properties that are defined for this service/service container, or null if there are no configuration properties defined.
java.lang.String	getDescription(java.util.Locale locale) Returns the localized description of this service/service container.
java.lang.String	getMessageString(int resourceid, java.util.Locale loc, java.util.List substrings) Returns the actual message string based on resource id and locale.
java.lang.String	getServerKind() Returns the server kind that is assigned to servers that use this service/service container.
IIntegerProps	getSupportedAuditEvents() Returns the IDs for the audit events that are supported by this service.

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

Method Detail

getConfigProps

IConfigProperties getConfigProps()

Returns the configuration properties that are defined for this service/service container, or null if there are no configuration properties defined. These configuration properties are used as the defaults when a server is configured to use this service/service container.

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

Returns:

The configuration property collection for this service/service container.

InfoObject properties to query for:

SI_CONFIG

addConfigProps

IConfigProperties addConfigProps()

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

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

Returns:

The configuration property collection for this service/service container.

InfoObject properties to query for:

SI_CONFIG

getSupportedAuditEvents

IIntegerProps getSupportedAuditEvents()

Returns the IDs for the audit events that are supported by this service.

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

Returns:

A read-only collection of audit event IDs

InfoObject properties to query for:

SI_SUPPORTED_AUDIT_EVENTS

getDescription

java.lang.String getDescription(java.util.Locale locale)
                                throws SDKException

Returns the localized description of this service/service container.

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

Specified by:

getDescription in interface IInfoObject

Parameters:

locale - The locale for the description.

Returns:

The localized description of this service/service container.

Throws:

SDKException - if the process is unsuccessful.

InfoObject properties to query for:

SI_ML_DESCRIPTION

getServerKind

java.lang.String getServerKind()

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

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

Returns:

The server kind.

InfoObject properties to query for:

SI_SERVER_KIND

getMessageString

java.lang.String getMessageString(int resourceid,
                                  java.util.Locale loc,
                                  java.util.List substrings)

Returns the actual message string based on resource id and locale. The resource id is from #getResourceID().

Parameters:

resourceid - Resource ID to get the message string

loc - locale of the message string

substrings - substrings of the message string

Returns:

the actual message string based on resource id and locale

Since:

4.0

InfoObject properties to query for:

SI_ML_STRINGS