oracle.ifs.beans

Class SimplePropertyTableListDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SimpleObjectDefinition

oracle.ifs.beans.SimplePropertyTableListDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class SimplePropertyTableListDefinition
extends SimpleObjectDefinition

A SimplePropertyTableListDefinition is used to create or modify a SimplePropertyTableList 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 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
SimplePropertyTableListDefinition(LibrarySessionInterface session) Constructs a definition explicitly capturing the session.
SimplePropertyTableListDefinition(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	addDetailListDefinition(AttributeValueTable detailListTable) Adds a new detail list Definition.
void	addDetailListDefinition(SimplePropertyTableListDefinition def) Adds a new detail list.
void	addDetailListDefinitions(List<AttributeValueTable> detailListsList) Adds a set of new detail list Definitions for multiple detail lists.
void	addDetailListDefinitions(SimplePropertyTableListDefinition[] defs) Adds a set of new new detail list Definitions for multiple detail lists.
void	addSimplePropertyTableDefinition(AttributeValueTable propTable) Adds a new SimplePropertyTableDefinition for a SimplePropertyTable specified in a table.
void	addSimplePropertyTableDefinition(SimplePropertyTableDefinition def) Adds a new SimplePropertyTableDefinition for a SimplePropertyTable.
void	addSimplePropertyTableDefinitions(List<AttributeValueTable> propTablesList) Adds a set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables specified in a table list
void	addSimplePropertyTableDefinitions(SimplePropertyTableDefinition[] defs) Adds a set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables.
void	applySettings(AttributeValueTable avt) Applies settings from the specified table.
SimplePropertyTableListDefinition[]	getDetailListDefinitions() Gets all the detail list Definitions for this instance.
SimplePropertyTableDefinition	getObjectPropertyTableDefinition() Gets the SimplePropertyTable definition for the object property table.
SimplePropertyTableDefinition[]	getSimplePropertyTableDefinitions() Gets all the SimplePropertyTableDefinition SimplePropertyTables for this instance.
void	removeDetailListDefinitions() Removes all detail list Definitions from this instance.
void	removeSimplePropertyTableDefinitions() Removes all SimplePropertyTableDefinition SimplePropertyTables from this instance.
void	setDetailListDefinitions(SimplePropertyTableListDefinition[] defs) Replaces the set of new detail list Definitions.
void	setObjectPropertyTableDefinition(AttributeValueTable propTable) Sets the SimplePropertyTable definition for the object property table, expressed as an AttributeValueTable
void	setObjectPropertyTableDefinition(SimplePropertyTableDefinition def) Sets the SimplePropertyTable definition for the object property table.
void	setSimplePropertyTableDefinitions(SimplePropertyTableDefinition[] defs) Replaces the set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables.
static SimplePropertyTableListDefinition	toSimplePropertyTableListDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a SimplePropertyTableListDefinition.
static SimplePropertyTableListDefinition	toSimplePropertyTableListDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a SimplePropertyTableListDefinition.

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

SimplePropertyTableListDefinition

public SimplePropertyTableListDefinition(LibrarySessionInterface session)
                                  throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be SimplePropertyTableList.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

SimplePropertyTableListDefinition

public SimplePropertyTableListDefinition(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)

addSimplePropertyTableDefinition

public void addSimplePropertyTableDefinition(SimplePropertyTableDefinition def)
                                      throws IfsException

Adds a new SimplePropertyTableDefinition for a SimplePropertyTable.

Parameters:

def - the definition for the SimplePropertyTable

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyTableDefinition

public void addSimplePropertyTableDefinition(AttributeValueTable propTable)
                                      throws IfsException

Adds a new SimplePropertyTableDefinition for a SimplePropertyTable specified in a table.

Parameters:

propTable - the Property table

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyTableDefinitions

public void addSimplePropertyTableDefinitions(List<AttributeValueTable> propTablesList)
                                       throws IfsException

Adds a set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables specified in a table list

Parameters:

propTablesList - the SimpleProperties table list

Throws:

IfsException - if the operation fails

(Published)

addSimplePropertyTableDefinitions

public void addSimplePropertyTableDefinitions(SimplePropertyTableDefinition[] defs)
                                       throws IfsException

Adds a set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables.

Parameters:

defs - the definitions for the SimplePropertyTables

Throws:

IfsException - if the operation fails

(Published)

setSimplePropertyTableDefinitions

public void setSimplePropertyTableDefinitions(SimplePropertyTableDefinition[] defs)
                                       throws IfsException

Replaces the set of new SimplePropertyTableDefinitions for multiple SimplePropertyTables.

Parameters:

defs - the definitions for the SimpleProperties

Throws:

IfsException - if the operation fails

(Published)

removeSimplePropertyTableDefinitions

public void removeSimplePropertyTableDefinitions()
                                          throws IfsException

Removes all SimplePropertyTableDefinition SimplePropertyTables from this instance.

Throws:

IfsException - if the operation fails

(Published)

getSimplePropertyTableDefinitions

public SimplePropertyTableDefinition[] getSimplePropertyTableDefinitions()
                                                                  throws IfsException

Gets all the SimplePropertyTableDefinition SimplePropertyTables for this instance.

Returns:

the definitions for the SimplePropertyTables

Throws:

IfsException - if the operation fails

(Published)

addDetailListDefinition

public void addDetailListDefinition(SimplePropertyTableListDefinition def)
                             throws IfsException

Adds a new detail list.

Parameters:

def - the definition for the SimplePropertyTableList

Throws:

IfsException - if the operation fails

(Published)

addDetailListDefinition

public void addDetailListDefinition(AttributeValueTable detailListTable)
                             throws IfsException

Adds a new detail list Definition.

Parameters:

detailListTable - the list Definition, expressed as AttributeValueTable

Throws:

IfsException - if the operation fails

(Published)

addDetailListDefinitions

public void addDetailListDefinitions(List<AttributeValueTable> detailListsList)
                              throws IfsException

Adds a set of new detail list Definitions for multiple detail lists.

Parameters:

detailListsList - the list of SimplePropertyTableList Definitions, expressed as AttributeValueTables

Throws:

IfsException - if the operation fails

(Published)

addDetailListDefinitions

public void addDetailListDefinitions(SimplePropertyTableListDefinition[] defs)
                              throws IfsException

Adds a set of new new detail list Definitions for multiple detail lists.

Parameters:

defs - the array of SimplePropertyTableList Definitions

Throws:

IfsException - if the operation fails

(Published)

setDetailListDefinitions

public void setDetailListDefinitions(SimplePropertyTableListDefinition[] defs)
                              throws IfsException

Replaces the set of new detail list Definitions.

Parameters:

defs - the array of SimplePropertyTableList Definitions

Throws:

IfsException - if the operation fails

(Published)

removeDetailListDefinitions

public void removeDetailListDefinitions()
                                 throws IfsException

Removes all detail list Definitions from this instance.

Throws:

IfsException - if the operation fails

(Published)

getDetailListDefinitions

public SimplePropertyTableListDefinition[] getDetailListDefinitions()
                                                             throws IfsException

Gets all the detail list Definitions for this instance.

Returns:

the detail list Definitions

Throws:

IfsException - if the operation fails

(Published)

setObjectPropertyTableDefinition

public void setObjectPropertyTableDefinition(SimplePropertyTableDefinition def)
                                      throws IfsException

Sets the SimplePropertyTable definition for the object property table.

Parameters:

def - the definition for the SimplePropertyTable

Throws:

IfsException - if the operation fails

(Published)

setObjectPropertyTableDefinition

public void setObjectPropertyTableDefinition(AttributeValueTable propTable)
                                      throws IfsException

Sets the SimplePropertyTable definition for the object property table, expressed as an AttributeValueTable

Parameters:

def - the definition for the SimplePropertyTable

propTable - the object property table definition, expressed as an AttributeValueTable

Throws:

IfsException - if the operation fails

(Published)

getObjectPropertyTableDefinition

public SimplePropertyTableDefinition getObjectPropertyTableDefinition()
                                                               throws IfsException

Gets the SimplePropertyTable definition for the object property table.

Returns:

the definition for the SimplePropertyTable

Throws:

IfsException - if the operation fails

(Published)

toSimplePropertyTableListDefinition

public static SimplePropertyTableListDefinition toSimplePropertyTableListDefinition(LibraryObjectDefinition lodef)
                                                                             throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyTableListDefinition.

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

toSimplePropertyTableListDefinition

public static SimplePropertyTableListDefinition toSimplePropertyTableListDefinition(LibraryObjectDefinition lodef,
                                                                                    boolean enforce)
                                                                             throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyTableListDefinition.

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

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