Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

oracle.jdeveloper.offlinedb.userprops
Class UserPropertyDefn

java.lang.Object
  extended by oracle.javatools.data.HashStructureAdapter
      extended by oracle.jdeveloper.offlinedb.userprops.UserPropertyDefn

public class UserPropertyDefn
extends HashStructureAdapter

How to access the user property values for a given Offline Database Object.

Given an offline database object, say 'dbOb', the following code will return the user property values.

   DynamicPropertySet userPropValues =
             (DynamicPropertySet)dbOb.getProperty(UserPropertyDefn.DATA_KEY);
 
The properties are name/value pairs.

Example:

     DynamicPropertySet userPropValues =
           (DynamicPropertySet)dbOb.getProperty(UserPropertyDefn.DATA_KEY);
     Map dbObjProps = userPropValues.getProperties();
     for(String propName : dbObjectProps.keySet())
     {
       String propValue = (String)dbObjectProps.get(propName);
     }
 


Field Summary
static java.lang.String DATA_KEY
           
 
Fields inherited from class oracle.javatools.data.HashStructureAdapter
_hash
 
Method Summary
 void addToList(ListStructure list)
           
 java.lang.String getDefaultValue()
          User Property Default Value.
 java.lang.String getDefaultValue(OfflineDBObjectProvider pro, DBObject dbObj)
           
 java.lang.String getDescription()
          User Property Description.
 java.lang.String getDisplayName()
          User Property Display Name.
 java.lang.String[] getListOfValueMeanings()
          User Property List Of Value meanings.
 java.lang.String[] getListOfValues()
          User Property List Of Values.
 java.lang.String getName()
          User Property Name.
 java.lang.String getObjectType()
          User Property Object Type.
 int getOrdinal()
          User Property Ordinal Value.
static java.lang.Object getValue(OfflineDBObjectProvider prov, DBObject dbObject, java.lang.String udpName)
          Return the User Defined Property Value.
 boolean isListOfValuesButtonUI()
           
 boolean isListOfValuesMultiselect()
           
 boolean isMandatory()
          User Property Mandatory.
 boolean isMultilineText()
           
 void setDefaultValue(java.lang.String defaultValue)
           
 void setDescription(java.lang.String description)
           
 void setDisplayName(java.lang.String name)
           
 void setListOfValueMeanings(java.lang.String[] lovMeanings)
          User Property Set List of Value meanings.
 void setListOfValues(java.lang.String[] lovs)
          User Property Set List of Values.
 void setListOfValuesButtonUI(boolean multiselect)
           
 void setListOfValuesMultiselect(boolean multiselect)
           
 void setMandatory(boolean mandatory)
           
 void setMultilineText(boolean multiline)
           
 void setName(java.lang.String name)
           
 void setObjectType(java.lang.String type)
           
 void setOrdinal(int ordinal)
           
static UserPropertyDefn useHash(HashStructure hash)
           
 
Methods inherited from class oracle.javatools.data.HashStructureAdapter
addStructureChangeListener, containsKey, copyTo, copyToImpl, equals, equalsImpl, findOrCreate, forcedCopyTo, getHashStructure, removeStructureChangeListener, useObjectEquals
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

DATA_KEY

public static final java.lang.String DATA_KEY
See Also:
Constant Field Values
Method Detail

useHash

public static UserPropertyDefn useHash(HashStructure hash)

getName

public java.lang.String getName()
User Property Name.

Returns:

setName

public void setName(java.lang.String name)

getObjectType

public java.lang.String getObjectType()
User Property Object Type.

Returns:

setObjectType

public void setObjectType(java.lang.String type)

getDisplayName

public java.lang.String getDisplayName()
User Property Display Name.

Returns:

setDisplayName

public void setDisplayName(java.lang.String name)

getDescription

public java.lang.String getDescription()
User Property Description.

Returns:

setDescription

public void setDescription(java.lang.String description)

isMandatory

public boolean isMandatory()
User Property Mandatory.

Returns:

setMandatory

public void setMandatory(boolean mandatory)

getDefaultValue

public java.lang.String getDefaultValue()
User Property Default Value.

Returns:

getDefaultValue

public java.lang.String getDefaultValue(OfflineDBObjectProvider pro,
                                        DBObject dbObj)

setDefaultValue

public void setDefaultValue(java.lang.String defaultValue)

getListOfValues

public java.lang.String[] getListOfValues()
User Property List Of Values.


setListOfValues

public void setListOfValues(java.lang.String[] lovs)
User Property Set List of Values. A list of values is simply an array of Strings. Any existing values are replaced by the new array.

Parameters:
lovs -

getListOfValueMeanings

public java.lang.String[] getListOfValueMeanings()
User Property List Of Value meanings.


setListOfValueMeanings

public void setListOfValueMeanings(java.lang.String[] lovMeanings)
User Property Set List of Value meanings. A list of value meanings is simply an array of Strings. Any existing value meanings are replaced by the new array.

Parameters:
lovMeanings -

addToList

public void addToList(ListStructure list)

getValue

public static java.lang.Object getValue(OfflineDBObjectProvider prov,
                                        DBObject dbObject,
                                        java.lang.String udpName)
Return the User Defined Property Value.

Get a user defined property value for a DBObject, given the provider, the object and the property name.

If the DBObject has a user defined property, return the value.
Otherwise,
get the user property Libraries from the provider,
search the libraries for a definiton of the property,
return the default value.


getOrdinal

public int getOrdinal()
User Property Ordinal Value.

Used to indicate the display order of the user properties. Returns -1 to indicate that there is no display order. That is, the library was created before display order was implemented.

Returns:

setOrdinal

public void setOrdinal(int ordinal)

isMultilineText

public boolean isMultilineText()

setMultilineText

public void setMultilineText(boolean multiline)

isListOfValuesMultiselect

public boolean isListOfValuesMultiselect()

setListOfValuesMultiselect

public void setListOfValuesMultiselect(boolean multiselect)

isListOfValuesButtonUI

public boolean isListOfValuesButtonUI()

setListOfValuesButtonUI

public void setListOfValuesButtonUI(boolean multiselect)

Oracle Fusion Middleware Java API Reference for Oracle Extension SDK
11g Release 2 (11.1.2.0.0)

E17493-01

Copyright © 1997, 2011, Oracle. All rights reserved.