oracle.ifs.core.beans

Class ServerSpecificationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.core.beans.ServerSpecificationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ServerSpecificationDefinition
extends SystemObjectDefinition

An ServerSpecificationDefinition is used to create or modify an ServerSpecification 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
ServerSpecificationDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
ServerSpecificationDefinition(LibrarySessionInterface session, String className) Constructs 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.
static ServerSpecificationDefinition	toServerSpecificationDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to an ServerSpecificationDefinition.
static ServerSpecificationDefinition	toServerSpecificationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Casts the specified LibraryObjectDefinition to an ServerSpecificationDefinition.

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, 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

ServerSpecificationDefinition

public ServerSpecificationDefinition(LibrarySessionInterface session)
                              throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be ServerSpecification.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ServerSpecificationDefinition

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

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class SystemObjectDefinition

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

toServerSpecificationDefinition

public static ServerSpecificationDefinition toServerSpecificationDefinition(LibraryObjectDefinition lodef)
                                                                     throws IfsException

Casts the specified LibraryObjectDefinition to an ServerSpecificationDefinition.

Returns null if the specified definition is not an ServerSpecificationDefinition, or if the specified definition is null.

Parameters:

lodef - the definition to be casted

Returns:

an ServerSpecificationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

toServerSpecificationDefinition

public static ServerSpecificationDefinition toServerSpecificationDefinition(LibraryObjectDefinition lodef,
                                                                            boolean enforceCompat)
                                                                     throws IfsException

Casts the specified LibraryObjectDefinition to an ServerSpecificationDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a ServerSpecificationDefinition casted from the specified definition

Throws:

IfsException - 10822: if the operation fails.

(Unpublished)