com.crystaldecisions.sdk.plugin.desktop.event
Interface IFileEventBase

All Known Subinterfaces:

IFileEvent

public interface IFileEventBase

This interface allows you to manage the conditions for a file event to occur. With this object you can set the path and name of the file to watch for as well as the name of the event server that will be watching for this event.

Since:

4.0

Field Summary

static java.lang.String	ROOTFOLDER_CUID The CUID for this object type's root folder.
static java.lang.String	SPECIFIC_KIND The specific kind used to identify this object type.
static java.lang.String	SPECIFIC_PROGID The specific progID used to identify this object type.

Method Summary

java.util.List	getDefaultAlertMessages() Returns the collection of alert messages that are sent to subscribers of a triggered event.
java.lang.String	getFileName() Returns the path and name of the file for the event to watch.
java.lang.String	getServerFriendlyName() Returns the event server that monitors the event.
void	setFileName(java.lang.String newFileName) Sets the path and name of the file for the event to watch.
void	setServerFriendlyName(java.lang.String newServerFriendlyName) Sets the event server that monitors the event.

Field Detail

SPECIFIC_KIND

static final java.lang.String SPECIFIC_KIND

The specific kind used to identify this object type.

See Also:

Constant Field Values

SPECIFIC_PROGID

static final java.lang.String SPECIFIC_PROGID

The specific progID used to identify this object type.

See Also:

Constant Field Values

ROOTFOLDER_CUID

static final java.lang.String ROOTFOLDER_CUID

The CUID for this object type's root folder. All objects of this type must be stored under this folder.

See Also:

Constant Field Values

Method Detail

getFileName

java.lang.String getFileName()

Returns the path and name of the file for the event to watch.

Returns:

A String containing the path and name of the file for the event to watch.

See Also:

IFileEventBase.setFileName(java.lang.String)

setFileName

void setFileName(java.lang.String newFileName)

Sets the path and name of the file for the event to watch.

Parameters:

newFileName - A String containing the path and name of the file for the event to watch.

See Also:

IFileEventBase.getFileName()

getServerFriendlyName

java.lang.String getServerFriendlyName()

Returns the event server that monitors the event.

Returns:

A String containing the event server that monitors the event.

See Also:

IFileEventBase.setServerFriendlyName(java.lang.String)

setServerFriendlyName

void setServerFriendlyName(java.lang.String newServerFriendlyName)

Sets the event server that monitors the event.

Parameters:

newServerFriendlyName - A String containing the event server that monitors the event.

See Also:

IFileEventBase.getServerFriendlyName()

getDefaultAlertMessages

java.util.List getDefaultAlertMessages()

Returns the collection of alert messages that are sent to subscribers of a triggered event. Alert messages can be set before the event is triggered or at the time the event is triggered. Alert messages do not have to be unique.

Returns:

A List object that contains alert messages stored as String objects.

Since:

4.0

InfoObject properties to query for:

SI_DEFAULT_ALERT_MESSAGES