er.corebusinesslogic
Class ERCMailMessage

java.lang.Object
  com.webobjects.eocontrol.EOCustomObject
      com.webobjects.eocontrol.EOGenericRecord
          er.extensions.eof.ERXGenericRecord
              er.corebusinesslogic._ERCMailMessage
                  er.corebusinesslogic.ERCMailMessage

All Implemented Interfaces:

com.webobjects.eocontrol._EOPrivateMemento, com.webobjects.eocontrol.EODeferredFaulting, com.webobjects.eocontrol.EOEnterpriseObject, com.webobjects.eocontrol.EOFaulting, com.webobjects.eocontrol.EOKeyValueCoding, com.webobjects.eocontrol.EOKeyValueCoding._BestBindingCreation._ForwardingBindingCheck, com.webobjects.eocontrol.EOKeyValueCoding._KeyBindingCreation, com.webobjects.eocontrol.EOKeyValueCodingAdditions, com.webobjects.eocontrol.EORelationshipManipulation, com.webobjects.eocontrol.EOValidation, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation.Callback, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, ERXDatabaseContextDelegate.AutoBatchFaultingEnterpriseObject, ERXEnterpriseObject, ERXGeneratesPrimaryKeyInterface, ERXGuardedObjectInterface, ERXKey.ValueCoding, ERXNonNullObjectInterface, java.io.Serializable

Direct Known Subclasses:

_ERCMailMessageArchive

public class ERCMailMessage
extends _ERCMailMessage

See Also:

Serialized Form

Nested Class Summary

static class

ERCMailMessage.ERCMailMessageClazz Clazz object used to hold all clazz related methods.

Nested classes/interfaces inherited from class er.corebusinesslogic._ERCMailMessage

_ERCMailMessage._ERCMailMessageClazz, _ERCMailMessage.Key

Nested classes/interfaces inherited from class er.extensions.eof.ERXGenericRecord

ERXGenericRecord.ERXGenericRecordClazz<T extends com.webobjects.eocontrol.EOEnterpriseObject>, ERXGenericRecord.InverseRelationshipUpdater, ERXGenericRecord.LocalizedBinding, ERXGenericRecord.TouchingBinding

Nested classes/interfaces inherited from class com.webobjects.eocontrol.EOGenericRecord

com.webobjects.eocontrol.EOGenericRecord._DictionaryBinding, com.webobjects.eocontrol.EOGenericRecord._LazyDictionaryBinding

Nested classes/interfaces inherited from class com.webobjects.eocontrol.EOCustomObject

com.webobjects.eocontrol.EOCustomObject._BooleanFieldBinding, com.webobjects.eocontrol.EOCustomObject._FieldBinding, com.webobjects.eocontrol.EOCustomObject._LazyFieldBinding, com.webobjects.eocontrol.EOCustomObject._NumberFieldBinding

Nested classes/interfaces inherited from interface er.extensions.eof.ERXEnterpriseObject

ERXEnterpriseObject.Observer, ERXEnterpriseObject.Processor

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueCodingAdditions

com.webobjects.eocontrol.EOKeyValueCodingAdditions.DefaultImplementation, com.webobjects.eocontrol.EOKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.eocontrol.EOKeyValueCoding

com.webobjects.eocontrol.EOKeyValueCoding._BestBindingCreation, com.webobjects.eocontrol.EOKeyValueCoding._KeyBindingCreation, com.webobjects.eocontrol.EOKeyValueCoding._StoredForwardingBinding

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.ValidationException

Nested classes/interfaces inherited from interface com.webobjects.eocontrol._EOPrivateMemento

com.webobjects.eocontrol._EOPrivateMemento.DefaultImplementation

Field Summary

static java.lang.String	AddressSeparator holds the address separator
static org.apache.log4j.Logger	log logging support

Fields inherited from class er.corebusinesslogic._ERCMailMessage

ENTITY_NAME

Fields inherited from class er.extensions.eof.ERXGenericRecord

_primaryKey, _touchSource, insertionStackTrace

Fields inherited from class com.webobjects.eocontrol.EOGenericRecord

_CLASS

Fields inherited from interface er.extensions.eof.ERXEnterpriseObject

applyRestrictingQualifierOnInsert, DidDeleteProcessor, DidInsertProcessor, DidRevertProcessor, DidUpdateProcessor, FlushCachesProcessor, insertionTrackingLog, KEY_MARKER, logMod, tranLogDidDelete, tranLogDidInsert, tranLogDidRevert, tranLogDidUpdate, tranLogMightDelete, tranLogWillDelete, tranLogWillInsert, tranLogWillRevert, tranLogWillUpdate, validation, validationException, WillDeleteProcessor, WillInsertProcessor, WillRevertProcessor, WillUpdateProcessor

Fields inherited from interface com.webobjects.eocontrol.EOEnterpriseObject

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Constructor Summary

ERCMailMessage()
Public constructor.

Method Summary

void	addToBothSidesOfAttachments(ERCMessageAttachment attachement)
void	appendText(java.lang.String text) Appends test to the currently stored text.
ERCMailMessage	archive()
void	attachFileWithMimeType(java.lang.String filePath, java.lang.String mimeType)
com.webobjects.foundation.NSArray	bccAddressesAsArray()
com.webobjects.foundation.NSArray	ccAddressesAsArray()
boolean	hasAttachments() Simple test if an attachment has any attachments.
void	init(com.webobjects.eocontrol.EOEditingContext anEditingContext) Default state of the mail message is 'Ready To Be Sent'.
boolean	isExceptionState()
boolean	isReadAsBoolean()
boolean	isReadyToSendState()
boolean	isReceivedState()
boolean	isSentState()
java.lang.String	longDescription() Long description of the mail message.
static ERCMailMessage.ERCMailMessageClazz	mailMessageClazz() Gets the singleton clazz object for this Class.
void	markReadBy(com.webobjects.eocontrol.EOEnterpriseObject by)
void	setBccAddressesAsArray(com.webobjects.foundation.NSArray bccAddresses)
void	setCcAddressesAsArray(com.webobjects.foundation.NSArray ccAddresses)
void	setReadAsBoolean(boolean read) Deprecated. setIsRead
void	setText(java.lang.String aValue)
void	setToAddressesAsArray(com.webobjects.foundation.NSArray toAddresses)
boolean	shouldArchiveSentMailAsBoolean()
java.lang.String	storedGzippedValueForKey(java.lang.String key)
void	takeStoredGzippedValueForKey(java.lang.String aValue, java.lang.String key)
java.lang.String	text()
com.webobjects.foundation.NSArray	toAddressesAsArray()
java.lang.String	toLongString() Returns the super classes implementation of toString which prints out the current key-value pairs for all of the attributes and relationships for the current object.
java.lang.String	toString() Overrides the EOGenericRecord's implementation to provide a slightly less verbose output.
java.lang.Object	validateEmptyStringForKey(java.lang.Object value, java.lang.String field)
void	validateForSave() This method performs a few checks before invoking super's implementation.
java.lang.Object	validateFromAddress(java.lang.String newValue)
java.lang.Object	validateTitle(java.lang.String newValue)
java.lang.Object	validateToAddresses(java.lang.String newValue)

Methods inherited from class er.corebusinesslogic._ERCMailMessage

addToAttachments, attachments, bccAddresses, ccAddresses, contentGzipped, created, dateSent, exceptionReason, fromAddress, isRead, lastModified, plainText, plainTextCompressed, removeFromAttachments, replyToAddress, setBccAddresses, setCcAddresses, setContentGzipped, setCreated, setDateSent, setExceptionReason, setFromAddress, setIsRead, setLastModified, setPlainText, setPlainTextCompressed, setReplyToAddress, setShouldArchiveSentMail, setState, setTextCompressed, setTitle, setToAddresses, setXMailer, shouldArchiveSentMail, state, textCompressed, title, toAddresses, xMailer

Methods inherited from class er.extensions.eof.ERXGenericRecord

_otherStorageBinding, _setPrimaryKeyDictionary, _setUpdateInverseRelationships, _setValueForPrimaryKey, _updateInverseRelationships, _validateValueForKey, addObjectsToBothSidesOfRelationshipWithKey, addObjectToBothSidesOfRelationshipWithKey, applyRestrictingQualifierOnInsert, awakeFromClientUpdate, awakeFromFetch, awakeFromInsertion, batchCheckConsistency, batchFaultingRelationshipName, batchFaultingSourceGlobalID, batchFaultingTimeStamp, canDelete, canUpdate, changesFromCommittedSnapshot, checkConsistency, checkMatchingEditingContexts, clearProperties, committedSnapshot, committedSnapshotValueForKey, delete, description, didCopyFromChildInEditingContext, didDelete, didInsert, didRevert, didUpdate, encryptedPrimaryKey, entity, excludeObjectFromPropertyWithKey, flushCaches, foreignKeyForRelationshipWithKey, getClassLog, hasKeyChangedFromCommittedSnapshot, hasKeyChangedFromCommittedSnapshotFromValue, hasKeyChangedFromCommittedSnapshotFromValueToNewValue, hasKeyChangedFromCommittedSnapshotToValue, includeObjectIntoPropertyWithKey, isDeletedEO, isNewEO, isNewObject, isNonNull, isUpdatedObject, isValidatedWhenNested, localesForKey, localInstanceIn, localInstanceOf, localInstancesOf, localizationShouldFallbackToDefaultLanguage, mightDelete, parentObjectStoreIsObjectStoreCoordinator, permanentGlobalID, permanentGlobalID, primaryKey, primaryKeyAttributeNames, primaryKeyDictionary, primaryKeyInTransaction, rawPrimaryKey, rawPrimaryKeyInTransaction, refetchObjectFromDB, refetchObjectFromDBinEditingContext, removeObjectsFromBothSidesOfRelationshipWithKey, removeObjectsFromPropertyWithKey, self, setBatchFaultingTimestamp, setValidatedWhenNested, shouldTrimSpaces, takeStoredValueForKey, takeValueForKey, takeValueForKey, touchFromBatchFaultingSource, trimSpaces, updateFromSnapshot, validateForInsert, validateForUpdate, validateValueForKey, valueForKey, willDelete, willInsert, willReadRelationship, willRevert, willUpdate

Methods inherited from class com.webobjects.eocontrol.EOGenericRecord

__setClassDescription, _keyGetBindingForKey, _keySetBindingForKey, _storedKeyGetBindingForKey, _storedKeySetBindingForKey, classDescription, usesDeferredFaultCreation

Methods inherited from class com.webobjects.eocontrol.EOCustomObject

__classDescription, __clearPendingChanges, __editingContext, __globalID, __hasAuxillaryObservers, __hasPendingChanges, __hasPendingUpdate, __isInitialized, __isPendingDeletion, __isPendingInsertion, __isShared, __lastSnapshot, __originalSnapshot, __retainCount, __setAuxillaryObservers, __setEditingContext, __setGlobalID, __setInitialized, __setLastSnapshot, __setOriginalSnapshot, __setPendingDeletion, __setPendingInsertion, __setPendingUpdate, __setRetainCount, __setShared, _createKeyGetBindingForKey, _createKeySetBindingForKey, _createStoredKeyGetBindingForKey, _createStoredKeySetBindingForKey, _fieldKeyBinding, _forwardingBindingNeededForClass, _methodKeyGetBinding, _methodKeySetBinding, addObjectToPropertyWithKey, allPropertyKeys, attributeKeys, canAccessFieldsDirectly, changesFromSnapshot, classDescriptionForDestinationKey, clearFault, deleteRuleForRelationshipKey, editingContext, entityName, eoDescription, eoShallowDescription, equals, faultHandler, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hashCode, inverseForRelationshipKey, invokeRemoteMethod, isFault, isToManyKey, opaqueState, ownsDestinationObjectsForRelationshipKey, prepareValuesForClient, propagateDeleteWithEditingContext, readResolve, reapplyChangesFromDictionary, removeObjectFromBothSidesOfRelationshipWithKey, removeObjectFromPropertyWithKey, shouldUseStoredAccessors, snapshot, storedValueForKey, takeValueForKeyPath, takeValuesFromDictionary, takeValuesFromDictionaryWithMapping, toManyRelationshipKeys, toOneRelationshipKeys, turnIntoFault, unableToSetNullForKey, userPresentableDescription, validateClientUpdate, validateForDelete, validateTakeValueForKeyPath, valueForKey, valueForKeyPath, valuesForKeys, valuesForKeysWithMapping, willChange, willRead

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.webobjects.eocontrol.EOEnterpriseObject

allPropertyKeys, attributeKeys, changesFromSnapshot, classDescription, classDescriptionForDestinationKey, deleteRuleForRelationshipKey, editingContext, entityName, eoDescription, eoShallowDescription, inverseForRelationshipKey, invokeRemoteMethod, isToManyKey, opaqueState, ownsDestinationObjectsForRelationshipKey, prepareValuesForClient, propagateDeleteWithEditingContext, reapplyChangesFromDictionary, snapshot, toManyRelationshipKeys, toOneRelationshipKeys, userPresentableDescription, willChange

Methods inherited from interface com.webobjects.eocontrol.EOKeyValueCodingAdditions

takeValuesFromDictionary, takeValuesFromDictionaryWithMapping, valuesForKeys, valuesForKeysWithMapping

Methods inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

takeValueForKeyPath, valueForKeyPath

Methods inherited from interface com.webobjects.eocontrol.EOKeyValueCoding

storedValueForKey

Methods inherited from interface com.webobjects.foundation.NSKeyValueCoding

valueForKey

Methods inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

handleQueryWithUnboundKey, handleTakeValueForUnboundKey, unableToSetNullForKey

Methods inherited from interface com.webobjects.eocontrol.EORelationshipManipulation

addObjectToPropertyWithKey, removeObjectFromBothSidesOfRelationshipWithKey, removeObjectFromPropertyWithKey

Methods inherited from interface com.webobjects.eocontrol.EOValidation

validateClientUpdate, validateForDelete

Methods inherited from interface com.webobjects.foundation.NSValidation

validateTakeValueForKeyPath

Methods inherited from interface com.webobjects.eocontrol.EOFaulting

clearFault, faultHandler, isFault, turnIntoFault, willRead

Field Detail

log

public static final org.apache.log4j.Logger log

logging support

AddressSeparator

public static final java.lang.String AddressSeparator

holds the address separator

See Also:

Constant Field Values

Constructor Detail

ERCMailMessage

public ERCMailMessage()

Public constructor.

Method Detail

mailMessageClazz

public static ERCMailMessage.ERCMailMessageClazz mailMessageClazz()

Gets the singleton clazz object for this Class.

Returns:

sigleton clazz object

init

public void init(com.webobjects.eocontrol.EOEditingContext anEditingContext)

Default state of the mail message is 'Ready To Be Sent'.

Overrides:

init in class ERXGenericRecord

Parameters:

anEditingContext - inserted into

isReadyToSendState

public boolean isReadyToSendState()

isSentState

public boolean isSentState()

isExceptionState

public boolean isExceptionState()

isReceivedState

public boolean isReceivedState()

markReadBy

public void markReadBy(com.webobjects.eocontrol.EOEnterpriseObject by)

setReadAsBoolean

public void setReadAsBoolean(boolean read)

Deprecated. setIsRead

Use setIsRead(boolean)

isReadAsBoolean

public boolean isReadAsBoolean()

toAddressesAsArray

public com.webobjects.foundation.NSArray toAddressesAsArray()

setToAddressesAsArray

public void setToAddressesAsArray(com.webobjects.foundation.NSArray toAddresses)

ccAddressesAsArray

public com.webobjects.foundation.NSArray ccAddressesAsArray()

setCcAddressesAsArray

public void setCcAddressesAsArray(com.webobjects.foundation.NSArray ccAddresses)

bccAddressesAsArray

public com.webobjects.foundation.NSArray bccAddressesAsArray()

setBccAddressesAsArray

public void setBccAddressesAsArray(com.webobjects.foundation.NSArray bccAddresses)

shouldArchiveSentMailAsBoolean

public boolean shouldArchiveSentMailAsBoolean()

longDescription

public java.lang.String longDescription()

Long description of the mail message.

Returns:

very verbose description of the mail message.

toString

public java.lang.String toString()

Description copied from class: ERXGenericRecord

Overrides the EOGenericRecord's implementation to provide a slightly less verbose output. A typical output for an object mapped to the class com.foo.User with a primary key of 50 would look like: EOGenericRecord's implementation is preserved in the method toLongString. To restore the original verbose logging in your subclasses override this method and return toLongString.

Overrides:

toString in class ERXGenericRecord

Returns:

much less verbose description of an enterprise object.

toLongString

public java.lang.String toLongString()

Description copied from interface: ERXEnterpriseObject

Returns the super classes implementation of toString which prints out the current key-value pairs for all of the attributes and relationships for the current object. Very verbose.

Specified by:

toLongString in interface ERXEnterpriseObject

Overrides:

toLongString in class ERXGenericRecord

Returns:

super's implementation of toString.

archive

public ERCMailMessage archive()

appendText

public void appendText(java.lang.String text)

Appends test to the currently stored text. Useful for nested mime messages or multi-part messages.

Parameters:

text - to be appended

validateEmptyStringForKey

public java.lang.Object validateEmptyStringForKey(java.lang.Object value,
                                                  java.lang.String field)

hasAttachments

public boolean hasAttachments()

Simple test if an attachment has any attachments.

Returns:

if the the message has any attachments

validateFromAddress

public java.lang.Object validateFromAddress(java.lang.String newValue)

validateTitle

public java.lang.Object validateTitle(java.lang.String newValue)

validateToAddresses

public java.lang.Object validateToAddresses(java.lang.String newValue)

validateForSave

public void validateForSave()
                     throws com.webobjects.foundation.NSValidation.ValidationException

Description copied from class: ERXGenericRecord

This method performs a few checks before invoking super's implementation. If the property key: ERDebuggingEnabled is set to true then the method checkConsistency will be called on this object.

Specified by:

validateForSave in interface com.webobjects.eocontrol.EOValidation

Overrides:

validateForSave in class ERXGenericRecord

Throws:

NSValidation.ValidationException - if the object does not pass validation for saving to the database.

attachFileWithMimeType

public void attachFileWithMimeType(java.lang.String filePath,
                                   java.lang.String mimeType)

addToBothSidesOfAttachments

public void addToBothSidesOfAttachments(ERCMessageAttachment attachement)

storedGzippedValueForKey

public java.lang.String storedGzippedValueForKey(java.lang.String key)

takeStoredGzippedValueForKey

public void takeStoredGzippedValueForKey(java.lang.String aValue,
                                         java.lang.String key)

text

public java.lang.String text()

Overrides:

text in class _ERCMailMessage

setText

public void setText(java.lang.String aValue)

Overrides:

setText in class _ERCMailMessage