oracle.ifs.beans

Class SimplePropertyTable

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.beans.SimplePropertyTable

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieSimplePropertyTable

public class SimplePropertyTable
extends TieSimpleObject

A SimplePropertyTable 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	NAME_ATTRIBUTE The name of the Attribute representing The name of the SimplePropertyTable.
static String	PROPERTIES_ATTRIBUTE The name of the Attribute representing the SimpleProperty instances comprising this table.

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	SimplePropertyTable(LibrarySession session, Long id, Long classId, S_LibraryObjectData data) Construct a SimplePropertyTable object.

Method Summary

Modifier and Type	Method and Description
void	addProperty(String key, AttributeValue value) Adds a property (SimpleProperty) for this object.
static SimplePropertyTable	create(LibrarySession session, String name) Creates an empty instance.
LibraryObject	createInstance(AttributeValueTable avt) Create a new LibraryObject from the specified AttributeValueTable.
static SimplePropertyTable	createInstance(LibrarySession session, AttributeValueTable avt) Create a new SimplePropertyTable from the specified AttributeValueTable.
SimpleProperty[]	getProperties() Gets the properties (SimpleProperty objects) for this object.
AttributeValueTable	getPropertiesAsTable() Gets the properties (SimpleProperty objects) for this object as an AttributeValueTable.
String	getPropertiesAttributeName() Gets the name of the Attribute that holds the properties for this object.
SimpleProperty	getProperty(String propName) Gets the property (SimpleProperty object) for the property name specified.
AttributeValue	getPropertyAsValue(String propName) Gets the property value for the property name specified.
static SimplePropertyTable	getSimplePropertyTable(AttributeValue av, LibrarySession session) Gets a SimplePropertyTable for the specified AttributeValue.
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	removeAllProperties() Removes all simple properties.
void	removeProperty(String key) Removes a property (SimpleProperty) from this object.

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, removeAllSimpleProperties, removeAllSimpleProperties, removed, 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 SimplePropertyTable.

See Also:

Constant Field Values

PROPERTIES_ATTRIBUTE

public static final String PROPERTIES_ATTRIBUTE

The name of the Attribute representing the SimpleProperty instances comprising this table.

See Also:

Constant Field Values

Constructor Detail

SimplePropertyTable

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

Construct a SimplePropertyTable 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 SimplePropertyTable create(LibrarySession session,
                                         String name)
                                  throws IfsException

Creates an empty instance.

Parameters:

session - session context

name - instance name (optional)

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.

getPropertiesAttributeName

public String getPropertiesAttributeName()
                                  throws IfsException

Gets the name of the Attribute that holds the properties for this object.

Can be overridden by subclasses who wish to keep the properties in an Attribute defined in the subclass, to avoid overloading the default attribute.

Returns:

the name of the Attribute that holds the properties

Throws:

IfsException - if the operation fails

getProperties

public SimpleProperty[] getProperties()
                               throws IfsException

Gets the properties (SimpleProperty objects) for this object.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getProperty

public SimpleProperty getProperty(String propName)
                           throws IfsException

Gets the property (SimpleProperty object) for the property name specified.

Parameters:

propName - the property name

Returns:

the property, or null if no property exists

Throws:

IfsException - if the operation fails

getPropertyAsValue

public AttributeValue getPropertyAsValue(String propName)
                                  throws IfsException

Gets the property value for the property name specified.

Parameters:

propName - the property name

Returns:

the property value, or null if no property exists

Throws:

IfsException - if the operation fails

getPropertiesAsTable

public AttributeValueTable getPropertiesAsTable()
                                         throws IfsException

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

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getSimplePropertyTable

public static SimplePropertyTable getSimplePropertyTable(AttributeValue av,
                                                         LibrarySession session)
                                                  throws IfsException

Gets a SimplePropertyTable for the specified AttributeValue.

Parameters:

av - the AttributeValue

session - the session context

Returns:

the SimplePropertyTable

Throws:

IfsException - if the operation fails

(Published)

addProperty

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

Adds a property (SimpleProperty) for this object.

Parameters:

key - the property's key

value - the property's value

Throws:

IfsException - if the operation fails

removeProperty

public void removeProperty(String key)
                    throws IfsException

Removes a property (SimpleProperty) from this object.

Overrides:

removeProperty in class LibraryObject

Parameters:

key - the property's key

Throws:

IfsException - if the operation fails

removeAllProperties

public void removeAllProperties()
                         throws IfsException

Removes all simple properties.

Overrides:

removeAllProperties in class LibraryObject

Throws:

IfsException - if operation fails

(Published)

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 SimplePropertyTable createInstance(LibrarySession session,
                                                 AttributeValueTable avt)
                                          throws IfsException

Create a new SimplePropertyTable from the specified AttributeValueTable.

Parameters:

session - the session context

avt - the object definition, as a AttributeValueTable

Returns:

the newly created SimplePropertyTable

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.