oracle.ifs.beans

Class ActionSpecificationDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.ActionSpecificationDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ActionSpecificationDefinition
extends SystemObjectDefinition

A ActionSpecificationDefinition is used to create or modify a ActionSpecification instance.

Author:

Dave Long

See Also:

Serialized Form

(Unpublished)

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
ActionSpecificationDefinition(LibrarySessionInterface session) Construct a definition explicitly capturing the session.
ActionSpecificationDefinition(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.
ActionSpecification	getSuperActionSpecification() Gets the SuperActionSpecification, if explicitly set.
void	setSuperActionSpecification(ActionSpecification spec) Sets the SuperActionSpecification.
static ActionSpecificationDefinition	toActionSpecificationDefinition(LibraryObjectDefinition lodef) Cast specified LibraryObjectDefinition to a ActionSpecificationDefinition.
static ActionSpecificationDefinition	toActionSpecificationDefinition(LibraryObjectDefinition lodef, boolean enforceCompat) Cast specified LibraryObjectDefinition to a ActionSpecificationDefinition.

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

ActionSpecificationDefinition

public ActionSpecificationDefinition(LibrarySessionInterface session)
                              throws IfsException

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

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

ActionSpecificationDefinition

public ActionSpecificationDefinition(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 SystemObjectDefinition

Parameters:

avt - the definition table

Throws:

IfsException - if the operation fails

(Published)

getSuperActionSpecification

public ActionSpecification getSuperActionSpecification()
                                                throws IfsException

Gets the SuperActionSpecification, if explicitly set.

Returns:

the SuperActionSpecification setting, or null if not set

Throws:

IfsException - if operation fails

setSuperActionSpecification

public void setSuperActionSpecification(ActionSpecification spec)
                                 throws IfsException

Sets the SuperActionSpecification.

Parameters:

spec - the SuperActionSpecification setting

Throws:

IfsException - if operation fails

toActionSpecificationDefinition

public static ActionSpecificationDefinition toActionSpecificationDefinition(LibraryObjectDefinition lodef)
                                                                     throws IfsException

Cast specified LibraryObjectDefinition to a ActionSpecificationDefinition.

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

Parameters:

lodef - the definition to be casted

Returns:

a ActionSpecificationDefinition casted from the specified definition

Throws:

IfsException - is not currently thrown.

(Unpublished)

toActionSpecificationDefinition

public static ActionSpecificationDefinition toActionSpecificationDefinition(LibraryObjectDefinition lodef,
                                                                            boolean enforceCompat)
                                                                     throws IfsException

Cast specified LibraryObjectDefinition to a ActionSpecificationDefinition.

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

Parameters:

lodef - the definition to be casted

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

Returns:

a ActionSpecificationDefinition casted from the specified definition

Throws:

IfsException - (IFS-10822) if operation fails.

(Unpublished)