oracle.ifs.beans

Class MessageEntryDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.DocumentDefinition

oracle.ifs.beans.MessageEntryDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class MessageEntryDefinition
extends DocumentDefinition

A MessageEntryDefinition is used to define or update MessageEntry instances.

Author:

Oskar Wetterstein

See Also:

Serialized Form

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
MessageEntryDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
MessageEntryDefinition(LibrarySessionInterface session, String className) Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Method Summary

Modifier and Type	Method and Description
MessageList	getMessageList() Gets the parent MessageList, if one is set on this instance.
String	getMessageText() Gets the message text, if a String has been set on this instance.
void	setMessageList(MessageList ml) Sets the parent MessageList.
void	setMessageText(String message) Sets the message text.
void	setReferencedMessageEntry(MessageEntry meRef) Sets the MessageEntry referenced by this instance, for example, to indicate a reply to another MessageEntry within the same MessageList.
static MessageEntryDefinition	toMessageEntryDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a MessageEntryDefinition.
static MessageEntryDefinition	toMessageEntryDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a MessageEntryDefinition.

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, setContentObjectDefinition, setContentPath, setContentReader, setContentStream, 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

MessageEntryDefinition

public MessageEntryDefinition(LibrarySessionInterface session)
                       throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be MessageEntry.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

MessageEntryDefinition

public MessageEntryDefinition(LibrarySessionInterface session,
                              String className)
                       throws IfsException

Construct a definition explicitly capturing the session and setting the initial ClassObject name.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

setMessageList

public void setMessageList(MessageList ml)
                    throws IfsException

Sets the parent MessageList.

Parameters:

ml - the MessageList setting

Throws:

IfsException - if operation fails

setMessageText

public void setMessageText(String message)
                    throws IfsException

Sets the message text.

Parameters:

message - the message text

Throws:

IfsException - if operation fails

setReferencedMessageEntry

public void setReferencedMessageEntry(MessageEntry meRef)
                               throws IfsException

Sets the MessageEntry referenced by this instance, for example, to indicate a reply to another MessageEntry within the same MessageList.

Parameters:

meRef - the referenced MessageEntry setting

Throws:

IfsException - if operation fails

getMessageList

public MessageList getMessageList()
                           throws IfsException

Gets the parent MessageList, if one is set on this instance.

Returns:

the MessageList setting, or null if not set

Throws:

IfsException - if operation fails

getMessageText

public String getMessageText()
                      throws IfsException

Gets the message text, if a String has been set on this instance.

Returns:

the message text, or null if no text is set

Throws:

IfsException - if operation fails

toMessageEntryDefinition

public static MessageEntryDefinition toMessageEntryDefinition(LibraryObjectDefinition lodef)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a MessageEntryDefinition.

Return null if the specified LibraryObjectDefinition is not a MessageEntryDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be cast

Returns:

a MessageEntryDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toMessageEntryDefinition

public static MessageEntryDefinition toMessageEntryDefinition(LibraryObjectDefinition lodef,
                                                              boolean enforce)
                                                       throws IfsException

Cast specified LibraryObjectDefinition to a MessageEntryDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw otherwise.

Parameters:

lodef - the definition to be cast

enforce - whether to throw an exception if cast fails

Returns:

a MessageEntryDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)