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

All Known Subinterfaces:

IEvent

public interface IEventBase

The IEvent interface provides properties to set the general information for all events, including, name. description, and type of event. You can also retrieve the specific event object (FileEvent, ScheduleEvent, UserEvent) based on the type of event set in the IEvent interface. For more information on Events see "Managing Events" in the BusinessObjects Enterprise Administrator's Guide.

Method Summary

java.lang.String	getDescription() Returns the description of the event.
java.lang.Object	getEventInterface() Returns the event interface.
java.lang.String	getEventName() Returns the name of the event.
int	getEventType() Returns the type of event.
void	setDescription(java.lang.String newDescription) Sets the description of the event.
void	setEventName(java.lang.String newEventName) Sets the name of the event.
void	setEventType(int newEventType) Sets the type of event.

Method Detail

getEventName

public java.lang.String getEventName()

Returns the name of the event.

Returns:

A String containing the name of the event.

setEventName

public void setEventName(java.lang.String newEventName)

Sets the name of the event.

Parameters:

newEventName - A String containing the name of the event.

getDescription

public java.lang.String getDescription()

Returns the description of the event.

Returns:

A String containing the description of the event.

setDescription

public void setDescription(java.lang.String newDescription)

Sets the description of the event.

Parameters:

newDescription - A String containing the description of the event.

getEventType

public int getEventType()

Returns the type of event.

Returns:

An int specifying the type of event.

setEventType

public void setEventType(int newEventType)

Sets the type of event.

Parameters:

newEventType - An int specifying the type of event.

getEventInterface

public java.lang.Object getEventInterface()
                                   throws SDKException

Returns the event interface. This interface allows modification of File, Schedule, and User event objects.

Returns:

An Object containing the event interface. This can be either an IFileEvent, IScheduleEvent, or IUserEvent.

Throws:

SDKException - This is thrown if the process is unsuccessful.

See Also:

IFileEvent, IScheduleEvent, IUserEvent