oracle.ifs.beans

Class SimpleProperty

java.lang.Object

oracle.ifs.beans.LibraryObject

oracle.ifs.beans.TieLibraryObject

oracle.ifs.beans.SimpleObject

oracle.ifs.beans.TieSimpleObject

oracle.ifs.beans.SimpleProperty

All Implemented Interfaces:

Comparable, IfsEventHandler, LibraryObjectInterface, LooselyBoundedCacheable, SimpleObjectInterface, Traceable

Direct Known Subclasses:

TieSimpleProperty

public class SimpleProperty
extends TieSimpleObject

A SimpleProperty is a name/value pair, used to store ad hoc information using SimpleObjects instead of PropertyBundles.

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	DEDICATED_ATTRIBUTE The name of the Attribute representing whether the value of this property is dedicated to this property, meaning it will be freed when the property is freed.
static String	DOUBLEVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a Double.
static String	DOUBLEVALUES_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is an array of Doubles.
static String	LONGLONGMAPVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a Long-Long Map.
static String	LONGSTRINGMAPVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a Long-String Map.
static String	LONGVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a numeric, date, boolean, or object.
static String	LONGVALUES_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is an array of numeric, date, boolean, or object.
static String	NAME_ATTRIBUTE The name of the Attribute representing The name of the SimpleProperty.
static String	REFERENCINGCLASSOBJECTID_ATTRIBUTE The name of the Attribute representing The ClassObject of the object which references this property.
static String	REFERENCINGOBJECTID_ATTRIBUTE The name of the Attribute representing The ID of the object which references this property.
static String	STRINGDOUBLEMAPVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a String-Double Map.
static String	STRINGLONGMAPVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a String-Long Map.
static String	STRINGSTRINGMAPVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a String-String Map.
static String	STRINGVALUE_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is a String.
static String	STRINGVALUES_ATTRIBUTE The name of the Attribute representing The value of this Property if the datatype is an array of Strings.
static String	VALUECLASSOBJECTID_ATTRIBUTE The name of the Attribute representing The ClassObject ID of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.
static String	VALUEDATATYPE_ATTRIBUTE The name of the Attribute representing The datatype of the value of this SimpleProperty.

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

Method Summary

Modifier and Type	Method and Description
void	addToStringArray(String val) Adds a String value to the String array.
void	addToStringArray(String[] val) Adds String values to the String array.
static SimpleProperty[]	deriveNewSimplePropertySet(LibraryObject refingObject, SimpleProperty[] originalProps, SimplePropertyDefinition[] propDefs) Create or update SimpleProperty obejcts.
Double	getDoubleValue() Gets The value of this Property if the datatype is a Double.
Double[]	getDoubleValues() Gets The value of this Property if the datatype is an array of Doubles.
Map<Long,Long>	getLongLongMapValue() Gets The value of this Property if the datatype is a Long-Long Map.
Map<Long,String>	getLongStringMapValue() Gets The value of this Property if the datatype is a Long-String Map.
Long	getLongValue() Gets The value of this Property if the datatype is a numeric, date, boolean, or object.
Long[]	getLongValues() Gets The value of this Property if the datatype is an array of numeric, date, boolean, or object.
Long	getReferencingClassObjectId() Gets The ClassObject of the object which references this property.
LibraryObject	getReferencingObject() Gets the object which references this property.
Long	getReferencingObjectId() Gets The ID of the object which references this property.
Map<String,Double>	getStringDoubleMapValue() Gets The value of this Property if the datatype is a String-Double Map.
Map<String,Long>	getStringLongMapValue() Gets The value of this Property if the datatype is a String-Long Map.
Map<String,String>	getStringStringMapValue() Gets The value of this Property if the datatype is a String-String Map.
String	getStringValue() Gets The value of this Property if the datatype is a String.
String[]	getStringValues() Gets The value of this Property if the datatype is an array of Strings.
AttributeValue	getValue() Gets the value represented as an AttributeValue.
ClassObject	getValueClassObject() Gets the ClassObject of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.
Long	getValueClassObjectId() Gets The ClassObject ID of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.
int	getValueDataType() Gets The datatype of the value of this SimpleProperty.
boolean	hasNameAttribute() Returns true if this object is an instance of a class that has a NAME attribute, and false otherwise.
boolean	isDedicated() Returns true if the value of this property is dedicated to this property, meaning it will be freed when the property is freed.
protected void	preFree(LibraryObjectDefinition lodef) Extensibility point to perform actions prior to the permanent deletion ("free") of a object.
void	removeFromStringArray(String val) Removes a String value from the String array.
void	removeFromStringArray(String[] val) Removes String values from the String array.
void	setValue(AttributeValue val) Updates the property value.

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, createInstance, 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, postCreate, postEvent, postEvent, postFree, postUpdate, preCreate, prePostAuditEvent, preUpdate, 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 SimpleProperty.

See Also:

Constant Field Values

REFERENCINGOBJECTID_ATTRIBUTE

public static final String REFERENCINGOBJECTID_ATTRIBUTE

The name of the Attribute representing The ID of the object which references this property.

See Also:

Constant Field Values

REFERENCINGCLASSOBJECTID_ATTRIBUTE

public static final String REFERENCINGCLASSOBJECTID_ATTRIBUTE

The name of the Attribute representing The ClassObject of the object which references this property.

See Also:

Constant Field Values

DEDICATED_ATTRIBUTE

public static final String DEDICATED_ATTRIBUTE

The name of the Attribute representing whether the value of this property is dedicated to this property, meaning it will be freed when the property is freed.

See Also:

Constant Field Values

VALUEDATATYPE_ATTRIBUTE

public static final String VALUEDATATYPE_ATTRIBUTE

The name of the Attribute representing The datatype of the value of this SimpleProperty.

See Also:

Constant Field Values

VALUECLASSOBJECTID_ATTRIBUTE

public static final String VALUECLASSOBJECTID_ATTRIBUTE

The name of the Attribute representing The ClassObject ID of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.

See Also:

Constant Field Values

STRINGVALUE_ATTRIBUTE

public static final String STRINGVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a String.

See Also:

Constant Field Values

LONGVALUE_ATTRIBUTE

public static final String LONGVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a numeric, date, boolean, or object.

See Also:

Constant Field Values

DOUBLEVALUE_ATTRIBUTE

public static final String DOUBLEVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a Double.

See Also:

Constant Field Values

STRINGVALUES_ATTRIBUTE

public static final String STRINGVALUES_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is an array of Strings.

See Also:

Constant Field Values

LONGVALUES_ATTRIBUTE

public static final String LONGVALUES_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is an array of numeric, date, boolean, or object.

See Also:

Constant Field Values

DOUBLEVALUES_ATTRIBUTE

public static final String DOUBLEVALUES_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is an array of Doubles.

See Also:

Constant Field Values

STRINGSTRINGMAPVALUE_ATTRIBUTE

public static final String STRINGSTRINGMAPVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a String-String Map.

See Also:

Constant Field Values

STRINGLONGMAPVALUE_ATTRIBUTE

public static final String STRINGLONGMAPVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a String-Long Map.

See Also:

Constant Field Values

STRINGDOUBLEMAPVALUE_ATTRIBUTE

public static final String STRINGDOUBLEMAPVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a String-Double Map.

See Also:

Constant Field Values

LONGSTRINGMAPVALUE_ATTRIBUTE

public static final String LONGSTRINGMAPVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a Long-String Map.

See Also:

Constant Field Values

LONGLONGMAPVALUE_ATTRIBUTE

public static final String LONGLONGMAPVALUE_ATTRIBUTE

The name of the Attribute representing The value of this Property if the datatype is a Long-Long Map.

See Also:

Constant Field Values

Constructor Detail

SimpleProperty

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

Construct a SimpleProperty object.

Parameters:

session - current LibrarySession

id - object id

classId - class id

data - data component

Throws:

IfsException - if the operation fails

Method Detail

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.

getReferencingObjectId

public Long getReferencingObjectId()
                            throws IfsException

Gets The ID of the object which references this property.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getReferencingClassObjectId

public Long getReferencingClassObjectId()
                                 throws IfsException

Gets The ClassObject of the object which references this property.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

isDedicated

public boolean isDedicated()
                    throws IfsException

Returns true if the value of this property is dedicated to this property, meaning it will be freed when the property is freed.

Returns:

true if the property value is dedicated to this property

Throws:

IfsException - if the operation fails.

(Published)

getValueDataType

public int getValueDataType()
                     throws IfsException

Gets The datatype of the value of this SimpleProperty.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getValueClassObjectId

public Long getValueClassObjectId()
                           throws IfsException

Gets The ClassObject ID of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStringValue

public String getStringValue()
                      throws IfsException

Gets The value of this Property if the datatype is a String.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getLongValue

public Long getLongValue()
                  throws IfsException

Gets The value of this Property if the datatype is a numeric, date, boolean, or object.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getDoubleValue

public Double getDoubleValue()
                      throws IfsException

Gets The value of this Property if the datatype is a Double.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStringValues

public String[] getStringValues()
                         throws IfsException

Gets The value of this Property if the datatype is an array of Strings.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getLongValues

public Long[] getLongValues()
                     throws IfsException

Gets The value of this Property if the datatype is an array of numeric, date, boolean, or object.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getDoubleValues

public Double[] getDoubleValues()
                         throws IfsException

Gets The value of this Property if the datatype is an array of Doubles.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStringStringMapValue

public Map<String,String> getStringStringMapValue()
                                           throws IfsException

Gets The value of this Property if the datatype is a String-String Map.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStringLongMapValue

public Map<String,Long> getStringLongMapValue()
                                       throws IfsException

Gets The value of this Property if the datatype is a String-Long Map.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getStringDoubleMapValue

public Map<String,Double> getStringDoubleMapValue()
                                           throws IfsException

Gets The value of this Property if the datatype is a String-Double Map.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getLongStringMapValue

public Map<Long,String> getLongStringMapValue()
                                       throws IfsException

Gets The value of this Property if the datatype is a Long-String Map.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getLongLongMapValue

public Map<Long,Long> getLongLongMapValue()
                                   throws IfsException

Gets The value of this Property if the datatype is a Long-Long Map.

Returns:

the attribute's value

Throws:

IfsException - if the operation fails

getReferencingObject

public LibraryObject getReferencingObject()
                                   throws IfsException

Gets the object which references this property.

Returns:

the referencing object

Throws:

IfsException - if the operation fails

getValueClassObject

public ClassObject getValueClassObject()
                                throws IfsException

Gets the ClassObject of the value of this SimpleProperty, if it is a SimpleObject or SimpleObject array type.

Returns:

the ClassObject of the value of this SimpleProperty

Throws:

IfsException - if the operation fails

getValue

public AttributeValue getValue()
                        throws IfsException

Gets the value represented as an AttributeValue.

Returns:

the SimpleProperty's value

Throws:

IfsException - if the operation fails

addToStringArray

public void addToStringArray(String val)
                      throws IfsException

Adds a String value to the String array.

Parameters:

val - the String to add

Throws:

IfsException - if the operation fails

addToStringArray

public void addToStringArray(String[] val)
                      throws IfsException

Adds String values to the String array.

Parameters:

val - the Strings to add

Throws:

IfsException - if the operation fails

removeFromStringArray

public void removeFromStringArray(String val)
                           throws IfsException

Removes a String value from the String array.

Parameters:

val - the String to remove

Throws:

IfsException - if the operation fails

removeFromStringArray

public void removeFromStringArray(String[] val)
                           throws IfsException

Removes String values from the String array.

Parameters:

val - the Strings to remove

Throws:

IfsException - if the operation fails

setValue

public void setValue(AttributeValue val)
              throws IfsException

Updates the property value.

Parameters:

val - the new value

Throws:

IfsException - if the operation fails

deriveNewSimplePropertySet

public static SimpleProperty[] deriveNewSimplePropertySet(LibraryObject refingObject,
                                                          SimpleProperty[] originalProps,
                                                          SimplePropertyDefinition[] propDefs)
                                                   throws IfsException

Create or update SimpleProperty obejcts.

Parameters:

refingObject - the Referencing object (must be non-null)

originalProps - the original properties

Returns:

the new SimpleProperty set, or null if the new set is identical to the original set

Throws:

IfsException - if the 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.