com.crystaldecisions.sdk.occa.infostore
Interface ICommitResultInfo

All Known Subinterfaces:

ICommitError, ICommitWarning

public interface ICommitResultInfo

An interface to the information that is returned if a problem is encountered during a commit to the InfoStore.

Method Summary

java.lang.String	getCMSMessage() Returns the message provided by the CMS.
java.lang.String	getErrorCodeString() Returns the error code string.
int	getExceptionCode() Deprecated. since 4.0
int	getID() Deprecated. Please use getIDs(). Returns the ID of the InfoObject associated with this result info. If there are multiple InfoObjects that are associated with this result info, only the first ID will be returned.
java.util.Set	getIDs() Returns the IDs of the InfoObjects associated with this result info.
java.lang.String	getLocalizedMessage(java.util.Locale locale) Returns the localized exception message.

Method Detail

getID

int getID()

Deprecated. Please use getIDs(). Returns the ID of the InfoObject associated with this result info. If there are multiple InfoObjects that are associated with this result info, only the first ID will be returned.

Returns:

An int identifying the ID of an InfoObject.

getIDs

java.util.Set getIDs()

Returns the IDs of the InfoObjects associated with this result info.

Returns:

A Set of Integers to identify InfoObjects.

getCMSMessage

java.lang.String getCMSMessage()

Returns the message provided by the CMS.

Returns:

The message provided by the CMS.

getLocalizedMessage

java.lang.String getLocalizedMessage(java.util.Locale locale)

Returns the localized exception message.

Parameters:

locale - the locale for the message

Returns:

The localized exception message.

getExceptionCode

int getExceptionCode()

Deprecated. since 4.0

Returns the exception code.

Returns:

The exception code.

getErrorCodeString

java.lang.String getErrorCodeString()

Returns the error code string.

Returns:

The error code string.

Since:

4.0