oracle.ifs.protocols.email.beans

Class Rfc822MessageDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.DocumentDefinition

oracle.ifs.protocols.email.beans.Rfc822MessageDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class Rfc822MessageDefinition
extends DocumentDefinition

The Rfc822MessageDefinition class is used construct a Rfc822Message object.

Version:

1.0

Author:

Scott Harrison

See Also:

Serialized Form

(Unpublished)

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields inherited from class oracle.ifs.beans.LibraryObjectDefinition

m_Attributes, m_ClassObjectName, m_ClassObjectValue, m_ContentSpecifications, m_DefinitionLists, m_Definitions, m_EnclosedDefinition, m_Id, m_Options, m_ReadOnly, m_ReferenceAttributes, m_Session, m_SystemOptions

Constructor Summary

Constructors

Constructor and Description
Rfc822MessageDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
Rfc822MessageDefinition(LibrarySessionInterface session, String className) Construct a definition, explicitly capturing the session and setting the initial classobject.

Method Summary

Modifier and Type	Method and Description
void	createBodyPartReferenceAttribute() Turns the body part tree into a serialized object This should be called immediatly before calling createPublicObject with this definition.
BodyPart	getBodyPart() Gets the root body part.
void	setContentObjectDefinition(ContentObjectDefinition cod) Sets the ContentObjectDefinition of the document that will be used to create/update the content object associated with this document.
void	setContentStream(InputStream is) Sets the content InputStream from which the document will be loaded/created.
void	setRootBodyPart(BodyPart rbp) Sets the root body part.
void	setSpamFlags(Dictionary spamFlagTbl) Sets the Spam Flags attribute This is a convinience function to translate from a Dictionary to a String Array.

Methods inherited from class oracle.ifs.beans.DocumentDefinition

applySettings, getCharacterSet, getContent, getContentObjectDefinition, getContentPath, getContentReader, getContentStream, getEncrypted, getFormat, getLanguage, getMedia, getNextLifecyclePolicyEntryValue, getOrCreateContentObjectDefinition, getReferringLibraryObject, getReferringLibraryObjectValue, getSharedContentObject, getSharedContentObjectValue, isContentSpecified, prepareForDefinitionObject, removeContentSpecifications, setCharacterSet, setContent, setContentBfileReference, setContentPath, setContentReader, setEmptyContent, setEncrypted, setFormat, setLanguage, setMedia, setNextLifecyclePolicyEntryValue, setNullContent, setSharedContentObject, setSharedContentObjectValue, toDocumentDefinition, toDocumentDefinition

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, getAddToFolderOption, getAddToFolderValue, getAutoFolderingActionSpecification, getCascadeCopyRelationshipsOption, getCascadeCopyRelationshipsOptionValue, getCategoryCopyOption, getCategoryDefinitions, getContentQuotaCopyOption, getCreateCategoriesServerSideOption, getExplicitCreateAndModifyAttributesOption, getExplicitCreateDate, getExplicitLastModifyDate, getFreeIfLastFolderReferenceOption, getKeepLastModifierOption, getKeepLastModifyDateOption, getLockEntryDefinition, getLockObject, getLockObjectDefinition, getLockObjectValue, getSecuringPublicObject, getSecuringPublicObjectValue, getUpdatedLockObjectDefinition, removeCategoryDefinitions, removeLockEntryDefinition, resolveAutoFolderingSettings, setAddToFolderOption, setAddToFolderValue, setAutoFolderingActionSpecification, setAutoFolderingActionSpecification, setCascadeCopyRelationshipsOption, setCategoryCopyOption, setCategoryDefinitions, setContentQuotaCopyOption, setCreateCategoriesServerSideOption, setExplicitCreateAndModifyAttributesOption, setExplicitCreateDate, setExplicitLastModifyDate, setFreeIfLastFolderReferenceOption, setKeepLastModifierOption, setKeepLastModifyDateOption, setLockEntryDefinition, setLockObject, setLockObjectDefinition, setLockObjectValue, setNullSecurity, setPrivateSecurity, setPublishedSecurity, setSecuringPublicObject, setSecuringPublicObjectValue, setUpdatedLockObjectDefinition, toPublicObjectDefinition, toPublicObjectDefinition

Methods inherited from class oracle.ifs.beans.LibraryObjectDefinition

addDefinition, addDefinitions, addProperty, addPropertyDefinition, addPropertyDefinition, addPropertyDefinitions, addPropertyDefinitions, addSimplePropertyDefinition, addSimplePropertyDefinition, addSimplePropertyDefinitions, addSimplePropertyDefinitions, applyEnumSetting, applyEnumSetting, applyMapSetting, applyMapSetting, applyObjectArraySetting, applyObjectArraySetting, applyObjectSetting, applyObjectSetting, applySetting, applySetting, captureSession, captureSession, captureSession, clone, constructInstance, constructInstance, constructInstance, copyInto, deriveObjectArraySetting, deriveObjectSetting, getAttribute, getAttribute, getAttributes, getAttributes, getAttributesSorted, getClassId, getClassObject, getClassObjectValue, getContentSpecification, getContentSpecificationKeys, getCopiedObjectValue, getDefinition, getDefinitionClassName, getDefinitionKeys, getDefinitionListKeys, getDefinitions, getId, getLibrarySession, getName, getOption, getOptionAsAttributeValue, getOptionKeys, getPolicyMode, getPropertyDefinitions, getReferenceAttribute, getReferenceAttributes, getServerDefinition, getSession, getSimplePropertyDefinitions, getSLibrarySession, getStringAttribute, getSystemOption, getSystemOptionAsAttributeValue, getSystemOptionAsBoolean, getSystemOptionKeys, getWriteableInstance, isReadOnly, processSimplePropertiesForCreate, processSimplePropertiesForUpdate, removeAttribute, removeContentSpecification, removeDefinition, removeDefinitions, removeOption, removePropertyDefinitions, removeReferenceAttribute, removeSimplePropertyDefinitions, removeSystemOption, reset, resolve, setAttribute, setAttribute, setAttribute, setAttributeByUpperCaseName, setAttributeByUpperCaseName, setAttributePolicyMode, setAttributes, setClassId, setClassname, setClassObject, setClassObjectValue, setContentSpecification, setCopiedObjectValue, setDefinition, setDefinitions, setId, setName, setOption, setReadOnly, setReferenceAttribute, setReferenceAttribute, setSession, setSimplePropertyDefinitions, setSystemOption, unresolve, verifySession

Methods inherited from class java.lang.Object

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

Constructor Detail

Rfc822MessageDefinition

public Rfc822MessageDefinition(LibrarySessionInterface session)
                        throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be Rfc822Message.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

Rfc822MessageDefinition

public Rfc822MessageDefinition(LibrarySessionInterface session,
                               String className)
                        throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

setSpamFlags

public void setSpamFlags(Dictionary spamFlagTbl)
                  throws IfsException

Sets the Spam Flags attribute This is a convinience function to translate from a Dictionary to a String Array.

Parameters:

spamFlagTbl -

Throws:

IfsException

(Published)

setRootBodyPart

public void setRootBodyPart(BodyPart rbp)

Sets the root body part. This is the body part that contains the entire message.

Parameters:

rbp - root body part

(Published)

getBodyPart

public BodyPart getBodyPart()

Gets the root body part. This is the body part that contains the entire message.

Returns:

root body part

(Published)

createBodyPartReferenceAttribute

public void createBodyPartReferenceAttribute()
                                      throws IfsException

Turns the body part tree into a serialized object This should be called immediatly before calling createPublicObject with this definition.

Throws:

IfsException

(Published)

setContentStream

public void setContentStream(InputStream is)
                      throws IfsException

Description copied from class: DocumentDefinition

Sets the content InputStream from which the document will be loaded/created. This is a convenience method that allocates a ContentObjectDefinition (if one is not already allocated) and calls the liked named method on it.

Overrides:

setContentStream in class DocumentDefinition

Parameters:

is - an InputStream from which content will be loaded/created.

Throws:

IfsException - if operation fails.

setContentObjectDefinition

public void setContentObjectDefinition(ContentObjectDefinition cod)
                                throws IfsException

Description copied from class: DocumentDefinition

Sets the ContentObjectDefinition of the document that will be used to create/update the content object associated with this document. Most content convenience methods on DocumentDefinition will allocate a ContentObjectDefinition. Calling this method will replace any previously allocated definition.

Overrides:

setContentObjectDefinition in class DocumentDefinition

Parameters:

cod - a ContentObjectDefinition which contains the content to be loaded into the new document.

Throws:

IfsException - if operation fails.