oracle.ifs.beans

Class ValueDomainDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SchemaObjectDefinition

oracle.ifs.beans.ValueDomainDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ValueDomainDefinition
extends SchemaObjectDefinition

The ValueDomainDefinition class is used to construct a ValueDomain object. This subclass of SchemaObjectDefinition only sets the default ClassObject to "VALUEDOMAIN". All other behavior is inherited.

Version:

1.0

Author:

David Pitfield

See Also:

ValueDomain, 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.SchemaObjectDefinition

m_CategoryDefs

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
ValueDomainDefinition() OBSOLETE: Construct a definition explicitly capturing the session.
ValueDomainDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ValueDomainDefinition(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	applySettings(AttributeValueTable avt) Applies settings from the specified table.
ValueDomainPropertyBundleDefinition	getValueDomainPropertyBundleDefinition() Gets the ValueDomainPropertyBundleDefinition for this instance.
void	setValueDomainPropertyBundleDefinition(ValueDomainPropertyBundleDefinition def) Sets the ValueDomainPropertyBundleDefinition for this instance.
static ValueDomainDefinition	toValueDomainDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a ValueDomainDefinition.
static ValueDomainDefinition	toValueDomainDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a ValueDomainDefinition.

Methods inherited from class oracle.ifs.beans.SchemaObjectDefinition

addCategoryDefinition, addCategoryDefinitions, getCategoryDefinitions, removeCategoryDefinitions, setCategoryDefinitions, toSchemaObjectDefinition, toSchemaObjectDefinition

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

ValueDomainDefinition

public ValueDomainDefinition()
                      throws IfsException

OBSOLETE: Construct a definition explicitly capturing the session. The initial ClassObject will be ValueDomain.

Throws:

IfsException - if the operation fails

(Unpublished)

ValueDomainDefinition

public ValueDomainDefinition(LibrarySessionInterface session)
                      throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ValueDomainDefinition

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

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class SchemaObjectDefinition

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

setValueDomainPropertyBundleDefinition

public void setValueDomainPropertyBundleDefinition(ValueDomainPropertyBundleDefinition def)
                                            throws IfsException

Sets the ValueDomainPropertyBundleDefinition for this instance.

Parameters:

def - the ValueDomainPropertyBundleDefinition

Throws:

IfsException - if operation fails.

(Published)

getValueDomainPropertyBundleDefinition

public ValueDomainPropertyBundleDefinition getValueDomainPropertyBundleDefinition()
                                                                           throws IfsException

Gets the ValueDomainPropertyBundleDefinition for this instance.

Returns:

the ValueDomainPropertyBundleDefinition object

Throws:

IfsException - if the operation fails

(Published)

toValueDomainDefinition

public static ValueDomainDefinition toValueDomainDefinition(LibraryObjectDefinition lodef)
                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a ValueDomainDefinition.

Returns null if the specified definition is not a ValueDomainDefinition, 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

toValueDomainDefinition

public static ValueDomainDefinition toValueDomainDefinition(LibraryObjectDefinition lodef,
                                                            boolean enforce)
                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a ValueDomainDefinition.

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 ValueDomainDefinition.

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