oracle.ifs.beans

Class SimplePropertyDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SimpleObjectDefinition

oracle.ifs.beans.SimplePropertyDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class SimplePropertyDefinition
extends SimpleObjectDefinition

A SimplePropertyDefinition is used to create or modify a SimpleProperty 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	ATTRIBUTEVALUE_OPTION_DEDICATED The AttributeValue option indicating that the value specified is dedicated to the Property, meaning it will be freed when the property is freed.
static String	DEFINITION_OPTION_REMOVE_PROPERTY The definition option holding the indication that the SimpleProperty defined by this instance should be removed.

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

Method Summary

Modifier and Type	Method and Description
boolean	getRemoveOption() Gets the indication that the SimpleProperty defined by this instance should be removed.
void	setReferencingObject(LibraryObject refObj) Set the referencing object.
void	setRemoveOption(boolean option) Sets or clears the indication that the SimpleProperty defined by this instance should be removed.
void	setValue(AttributeValue value) Set the SimpleProperty's value.
static SimplePropertyDefinition	toSimplePropertyDefinition(LibraryObjectDefinition lodef) Casts the specified LibraryObjectDefinition to a SimplePropertyDefinition.
static SimplePropertyDefinition	toSimplePropertyDefinition(LibraryObjectDefinition lodef, boolean enforce) Casts the specified LibraryObjectDefinition to a SimplePropertyDefinition.

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, applySettings, 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

ATTRIBUTEVALUE_OPTION_DEDICATED

public static final String ATTRIBUTEVALUE_OPTION_DEDICATED

The AttributeValue option indicating that the value specified is dedicated to the Property, meaning it will be freed when the property is freed.

See Also:

Constant Field Values

DEFINITION_OPTION_REMOVE_PROPERTY

public static final String DEFINITION_OPTION_REMOVE_PROPERTY

The definition option holding the indication that the SimpleProperty defined by this instance should be removed.

See Also:

Constant Field Values

Constructor Detail

SimplePropertyDefinition

public SimplePropertyDefinition(LibrarySessionInterface session)
                         throws IfsException

Constructs a definition explicitly capturing the session.

The initial ClassObject will be SimpleProperty.

Parameters:

session - the session context

Throws:

IfsException - if the operation fails

SimplePropertyDefinition

public SimplePropertyDefinition(LibrarySessionInterface session,
                                String className)
                         throws IfsException

Constructs a definition explicitly capturing the session, and setting the initial ClassObject.

Parameters:

session - the session context

className - the initial class name

Throws:

IfsException - if the operation fails

Method Detail

setRemoveOption

public void setRemoveOption(boolean option)
                     throws IfsException

Sets or clears the indication that the SimpleProperty defined by this instance should be removed.

Parameters:

option - true if the SimpleProperty identified by this instance should be removed

Throws:

IfsException - if operation fails.

(Published)

getRemoveOption

public boolean getRemoveOption()
                        throws IfsException

Gets the indication that the SimpleProperty defined by this instance should be removed.

Returns:

true if the SimpleProperty identified by this instance should be removed

Throws:

IfsException - if operation fails.

(Published)

setReferencingObject

public void setReferencingObject(LibraryObject refObj)
                          throws IfsException

Set the referencing object.

Parameters:

refObj - the referencing object

Throws:

IfsException - if operation fails.

setValue

public void setValue(AttributeValue value)
              throws IfsException

Set the SimpleProperty's value.

Parameters:

value - the SimpleProperty's value

Throws:

IfsException - if operation fails.

toSimplePropertyDefinition

public static SimplePropertyDefinition toSimplePropertyDefinition(LibraryObjectDefinition lodef)
                                                           throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyDefinition.

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

toSimplePropertyDefinition

public static SimplePropertyDefinition toSimplePropertyDefinition(LibraryObjectDefinition lodef,
                                                                  boolean enforce)
                                                           throws IfsException

Casts the specified LibraryObjectDefinition to a SimplePropertyDefinition.

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

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