oracle.ifs.core.beans

Class ControllerJobDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SimpleObjectDefinition

oracle.ifs.core.beans.ControllerJobDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class ControllerJobDefinition
extends SimpleObjectDefinition

A ControllerJobDefinition is used to create or modify a ControllerJob 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
ControllerJobDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
ControllerJobDefinition(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 ControllerJobDefinition	toControllerJobDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a ControllerJobDefinition.
static ControllerJobDefinition	toControllerJobDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a ControllerJobDefinition.

Methods inherited from class oracle.ifs.beans.SimpleObjectDefinition

toSimpleObjectDefinition, toSimpleObjectDefinition

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

ControllerJobDefinition

public ControllerJobDefinition(LibrarySessionInterface session)
                        throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be ControllerJob.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

ControllerJobDefinition

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

applySettings

public void applySettings(AttributeValueTable avt)
                   throws IfsException

Applies settings from the specified table.

Overrides:

applySettings in class LibraryObjectDefinition

Parameters:

avt - the table containing the settings

Throws:

IfsException - if the operation fails

(Published)

toControllerJobDefinition

public static ControllerJobDefinition toControllerJobDefinition(LibraryObjectDefinition lodef)
                                                         throws IfsException

Casts the specified LibraryObjectDefinition to a ControllerJobDefinition.

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

toControllerJobDefinition

public static ControllerJobDefinition toControllerJobDefinition(LibraryObjectDefinition lodef,
                                                                boolean enforce)
                                                         throws IfsException

Casts the specified LibraryObjectDefinition to a ControllerJobDefinition.

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

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