oracle.ifs.core.beans

Class HandlerStateDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.beans.RuntimeStateDefinition

oracle.ifs.core.beans.HandlerStateDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class HandlerStateDefinition
extends RuntimeStateDefinition

A HandlerStateDefinition is used to create or modify a HandlerState instance.

Author:

Dave Long

See Also:

Serialized Form

(Published)

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

Method Summary

Modifier and Type	Method and Description
static HandlerStateDefinition	toHandlerStateDefinition(LibraryObjectDefinition lodef) Casts specified LibraryObjectDefinition to a HandlerStateDefinition.
static HandlerStateDefinition	toHandlerStateDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts specified LibraryObjectDefinition to a HandlerStateDefinition.

Methods inherited from class oracle.ifs.core.beans.RuntimeStateDefinition

toRuntimeStateDefinition, toRuntimeStateDefinition

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, applySettings, getCategoriesForDelete, getCategoryDefinitions, getCategoryDefinitionsForUpdate, getCreateCategoriesServerSideOption, removeCategoriesForDelete, removeCategoryDefinitions, removeCategoryDefinitionsForUpdate, setCategoryDefinitions, setCreateCategoriesServerSideOption, toSystemObjectDefinition, toSystemObjectDefinition

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

HandlerStateDefinition

public HandlerStateDefinition(LibrarySessionInterface session)
                       throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be HandlerState.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

HandlerStateDefinition

public HandlerStateDefinition(LibrarySessionInterface session,
                              String className)
                       throws IfsException

Constructs 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

Method Detail

toHandlerStateDefinition

public static HandlerStateDefinition toHandlerStateDefinition(LibraryObjectDefinition lodef)
                                                       throws IfsException

Casts specified LibraryObjectDefinition to a HandlerStateDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a HandlerStateDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown

toHandlerStateDefinition

public static HandlerStateDefinition toHandlerStateDefinition(LibraryObjectDefinition lodef,
                                                              boolean enforceCompat)
                                                       throws IfsException

Casts specified LibraryObjectDefinition to a HandlerStateDefinition.

Return null if the specified definition is null. If non-null and unable to cast, return null if enforceCompat is false but throw an IfsException if the specified definition is not a HandlerStateDefinition.

Parameters:

lodef - the definition to be casted

enforceCompat - whether to throw an exception if a non-null definition cannot be cast

Returns:

a HandlerStateDefinition casted from the specified definition

Throws:

IfsException - 10822: if operation fails