com.businessobjects.enterprise.smtp
Interface Smtp

All Superinterfaces:
InfoObject

public interface Smtp
extends InfoObject

The Smtp class allows you to manage the schedule options for an email location as well as retrieve the metrics for the destination plugin's InfoObject.


Nested Class Summary
static class Smtp.Factory
          A class with methods for creating instances of the Smtp type.
 
Field Summary
static org.apache.xmlbeans.SchemaType type
          Internal Use Only.
 
Method Summary
 CustomProperties addNewCustomProperties()
          Appends and returns a new empty CustomProperties object as the last element of the array.
 SMTPScheduleOptions addNewSMTPScheduleOptions()
          Appends and returns a new empty SMTPScheduleOptions object as the last element of the array.
 CustomProperties getCustomProperties()
          Returns the custom properties.
 SMTPScheduleOptions getSMTPScheduleOptions()
          Returns the schedule option interface.
 boolean isSetCustomProperties()
          Checks if the custom properties have been set.
 boolean isSetSMTPScheduleOptions()
          Checks if the schedule option interface has been set.
 void setCustomProperties(CustomProperties customProperties)
          Sets the custom properties.
 void setSMTPScheduleOptions(SMTPScheduleOptions smtpScheduleOptions)
          Sets the schedule option interface.
 void unsetCustomProperties()
          Deletes or unsets the CustomProperties element.
 void unsetSMTPScheduleOptions()
          Deletes or unsets the SMTPScheduleOptions element.
 
Methods inherited from interface com.businessobjects.enterprise.infoobject.InfoObject
addNewAlerts, addNewPluginInfo, addNewRolesOnObject, addNewSecurityInfo, addNewSecurityInfo2, addNewSharedDoc, addNewStatusInfo, getAlerts, getChildrenObjects, getCreationTime, getCUID, getDescription, getEndTime, getErrorMessage, getID, getInstance, getInstanceObject, getIsApplicationObject, getIsComponent, getIsHiddenObject, getIsPluginObject, getIsRecurring, getIsRunnableObject, getIsSendable, getIsSystemObject, getKey, getKeywords, getKind, getLastRunTime, getLastSuccessfulInstanceCUID, getName, getNewJobID, getNextRunTime, getObjectIsContainer, getOwner, getOwnerCUID, getParentCUID, getPluginInfo, getRolesOnObject, getRUID, getSchedulable, getSecurityInfo, getSecurityInfo2, getSharedDoc, getStartTime, getStatusInfo, getUiStatus, getUpdateTime, isSetAlerts, isSetChildrenObjects, isSetCreationTime, isSetCUID, isSetDescription, isSetEndTime, isSetErrorMessage, isSetID, isSetInstance, isSetInstanceObject, isSetIsApplicationObject, isSetIsComponent, isSetIsHiddenObject, isSetIsPluginObject, isSetIsRecurring, isSetIsRunnableObject, isSetIsSendable, isSetIsSystemObject, isSetKey, isSetKeywords, isSetKind, isSetLastRunTime, isSetLastSuccessfulInstanceCUID, isSetNewJobID, isSetNextRunTime, isSetObjectIsContainer, isSetOwner, isSetOwnerCUID, isSetParentCUID, isSetPluginInfo, isSetRolesOnObject, isSetRUID, isSetSchedulable, isSetSecurityInfo, isSetSecurityInfo2, isSetSharedDoc, isSetStartTime, isSetStatusInfo, isSetUiStatus, isSetUpdateTime, setAlerts, setChildrenObjects, setCreationTime, setCUID, setDescription, setEndTime, setErrorMessage, setID, setInstance, setInstanceObject, setIsApplicationObject, setIsComponent, setIsHiddenObject, setIsPluginObject, setIsRecurring, setIsRunnableObject, setIsSendable, setIsSystemObject, setKey, setKeywords, setKind, setLastRunTime, setLastSuccessfulInstanceCUID, setName, setNewJobID, setNextRunTime, setObjectIsContainer, setOwner, setOwnerCUID, setParentCUID, setPluginInfo, setRolesOnObject, setRUID, setSchedulable, setSecurityInfo, setSecurityInfo2, setSharedDoc, setStartTime, setStatusInfo, setUiStatus, setUpdateTime, unsetAlerts, unsetChildrenObjects, unsetCreationTime, unsetCUID, unsetDescription, unsetEndTime, unsetErrorMessage, unsetID, unsetInstance, unsetInstanceObject, unsetIsApplicationObject, unsetIsComponent, unsetIsHiddenObject, unsetIsPluginObject, unsetIsRecurring, unsetIsRunnableObject, unsetIsSendable, unsetIsSystemObject, unsetKey, unsetKeywords, unsetKind, unsetLastRunTime, unsetLastSuccessfulInstanceCUID, unsetNewJobID, unsetNextRunTime, unsetObjectIsContainer, unsetOwner, unsetOwnerCUID, unsetParentCUID, unsetPluginInfo, unsetRolesOnObject, unsetRUID, unsetSchedulable, unsetSecurityInfo, unsetSecurityInfo2, unsetSharedDoc, unsetStartTime, unsetStatusInfo, unsetUiStatus, unsetUpdateTime, xgetChildrenObjects, xgetCreationTime, xgetCUID, xgetDescription, xgetEndTime, xgetErrorMessage, xgetID, xgetInstance, xgetInstanceObject, xgetIsApplicationObject, xgetIsComponent, xgetIsHiddenObject, xgetIsPluginObject, xgetIsRecurring, xgetIsRunnableObject, xgetIsSendable, xgetIsSystemObject, xgetKey, xgetKeywords, xgetKind, xgetLastRunTime, xgetLastSuccessfulInstanceCUID, xgetName, xgetNewJobID, xgetNextRunTime, xgetObjectIsContainer, xgetOwner, xgetOwnerCUID, xgetParentCUID, xgetRUID, xgetSchedulable, xgetStartTime, xgetUiStatus, xgetUpdateTime, xsetChildrenObjects, xsetCreationTime, xsetCUID, xsetDescription, xsetEndTime, xsetErrorMessage, xsetID, xsetInstance, xsetInstanceObject, xsetIsApplicationObject, xsetIsComponent, xsetIsHiddenObject, xsetIsPluginObject, xsetIsRecurring, xsetIsRunnableObject, xsetIsSendable, xsetIsSystemObject, xsetKey, xsetKeywords, xsetKind, xsetLastRunTime, xsetLastSuccessfulInstanceCUID, xsetName, xsetNewJobID, xsetNextRunTime, xsetObjectIsContainer, xsetOwner, xsetOwnerCUID, xsetParentCUID, xsetRUID, xsetSchedulable, xsetStartTime, xsetUiStatus, xsetUpdateTime
 

Field Detail

type

static final org.apache.xmlbeans.SchemaType type
Internal Use Only.

Method Detail

getSMTPScheduleOptions

SMTPScheduleOptions getSMTPScheduleOptions()

Returns the schedule option interface.

Returns:
The schedule option interface.

isSetSMTPScheduleOptions

boolean isSetSMTPScheduleOptions()

Checks if the schedule option interface has been set.

Returns:
true if the schedule option interface has been set, and false otherwise.

setSMTPScheduleOptions

void setSMTPScheduleOptions(SMTPScheduleOptions smtpScheduleOptions)

Sets the schedule option interface.

Parameters:
smtpScheduleOptions - The schedule option interface.

addNewSMTPScheduleOptions

SMTPScheduleOptions addNewSMTPScheduleOptions()
Appends and returns a new empty SMTPScheduleOptions object as the last element of the array.

Returns:
A new SMTPScheduleOptions object.

unsetSMTPScheduleOptions

void unsetSMTPScheduleOptions()

Deletes or unsets the SMTPScheduleOptions element.


getCustomProperties

CustomProperties getCustomProperties()

Returns the custom properties.

Returns:
The custom properties.

isSetCustomProperties

boolean isSetCustomProperties()

Checks if the custom properties have been set.

Returns:
true if the custom properties have been set, and false otherwise.

setCustomProperties

void setCustomProperties(CustomProperties customProperties)

Sets the custom properties.

Parameters:
customProperties - The custom properties.

addNewCustomProperties

CustomProperties addNewCustomProperties()
Appends and returns a new empty CustomProperties object as the last element of the array.

Returns:
A new CustomProperties object.

unsetCustomProperties

void unsetCustomProperties()

Deletes or unsets the CustomProperties element.