oracle.ifs.core.beans

Class ControllerStateDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.beans.RuntimeStateDefinition

oracle.ifs.core.beans.ControllerStateDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ControllerStateDefinition
extends RuntimeStateDefinition

A ControllerStateDefinition is used to create or modify a ControllerState instance.

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
ControllerStateDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
ControllerStateDefinition(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 ControllerStateDefinition	toControllerStateDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a ControllerStateDefinition.
static ControllerStateDefinition	toControllerStateDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a ControllerStateDefinition.

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

ControllerStateDefinition

public ControllerStateDefinition(LibrarySessionInterface session)
                          throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be ControllerState.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

ControllerStateDefinition

public ControllerStateDefinition(LibrarySessionInterface session,
                                 String className)
                          throws IfsException

Constructs a definition explicitly capturing the session, and setting the initial ClassObject.

Parameters:

session - the session context

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

toControllerStateDefinition

public static ControllerStateDefinition toControllerStateDefinition(LibraryObjectDefinition lodef)
                                                             throws IfsException

Casts the specified LibraryObjectDefinition to a ControllerStateDefinition.

Returns null if the specified definition is not a ControllerStateDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

a properly casted definition

Throws:

IfsException - if the operation fails

toControllerStateDefinition

public static ControllerStateDefinition toControllerStateDefinition(LibraryObjectDefinition lodef,
                                                                    boolean enforce)
                                                             throws IfsException

Casts the specified LibraryObjectDefinition to a ControllerStateDefinition.

Returns null if the specified definition is null. If non-null and unable to cast, returns null if enforceCompat is false but throws an IfsException if the specified definition is not an ControllerStateDefinition.

Parameters:

lodef - the definition to be casted

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

Returns:

a properly casted definition

Throws:

IfsException - if the operation fails