Overview

An attribute definition specifies the name, type, minimum value, maximum value, default value and enumeration of allowed values for the attributes. The Aggregate attribute specifies whether the attribute holds a scalar value or a collection of values. An AttributeDefinition is a snapshot of a server-side AttributeDefinition instance; It is a mutable value object associated with an AttributeDefinition instance which has some of its attributes materialized during a load operation. The set of loaded Attributes depends on the Projection to the load operation. From an object model point of view, an AttributeDefinition is a tuple with a globally unique entity ID (EID) and a mandatory name, property type. Notes:

Attribution supported property types are:

  type PropertyType is
       STRING                => java.lang.String
       INTEGER               => java.lang.Integer
       LONG                  => java.lang.Long
       FLOAT                 => java.lang.Float
       DOUBLE                => java.lang.Double     
       BOOLEAN               => java.lang.Boolean
       DATETIME              => java.util.Date
       COLLABID              => oracle.csi.CollabId
       PERSON                => oracle.csi.CollabId
 

For Minimum and Maximum values only Number and Date types are supported.

If isAggregate is true the definition may hold a list of values. Setting isAggregate to true will require the user to specify a list of values instead of a scalar with the following exceptions: Minimum value, Maximum value must be scalers. Allowed values is a single dimensioned list of scaler values. List of lists is NOT supported.

Members

Show inherited members

Projections
Name Type Required Description

aggregate

boolean

Returns true/false based on whether this AttributionDefinition can hold a collection (list) of values.

allowedValues

collabProperties

Gets the allowed values for this AttributeDefinition.

collabId

beeId

CollabId of the snapshot

defaultValue

anyType

Returns the default value for this AttributeDefinition.

description

string

Gets the description of this AttributeDefinition.

handle

beeId<attributeDefinition>

Gets the Handle associated with this AttributeDefinition.

maximumValue

anyType

Returns the maximum value allowed for this AttributeDefinition.

maximumValueInclusive

boolean

Returns true/false based on whether the maximum value itself is allowed for this AttributeDefinition.

minimumValue

anyType

Returns the minimum value allowed for this AttributeDefinition.

minimumValueInclusive

boolean

Returns true/false based on whether the minimum value itself is allowed for this AttributeDefinition.

name

string

Gets the name of this AttributeDefinition.

searchable

boolean

Returns true/false based on whether this AttributeDefinition is searchable.

type

propertyType

Gets the type of this AttributeDefinition.

Hierarchy

Inherits From

Examples

Below are examples in XML formats. All examples are shown with all inherited members. Quoting when required is part of the examples, but you must obviously populate with your own data.

XML Example

(show inherited members)

<obh:attributeDefinition xsi:type="obh:attributeDefinition" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <aggregate>your_boolean_0</aggregate>
        <allowedValues>your_collabProperties_0</allowedValues>
        <collabId>your_beeId_0</collabId>
        <defaultValue>your_anyType_0</defaultValue>
        <description>your_string_0</description>
        <handle>your_beeId_0</handle>
        <maximumValue>your_anyType_0</maximumValue>
        <maximumValueInclusive>your_boolean_0</maximumValueInclusive>
        <minimumValue>your_anyType_0</minimumValue>
        <minimumValueInclusive>your_boolean_0</minimumValueInclusive>
        <name>your_string_0</name>
        <searchable>your_boolean_0</searchable>
        <type>your_propertyType_0</type>
</obh:attributeDefinition>

Referenced By Representaions