oracle.ifs.beans

Class PropertyDefinition

java.lang.Object

oracle.ifs.beans.LibraryObjectDefinition

oracle.ifs.beans.SystemObjectDefinition

oracle.ifs.beans.PropertyDefinition

All Implemented Interfaces:

Serializable, Cloneable

public class PropertyDefinition
extends SystemObjectDefinition

A PropertyDefinition is used to hold the specification of a Property value associated with a PropertyBundle.

The PropertyDefinition are assigned to PropertyBundleDefinition either to create a new PropertyBundle or to modify an existing one. Methods are provided to set the name & value of the Property.

Version:

1.0

Author:

David Pitfield

See Also:

Property, Serialized Form

(Published)

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

Method Summary

Modifier and Type	Method and Description
int	getDataType() Gets the data type of the new Property.
String	getName() Gets the Name of the new Property that was set via setName().
AttributeValue	getValue() Gets the value of the new Property.
void	setName(String name) Sets the Name of the new Property.
void	setValue(AttributeValue av) Sets the value and data type of the new Property.

Methods inherited from class oracle.ifs.beans.SystemObjectDefinition

addCategoryDefinition, addCategoryDefinitionForUpdate, addCategoryDefinitions, addCategoryForDelete, applySettings, getCategoriesForDelete, getCategoryDefinitions, getCategoryDefinitionsForUpdate, getCreateCategoriesServerSideOption, removeCategoriesForDelete, removeCategoryDefinitions, removeCategoryDefinitionsForUpdate, setCategoryDefinitions, setCreateCategoriesServerSideOption, toSystemObjectDefinition, toSystemObjectDefinition

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

PropertyDefinition

public PropertyDefinition(LibrarySessionInterface session)
                   throws IfsException

Construct a definition explicitly capturing the session. The initial ClassObject will be Property.

Parameters:

session - the current session

Throws:

IfsException - if the operation fails

(Published)

PropertyDefinition

public PropertyDefinition(LibrarySessionInterface session,
                          String className)
                   throws IfsException

Construct a definition, explicitly capturing the session and setting the initial classobject.

Parameters:

session - the current session

className - the initial class name

Throws:

IfsException - if the operation fails

(Unpublished)

Method Detail

getDataType

public final int getDataType()
                      throws IfsException

Gets the data type of the new Property.

Equivalent to:

 AttributeValue av = getValue();
 return (av == null) ?
     Attribute.ATTRIBUTEDATATYPE_UNKNOWN :
     av.getInteger(getSession());

Returns:

the data type

Throws:

IfsException - if the operation fails

(Published)

getValue

public final AttributeValue getValue()
                              throws IfsException

Gets the value of the new Property.

This method returns an AttributeValue that represents the value of the Property. A null value is returned if this PropertyDefinition is being used to remove a Property from an existing PropertyBundle. In this case, a name will still have to be set, via setName(), to specify which Property is to be removed.

Returns:

the value, or null if this instance is being used to remove a Property

Throws:

IfsException - if the operation fails

(Published)

setValue

public void setValue(AttributeValue av)
              throws IfsException

Sets the value and data type of the new Property.

Parameters:

av - the AttributeValue containing the new value; implies the data type.

Throws:

IfsException - if the operation fails

(Published)

getName

public String getName()
               throws IfsException

Gets the Name of the new Property that was set via setName().

Overrides:

getName in class LibraryObjectDefinition

Returns:

The name of the Property

Throws:

IfsException - if operation fails.

(Published)

setName

public void setName(String name)
             throws IfsException

Sets the Name of the new Property. This override ensures that the NAME attribute setting is consistent with the Name value in the AttributeValue.

Overrides:

setName in class LibraryObjectDefinition

Parameters:

name - The name to be used for the new instance.

Throws:

IfsException - if operation fails.

(Published)