oracle.olapi.metadata

Class InvalidMetadataException

java.lang.Object

java.lang.Throwable

java.lang.Exception

java.lang.RuntimeException

oracle.olapi.OLAPIRuntimeException

oracle.olapi.metadata.InvalidMetadataException

All Implemented Interfaces:

java.io.Serializable, HasLocalizedMessage

public class InvalidMetadataException
extends OLAPIRuntimeException

Indicates that one or more metadata objects are invalid. To find out which objects are invalid, use the getInvalidObjectIds method, which returns a Set of String objects, each of which is the unique identifier of an invalid MetadataObject. You can use the getMetadataObjects method of an MdmMetadataProvider to retrieve the MetadataObject instances that have those IDs. You can then use the methods of this class to retrieve the error messages for each MetadataObject.

You can also retrieve InvalidMetadataObjectInfo objects for each object. An InvalidMetadataObjectInfo contains additional information about the error, such as the command that caused the error, and the error message prefix, and the error message number.

If the number of errors for the object exceeds the error limit, then the getErrorMessages might not return all of the messages for the object. In that case, the hasMoreErrors method returns true.

See Also:

Serialized Form

Method Summary

Modifier and Type	Method and Description
java.util.List	getErrorInfoList(MetadataObject object) Gets the InvalidMetadataObjectInfo objects for the specified MetadataObject.
java.util.List	getErrorInfoList(java.lang.String objectID) Gets the InvalidMetadataObjectInfo objects for the MetadataObject that has the specified unique String identifier.
java.util.List	getErrorMessages(MetadataObject object) Gets the error messages for the specified MetadataObject.
java.util.List	getErrorMessages(java.lang.String objectID) Gets the error messages for the MetadataObject that has the specified unique String identifier.
java.util.Set	getInvalidObjectIds() Gets the unique String identifier for each invalid MetadataObject.
java.lang.String	getLocalizedMessage(java.util.Locale locale) Gets a message in the language specified by the java.util.Locale object.
boolean	hasMoreErrors() Indicates whether the number of error messages generated for the invalid MetadataObject objects is greater than the limit of error messages that Oracle OLAP allows.

Methods inherited from class oracle.olapi.OLAPIRuntimeException

getLocalizedMessage, getParameters, toString

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInvalidObjectIds

public java.util.Set getInvalidObjectIds()

Gets the unique String identifier for each invalid MetadataObject.

Returns:

A Set that contains the IDs of the invalid MetadataObject objects.

getErrorInfoList

public java.util.List getErrorInfoList(java.lang.String objectID)

Gets the InvalidMetadataObjectInfo objects for the MetadataObject that has the specified unique String identifier.

Parameters:

objectID - A String that contains the identifier for the MetadataObject.

Returns:

A List that contains the InvalidMetadataObjectInfo objects for the MetadataObject with the specified ID.

getErrorInfoList

public java.util.List getErrorInfoList(MetadataObject object)

Gets the InvalidMetadataObjectInfo objects for the specified MetadataObject.

Parameters:

object - The MetadataObject for which to retrieve InvalidMetadataObjectInfo objects.

Returns:

A List that contains the InvalidMetadataObjectInfo objects for the specified MetadataObject.

getErrorMessages

public java.util.List getErrorMessages(java.lang.String objectID)

Gets the error messages for the MetadataObject that has the specified unique String identifier.

Parameters:

objectID - A String that contains the identifier for the MetadataObject.

Returns:

A List that contains the error messages for the MetadataObject with the specified ID.

getErrorMessages

public java.util.List getErrorMessages(MetadataObject object)

Gets the error messages for the specified MetadataObject.

Parameters:

object - The MetadataObject for which to retrieve error messages.

Returns:

A List that contains the error messages for the specified MetadataObject.

hasMoreErrors

public boolean hasMoreErrors()

Indicates whether the number of error messages generated for the invalid MetadataObject objects is greater than the limit of error messages that Oracle OLAP allows. If this method returns true, then the lists returned by the methods of this class might not have all of the error messages.

Returns:

A boolean that is true if the number of error messages exceeds the limit and false otherwise.

getLocalizedMessage

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

Gets a message in the language specified by the java.util.Locale object.

Specified by:

getLocalizedMessage in interface HasLocalizedMessage

Overrides:

getLocalizedMessage in class OLAPIRuntimeException

Parameters:

locale - The Locale object that specifies the language for the message.

Returns:

A String that has the message in the specified language.