Package com.compuware.api.topaz.hostresources.zos

Class DataSetInUseException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.compuware.api.topaz.TopazAPIException

com.compuware.api.topaz.hostresources.HostResourceException

com.compuware.api.topaz.hostresources.zos.DataSetInUseException

All Implemented Interfaces:

Serializable

public class DataSetInUseException
extends HostResourceException

DataSetInUseException is a checked exception thrown when an attempt to perform an action on a dataset fails because it is in use.

Since:

1.0.0

Version:

2.0.0

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor	Description
DataSetInUseException(String message, String localizedMessage, String dataSetName, List<IEnqueueOwner> enqueueOwners)	Constructs a new dataset in use exception with the specified detail messages, dataset name, and enqueue owners.
DataSetInUseException(String message, String localizedMessage, Throwable cause, String dataSetName, List<IEnqueueOwner> enqueueOwners)	Constructs a new dataset in use exception with the specified detail messages, cause, dataset name, and enqueue owners.

Method Summary

Modifier and Type	Method	Description
List<IEnqueueOwner>	getEnqueueOwners()	Returns the list of owners that have an exclusive enqueue on the dataset.

Methods inherited from class com.compuware.api.topaz.hostresources.HostResourceException

getHostResourceName

Methods inherited from class com.compuware.api.topaz.TopazAPIException

getLocalizedMessage

Methods inherited from class java.lang.Throwable

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

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DataSetInUseException

public DataSetInUseException(String message,
                             String localizedMessage,
                             String dataSetName,
                             List<IEnqueueOwner> enqueueOwners)

Constructs a new dataset in use exception with the specified detail messages, dataset name, and enqueue owners. The cause is not initialized, and may subsequently be initialized by a call to Throwable.initCause(java.lang.Throwable).

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

dataSetName - the name of the dataset associated with this exception

enqueueOwners - the list of enqueue owners that are using the dataset

Since:

1.0.0

DataSetInUseException

public DataSetInUseException(String message,
                             String localizedMessage,
                             Throwable cause,
                             String dataSetName,
                             List<IEnqueueOwner> enqueueOwners)

Constructs a new dataset in use exception with the specified detail messages, cause, dataset name, and enqueue owners.

Note that the detail message associated with cause is not automatically incorporated in this exception's detail message.

Parameters:

message - the non-localized detail message (which is saved for later retrieval by the Throwable.getMessage() method).

localizedMessage - the localized description (which is saved for later retrieval by the TopazAPIException.getLocalizedMessage() method). (A null value is permitted, in which case getLocalizedMessage() will return the non-localized detail message.)

cause - the cause (which is saved for later retrieval by the Throwable.getCause() method). (A null value is permitted, and indicates that the cause is nonexistent or unknown.)

dataSetName - the name of the dataset associated with this exception

enqueueOwners - the list of enqueue owners that are using the dataset

Since:

1.0.0

Method Detail

getEnqueueOwners

public List<IEnqueueOwner> getEnqueueOwners()

Returns the list of owners that have an exclusive enqueue on the dataset.

Returns:

the enqueue owners

Since:

1.0.0