com.apelon.beans.dts.plugin.connection
Class VetoCloseDescriptor

java.lang.Object
  com.apelon.beans.dts.plugin.connection.VetoCloseDescriptor

public class VetoCloseDescriptor
extends Object

Contains the details that can be supplied with the veto against closing a connection. These details are used by the Application to determine whether to continue with the connection close.

For example, DTSEditor uses this information in the confirmation dialog to get user input about connection close.

Copyright: Copyright (c) 2004

Company: Apelon, Inc.

Since:

3.4.0

Version:

DTS 3.4.0

Author:

Abhay Sinha

Constructor Summary

VetoCloseDescriptor(Object source, String displayName, String message)
Creates the Veto details.

Method Summary

String	getDisplayName() Returns the display name for the UI Component or task
String	getMessage() Returns the short message describing why the Veto is required
Object	getSource() Gets the UI component or task requesting the Veto

Methods inherited from class java.lang.Object

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

Constructor Detail

VetoCloseDescriptor

public VetoCloseDescriptor(Object source,
                           String displayName,
                           String message)

Creates the Veto details.

Parameters:

source - The UI component or task requesting the Veto

displayName - The display name for the UI Component or task

message - Short message describing why the Veto is required

Method Detail

getSource

public Object getSource()

Gets the UI component or task requesting the Veto

Returns:

UI component or task

getDisplayName

public String getDisplayName()

Returns the display name for the UI Component or task

Returns:

String Display name

getMessage

public String getMessage()

Returns the short message describing why the Veto is required

Returns:

String Short message