oracle.ifs.beans

Class SimplePropertyTableList

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.beans.SimplePropertyTableList

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieSimplePropertyTableList

public class SimplePropertyTableList
extends TieSimpleObject

A SimplePropertyTableList is a set of name/value pairs, used to store ad hoc information.

Author:

Dave Long

Field Summary

Fields

Modifier and Type	Field and Description
static String	CLASS_NAME The name of the ClassObject representing this class.
static String	DETAILLISTS_ATTRIBUTE The name of the Attribute representing the SimplePropertyTableLists representing the sublists under this TableList.
static String	NAME_ATTRIBUTE The name of the Attribute representing the name of the SimplePropertyTableList.
static String	OBJECTPROPERTYTABLE_ATTRIBUTE The name of the Attribute representing the SimplePropertyTable representing this object's metadata.
static String	PROPERTYTABLES_ATTRIBUTE The name of the Attribute representing the SimplePropertyTable instances comprising this TableList.

Fields inherited from class oracle.ifs.beans.LibraryObject

DOMAIN_UNIQUENAME_DEFAULT_DELIMITER, m_ClassId, m_Id, m_Session, PROPERTYBUNDLE_ATTRIBUTE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SimplePropertyTableList(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a SimplePropertyTableList object.

Method Summary

Modifier and Type	Method and Description
void	addObjectProperty(String key, AttributeValue value) Adds an obejct property for this object.
void	addPropertyTable(SimplePropertyTable spt) Add a PropertyTable to the list of property tables held by this list.
SimplePropertyTable	addPropertyTable(String tableName) Add a SimplePropertyTable to the list of property tables held by this list.
SimplePropertyTable	addPropertyTable(String tableName, List<AttributeValueTable> propsList) Add a SimplePropertyTable to the list of property tables held by this list.
static SimplePropertyTableList	create(LibrarySession session, String name, List<AttributeValueTable> propTablesList, boolean createObjectTable) Creates an empty instance.
LibraryObject	createInstance(AttributeValueTable avt) Create a new LibraryObject from the specified AttributeValueTable.
static SimplePropertyTableList	createInstance(LibrarySession session, AttributeValueTable avt) Create a new SimplePropertyTableList from the specified AttributeValueTable.
SimplePropertyTableList[]	getDetailLists() Gets the SimplePropertyTableLists representing the sublists under this TableList.
AttributeValueTable	getObjectPropertiesAsTable() Gets the object properties (SimpleProperty objects) for this object as an AttributeValueTable.
AttributeValue	getObjectPropertyAsValue(String propName) Gets the object property value for the property name specified.
SimplePropertyTable	getObjectPropertyTable() Gets the SimplePropertyTable representing this object's metadata.
SimplePropertyTable	getOrCreateObjectPropertyTable() Gets or creates the SimplePropertyTable representing this object's metadata.
SimplePropertyTable	getPropertyTable(String tableName) Gets the SimplePropertyTable for the specified name.
SimplePropertyTable[]	getPropertyTables() Gets the SimplePropertyTable instances comprising this TableList.
List<AttributeValueTable>	getPropertyTablesAsList() Gets the SimplePropertyTable instances comprising this TableList, as a list of AttributeValueTable.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
protected void	postCreate(LibraryObjectDefinition lodef) Extensibility point to perform actions after the creation of a object.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
protected void	preUpdate(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the update of a object.
void	removeAllObjectProperties() Removes all object properties.
void	removeAllPropertyTables(boolean freeTables) Removes all property tables.
void	removeObjectProperty(String key) Removes an object property from this object.
void	removePropertyTable(String tableName) Add a PropertyTable to the list of property tables held by this list.
void	removePropertyTable(String tableName, boolean freeTable) Add a PropertyTable to the list of property tables held by this list, and optionally frees the SimplePropertyTable object that was removed.

Methods inherited from class oracle.ifs.beans.SimpleObject

free, handleCreate, isValidEventType

Methods inherited from class oracle.ifs.beans.LibraryObject

added, addSimpleProperty, addSimpleProperty, applyProperties, auditCreated, auditUpdated, canPurge, checkIfPropertyBundleSupported, checkRequiredAttributeSet, clearCopyContext, clearFreeContext, clearUpdateContext, compareTo, constructIdArray, constructIdArray, constructLibraryObject, constructLibraryObjectVector, createDedicatedPropertyBundle, deriveDomainUniqueName, dispose, equals, equals, free, freeAll, get, getAttribute, getAttributeByUpperCaseName, getAttributes, getAttributesByUpperCaseNames, getAuditDomainContext, getAuditEventFolderContext, getClassId, getClassname, getClassName, getClassObject, getCommonName, getCommonNameAndClass, getCopyContext, getCreateContext, getData, getDefinition, getDefinitionForSimplePropertyUpdates, getEffectivePolicyListElements, getEventualAttributeByUpperCaseName, getFreeContext, getId, getLabel, getName, getObjectReferenceAttribute, getOperationActionSpecificationContext, getPropertyBundle, getPropertyValue, getPublicObjectAttribute, getResourceString, getResourceString, getSchemaObjectAttribute, getSession, getSessionInterface, getSharedStateFactory, getSimpleObjectAttribute, getSimpleProperties, getSimpleProperty, getSimplePropertyValue, getStringIdentifier, getSystemObjectAttribute, getTraceLogger, getUpdateContext, handleAdminModeChange, handleEvent, handleFree, handleUpdate, hashCode, hasPropertyBundleAttribute, invalidateState, invokeOperation, invokeOperation, invokeServerMethod, isConnected, isCoreEventPostingEnabled, isInstanceOf, isPersistent, isTraced, lockRows, lookupInstanceLabel, performPostCreateExtensions, performPostFreeExtensions, performPostUpdateExtensions, performPreCreateExtensions, performPreFreeExtensions, performPreUpdateExtensions, postEvent, postEvent, postFree, postUpdate, preCreate, prePostAuditEvent, putProperty, putProperty, removeAllProperties, removeAllSimpleProperties, removeAllSimpleProperties, removed, removeProperty, removeSimpleProperty, removeSimpleProperty, renderAsRandomAccessContent, renderAsReader, renderAsStream, setAttribute, setAttribute, setAttributes, setAttributes, setCopyContext, setFreeContext, setId, setName, setPropertyBundle, setPropertyValue, setUpdateContext, toString, trace, trustHandleCreate, trustHandleCreateAsAdmin, trustHandleFree, trustHandleFreeAsAdmin, trustHandleUpdate, trustHandleUpdateAsAdmin, update, updateAndExposeDefinition, validatePropertyValues, vectorLibraryObjectElement, vectorToLibraryObjectArray, verifyAdministrationMode, verifyConnected, verifyPersistent, verifySystemUserAccess, verifyTargetObject

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.ifs.common.LibraryObjectInterface

getAttributeByUpperCaseName, getClassId, getId, getSessionInterface

Methods inherited from interface oracle.ifs.common.Traceable

getTraceLogger, isTraced, trace

Field Detail

CLASS_NAME

public static final String CLASS_NAME

The name of the ClassObject representing this class.

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final String NAME_ATTRIBUTE

The name of the Attribute representing the name of the SimplePropertyTableList.

See Also:

Constant Field Values

OBJECTPROPERTYTABLE_ATTRIBUTE

public static final String OBJECTPROPERTYTABLE_ATTRIBUTE

The name of the Attribute representing the SimplePropertyTable representing this object's metadata.

See Also:

Constant Field Values

DETAILLISTS_ATTRIBUTE

public static final String DETAILLISTS_ATTRIBUTE

The name of the Attribute representing the SimplePropertyTableLists representing the sublists under this TableList.

See Also:

Constant Field Values

PROPERTYTABLES_ATTRIBUTE

public static final String PROPERTYTABLES_ATTRIBUTE

The name of the Attribute representing the SimplePropertyTable instances comprising this TableList.

See Also:

Constant Field Values

Constructor Detail

SimplePropertyTableList

protected SimplePropertyTableList(LibrarySession session,
                                  Long id,
                                  Long classId,
                                  S_LibraryObjectData data)
                           throws IfsException

Construct a SimplePropertyTableList object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

create

public static SimplePropertyTableList create(LibrarySession session,
                                             String name,
                                             List<AttributeValueTable> propTablesList,
                                             boolean createObjectTable)
                                      throws IfsException

Creates an empty instance.

Parameters:

session - session context

name - instance name (optional)

propTablesList - list of property tables (optional)

createObjectTable - whether to create the Object Table

Returns:

the newly created instance

Throws:

IfsException - if the operation fails

hasNameAttribute

public boolean hasNameAttribute()
                         throws IfsException

Description copied from class: LibraryObject

Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.

Overrides:

hasNameAttribute in class LibraryObject

Returns:

true if the object has a NAME attribute.

Throws:

IfsException - if operation fails.

getObjectPropertyTable

public SimplePropertyTable getObjectPropertyTable()
                                           throws IfsException

Gets the SimplePropertyTable representing this object's metadata.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getOrCreateObjectPropertyTable

public SimplePropertyTable getOrCreateObjectPropertyTable()
                                                   throws IfsException

Gets or creates the SimplePropertyTable representing this object's metadata.

Returns:

the SimplePropertyTable holding this object's metadata

Throws:

IfsException - if the operation fails

getDetailLists

public SimplePropertyTableList[] getDetailLists()
                                         throws IfsException

Gets the SimplePropertyTableLists representing the sublists under this TableList.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getPropertyTables

public SimplePropertyTable[] getPropertyTables()
                                        throws IfsException

Gets the SimplePropertyTable instances comprising this TableList.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getPropertyTable

public SimplePropertyTable getPropertyTable(String tableName)
                                     throws IfsException

Gets the SimplePropertyTable for the specified name.

Parameters:

tableName - the name for the new SimplePropertyTable

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getObjectPropertiesAsTable

public AttributeValueTable getObjectPropertiesAsTable()
                                               throws IfsException

Gets the object properties (SimpleProperty objects) for this object as an AttributeValueTable.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getObjectPropertyAsValue

public AttributeValue getObjectPropertyAsValue(String propName)
                                        throws IfsException

Gets the object property value for the property name specified.

Parameters:

propName - the property name

Returns:

the object property value, or null if no property exists

Throws:

IfsException - if the operation fails

addObjectProperty

public void addObjectProperty(String key,
                              AttributeValue value)
                       throws IfsException

Adds an obejct property for this object.

Parameters:

key - the property's key

value - the property's value

Throws:

IfsException - if the operation fails

removeObjectProperty

public void removeObjectProperty(String key)
                          throws IfsException

Removes an object property from this object.

Parameters:

key - the property's key

Throws:

IfsException - if the operation fails

removeAllObjectProperties

public void removeAllObjectProperties()
                               throws IfsException

Removes all object properties.

Throws:

IfsException - if operation fails

(Published)

getPropertyTablesAsList

public List<AttributeValueTable> getPropertyTablesAsList()
                                                  throws IfsException

Gets the SimplePropertyTable instances comprising this TableList, as a list of AttributeValueTable.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

addPropertyTable

public void addPropertyTable(SimplePropertyTable spt)
                      throws IfsException

Add a PropertyTable to the list of property tables held by this list.

Parameters:

spt - the PropertyTable to add

Throws:

IfsException - if the operation fails.

addPropertyTable

public SimplePropertyTable addPropertyTable(String tableName)
                                     throws IfsException

Add a SimplePropertyTable to the list of property tables held by this list.

The new SimplePropertyTable will initally have no properties defined.

Parameters:

tableName - the name for the new SimplePropertyTable

Returns:

the SimplePropertyTable added

Throws:

IfsException - if the operation fails.

addPropertyTable

public SimplePropertyTable addPropertyTable(String tableName,
                                            List<AttributeValueTable> propsList)
                                     throws IfsException

Add a SimplePropertyTable to the list of property tables held by this list.

The property list has an individual property defined in each AttributeValueTable.

Parameters:

tableName - the name for the new SimplePropertyTable

propsList - the properties

Returns:

the SimplePropertyTable added

Throws:

IfsException - if the operation fails.

removePropertyTable

public void removePropertyTable(String tableName)
                         throws IfsException

Add a PropertyTable to the list of property tables held by this list.

Also frees the SimplePropertyTable object that was removed.

Parameters:

tableName - the name of the PropertyTable to remove

Throws:

IfsException - if the operation fails.

removePropertyTable

public void removePropertyTable(String tableName,
                                boolean freeTable)
                         throws IfsException

Add a PropertyTable to the list of property tables held by this list, and optionally frees the SimplePropertyTable object that was removed.

Parameters:

tableName - the name of the PropertyTable to remove

freeTable - whether to free the SimplePropertyTable object that was removed

Throws:

IfsException - if the operation fails.

removeAllPropertyTables

public void removeAllPropertyTables(boolean freeTables)
                             throws IfsException

Removes all property tables.

Parameters:

freeTables - whether to free the SimplePropertyTable objects that are removed

Throws:

IfsException - if the operation fails

createInstance

public LibraryObject createInstance(AttributeValueTable avt)
                             throws IfsException

Create a new LibraryObject from the specified AttributeValueTable.

Overrides:

createInstance in class LibraryObject

Parameters:

avt - the object definition, as a AttributeValueTable

Returns:

the newly created object

Throws:

IfsException - if operation fails.

(Published)

createInstance

public static SimplePropertyTableList createInstance(LibrarySession session,
                                                     AttributeValueTable avt)
                                              throws IfsException

Create a new SimplePropertyTableList from the specified AttributeValueTable.

Parameters:

session - the session context

avt - the object definition, as a AttributeValueTable

Returns:

the newly created SimplePropertyTableList

Throws:

IfsException - if operation fails.

(Published)

postCreate

protected void postCreate(LibraryObjectDefinition lodef)
                   throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions after the creation of a object.

This method is typically overridden by subclasses that perform operations after an object is created. Subclasses are expected to invoke super.postCreate.

Overrides:

postCreate in class LibraryObject

Parameters:

lodef - object definition that was used to create the object

Throws:

IfsException - if operation fails.

preUpdate

protected void preUpdate(LibraryObjectDefinition lodef)
                  throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the update of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being updated, in order to modify objects related to the target object. Subclasses are expected to invoke super.preUpdate.

Overrides:

preUpdate in class LibraryObject

Parameters:

lodef - object definition used to define how the target object will be updated

Throws:

IfsException - if operation fails.

preFree

protected void preFree(LibraryObjectDefinition lodef)
                throws IfsException

Description copied from class: LibraryObject

Extensibility point to perform actions prior to the permanent deletion ("free") of a object.

This method is typically overridden by subclasses that perform other operations prior to the target object being freed in order to all delete or modify objects related to the target object. Subclasses are expected to invoke super.preFree.

Overrides:

preFree in class LibraryObject

Parameters:

lodef - object definition used to hold options related to the free operation

Throws:

IfsException - if operation fails.