oracle.ifs.beans

Class SimplePropertyTableDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SimpleObjectDefinition

oracle.ifs.beans.SimplePropertyTableDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class SimplePropertyTableDefinition
extends SimpleObjectDefinition

A SimplePropertyTableDefinition is used to create or modify a SimplePropertyTable instance.

Author:

Dave Long

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class oracle.ifs.beans.LibraryObjectDefinition

LibraryObjectDefinition.EnumToIntegerCode, LibraryObjectDefinition.LookupByName

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTIES_ATTRIBUTE

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
SimplePropertyTableDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
SimplePropertyTableDefinition(LibrarySessionInterface session, String className) Constructs a definition explicitly capturing the session, and property the initial ClassObject.

Method Summary

Modifier and Type	Method and Description
void	addSimplePropertyDefinition(AttributeValueTable prop) Adds a new SimplePropertyDefinition for a SimpleProperty specified in a table.
void	addSimplePropertyDefinition(SimplePropertyDefinition def) Adds a new SimplePropertyDefinition for a SimpleProperty.
void	addSimplePropertyDefinitions(List<AttributeValueTable> propsList) Adds a set of new SimplePropertyDefinitions for multiple SimpleProperties specified in a table list
void	addSimplePropertyDefinitions(SimplePropertyDefinition[] defs) Adds a set of new SimplePropertyDefinitions for multiple SimpleProperties.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
SimplePropertyDefinition[]	getSimplePropertyDefinitions() Gets all the SimplePropertyDefinition SimpleProperties for this instance.
void	removeSimplePropertyDefinitions() Removes all SimplePropertyDefinition SimpleProperties from this instance.
void	setSimplePropertyDefinitions(SimplePropertyDefinition[] defs) Replaces the set of new SimplePropertyDefinitions for multiple SimpleProperties.
static SimplePropertyTableDefinition	toSimplePropertyTableDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a SimplePropertyTableDefinition.
static SimplePropertyTableDefinition	toSimplePropertyTableDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a SimplePropertyTableDefinition.

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

Field Detail

PROPERTIES_ATTRIBUTE

public static final String PROPERTIES_ATTRIBUTE

See Also:

Constant Field Values

Constructor Detail

SimplePropertyTableDefinition

public SimplePropertyTableDefinition(LibrarySessionInterface session)
                              throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be SimplePropertyTable.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

SimplePropertyTableDefinition

public SimplePropertyTableDefinition(LibrarySessionInterface session,
                                     String className)
                              throws IfsException

Constructs a definition explicitly capturing the session, and property 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 definition table

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyDefinition

public void addSimplePropertyDefinition(SimplePropertyDefinition def)
                                 throws IfsException

Adds a new SimplePropertyDefinition for a SimpleProperty.

Parameters:

def - the definition for the SimpleProperty

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyDefinitions

public void addSimplePropertyDefinitions(SimplePropertyDefinition[] defs)
                                  throws IfsException

Adds a set of new SimplePropertyDefinitions for multiple SimpleProperties.

Parameters:

defs - the definitions for the SimpleProperties

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyDefinition

public void addSimplePropertyDefinition(AttributeValueTable prop)
                                 throws IfsException

Adds a new SimplePropertyDefinition for a SimpleProperty specified in a table.

Parameters:

prop - the Property table

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyDefinitions

public void addSimplePropertyDefinitions(List<AttributeValueTable> propsList)
                                  throws IfsException

Adds a set of new SimplePropertyDefinitions for multiple SimpleProperties specified in a table list

Parameters:

propsList - the SimpleProperties table list

Throws:

IfsException - if the operation fails

(Published)

setSimplePropertyDefinitions

public void setSimplePropertyDefinitions(SimplePropertyDefinition[] defs)
                                  throws IfsException

Replaces the set of new SimplePropertyDefinitions for multiple SimpleProperties.

Parameters:

defs - the definitions for the SimpleProperties

Throws:

IfsException - if the operation fails

(Published)

removeSimplePropertyDefinitions

public void removeSimplePropertyDefinitions()
                                     throws IfsException

Removes all SimplePropertyDefinition SimpleProperties from this instance.

Throws:

IfsException - if the operation fails

(Published)

getSimplePropertyDefinitions

public SimplePropertyDefinition[] getSimplePropertyDefinitions()
                                                        throws IfsException

Gets all the SimplePropertyDefinition SimpleProperties for this instance.

Returns:

the definitions for the SimpleProperties

Throws:

IfsException - if the operation fails

(Published)

toSimplePropertyTableDefinition

public static SimplePropertyTableDefinition toSimplePropertyTableDefinition(LibraryObjectDefinition lodef)
                                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyTableDefinition.

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

toSimplePropertyTableDefinition

public static SimplePropertyTableDefinition toSimplePropertyTableDefinition(LibraryObjectDefinition lodef,
                                                                            boolean enforce)
                                                                     throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyTableDefinition.

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

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