oracle.ifs.beans

Class MessageListDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.PublicObjectDefinition

oracle.ifs.beans.CategoryDefinition

oracle.ifs.beans.MessageListDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class MessageListDefinition
extends CategoryDefinition

A MessageListDefinition is used to define or update MessageList 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
MessageListDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
MessageListDefinition(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
void	addMessageEntryDefinition(MessageEntryDefinition def) Adds a new MessageEntry Definition.
void	addMessageEntryDefinitions(MessageEntryDefinition[] defs) Adds a set of new MessageEntry Definitions.
MessageEntryDefinition[]	getMessageEntryDefinitions() Returns all the MessageEntry Definitions defined on this instance.
void	removeMessageEntryDefinitions() Removes all MessageEntry Definition specifications from this instance.
void	setMessageEntryDefinitions(MessageEntryDefinition[] defs) Defines a set of new MessageEntry Definitions.
static MessageListDefinition	toMessageListDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a MessageListDefinition.
static MessageListDefinition	toMessageListDefinition(LibraryObjectDefinition lodef, boolean enforce) Cast specified LibraryObjectDefinition to a MessageListDefinition.

Methods inherited from class oracle.ifs.beans.CategoryDefinition

getUpdateAssociatedObjectOption, setUpdateAssociatedObjectOption, toCategoryDefinition, toCategoryDefinition

Methods inherited from class oracle.ifs.beans.PublicObjectDefinition

addCategoryDefinition, addCategoryDefinition, addCategoryDefinitions, addCategoryDefinitions, applySettings, 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, prepareForDefinitionObject, 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

MessageListDefinition

public MessageListDefinition(LibrarySessionInterface session)
                      throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be MessageList.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

MessageListDefinition

public MessageListDefinition(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

addMessageEntryDefinition

public void addMessageEntryDefinition(MessageEntryDefinition def)
                               throws IfsException

Adds a new MessageEntry Definition.

Parameters:

def - the MessageEntry definition

Throws:

IfsException - if the operation fails

addMessageEntryDefinitions

public void addMessageEntryDefinitions(MessageEntryDefinition[] defs)
                                throws IfsException

Adds a set of new MessageEntry Definitions.

Parameters:

defs - the MessageEntry definitions

Throws:

IfsException - if the operation fails

setMessageEntryDefinitions

public void setMessageEntryDefinitions(MessageEntryDefinition[] defs)
                                throws IfsException

Defines a set of new MessageEntry Definitions.

Parameters:

defs - the MessageEntry definitions

Throws:

IfsException - if the operation fails

removeMessageEntryDefinitions

public void removeMessageEntryDefinitions()
                                   throws IfsException

Removes all MessageEntry Definition specifications from this instance.

Throws:

IfsException - if the operation fails

getMessageEntryDefinitions

public MessageEntryDefinition[] getMessageEntryDefinitions()
                                                    throws IfsException

Returns all the MessageEntry Definitions defined on this instance.

Return null if no MessageEntry definitions are defined.

Returns:

MessageEntry Definitions for this instance

Throws:

IfsException - if the operation fails

toMessageListDefinition

public static MessageListDefinition toMessageListDefinition(LibraryObjectDefinition lodef)
                                                     throws IfsException

Cast specified LibraryObjectDefinition to a MessageListDefinition.

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

Parameters:

lodef - the definition to be cast

Returns:

a MessageListDefinition cast from the specified definition

Throws:

IfsException - if the operation fails

toMessageListDefinition

public static MessageListDefinition toMessageListDefinition(LibraryObjectDefinition lodef,
                                                            boolean enforce)
                                                     throws IfsException

Cast specified LibraryObjectDefinition to a MessageListDefinition.

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 MessageListDefinition cast from the specified definition

Throws:

IfsException - if the operation fails (throws 10822)