Oracle Beehive
  Oracle® Beehive RESTful Web Services API Reference
  Release 2 (2.0.1.7)
  E16658-04

Contents

Overview

Holds a set of modifications to be applied to an AttributeDefinition. Notes:

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

An attribute definition can hold a scalar value or a list of values. This behavior is defined by setting the Aggregate field of the attribute definition at creation time. Switching from scalar to list and vice versa is not supported and hence calling setAggregate() as part of an update operation will result in an IllegalArgumentException from the underlying implementation.

Members

Name Type Description

aggregate

boolean

Flag to indicate whether the AttributeDefinition can hold a list of values. This should only be set at creation time.

allowedValuesUpdater

collabPropertiesUpdater

CollabPropertiesUpdater to add or remove allowedValues for the AttributeDefinition.

defaultValue

anyType

Default value for the AttributeDefinition.

description

string

Description for the AttributeDefinition.

maximumValue

anyType

The Maximum Value, which must be a number or date

maximumValueInclusive

boolean

If true, this indicates that the MaximumValue is inclusive. Only applies for date/number types

minimumValue

anyType

The Minumum Value, which must be a number or date

minimumValueInclusive

boolean

If true, this indicates that the Minimum Value is inclusive. Only applies for date/number types

name

string

Name for the Attribute Definition.

searchable

boolean

Flag to indicate whether the AttributeDefinition is searchable.

type

propertyType

Property type for the AttributeDefinition.

Hierarchy

Inherits From

Examples

Below are examples in JSON and 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:attributeDefinitionUpdater xsi:type="obh:attributeDefinitionUpdater" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:aggregate>your_boolean_0</obh:aggregate>
        <obh:allowedValuesUpdater>your_collabPropertiesUpdater_0</obh:allowedValuesUpdater>
        <obh:defaultValue>your_anyType_0</obh:defaultValue>
        <obh:description>your_string_0</obh:description>
        <obh:maximumValue>your_anyType_0</obh:maximumValue>
        <obh:maximumValueInclusive>your_boolean_0</obh:maximumValueInclusive>
        <obh:minimumValue>your_anyType_0</obh:minimumValue>
        <obh:minimumValueInclusive>your_boolean_0</obh:minimumValueInclusive>
        <obh:name>your_string_0</obh:name>
        <obh:searchable>your_boolean_0</obh:searchable>
        <obh:type>your_propertyType_0</obh:type>
</obh:attributeDefinitionUpdater>

JSON Example

(show inherited members)

{
    "beeType":"attributeDefinitionUpdater",
        "aggregate":your_{http://www.oracle.com/beehive}aggregate_as_boolean0,
        "allowedValuesUpdater":{ your_{http://www.oracle.com/beehive}allowedValuesUpdater_as_collabPropertiesUpdater0 },
        "defaultValue":"your_{http://www.oracle.com/beehive}defaultValue_as_anyType0",
        "description":"your_{http://www.oracle.com/beehive}description_as_string0",
        "maximumValue":"your_{http://www.oracle.com/beehive}maximumValue_as_anyType0",
        "maximumValueInclusive":your_{http://www.oracle.com/beehive}maximumValueInclusive_as_boolean0,
        "minimumValue":"your_{http://www.oracle.com/beehive}minimumValue_as_anyType0",
        "minimumValueInclusive":your_{http://www.oracle.com/beehive}minimumValueInclusive_as_boolean0,
        "name":"your_{http://www.oracle.com/beehive}name_as_string0",
        "searchable":your_{http://www.oracle.com/beehive}searchable_as_boolean0,
        "type":{ your_{http://www.oracle.com/beehive}type_as_propertyType0 }
}

XML Schema


<xs:complexType name="attributeDefinitionUpdater">
    <xs:complexContent>
        <xs:extension base="tns:identifiableUpdater">
            <xs:sequence>
                <xs:element minOccurs="0" name="aggregate" type="xs:boolean"/>
                <xs:element minOccurs="0" name="allowedValuesUpdater" type="tns:collabPropertiesUpdater"/>
                <xs:element minOccurs="0" name="defaultValue" type="xs:anyType"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="maximumValue" type="xs:anyType"/>
                <xs:element minOccurs="0" name="maximumValueInclusive" type="xs:boolean"/>
                <xs:element minOccurs="0" name="minimumValue" type="xs:anyType"/>
                <xs:element minOccurs="0" name="minimumValueInclusive" type="xs:boolean"/>
                <xs:element minOccurs="0" name="name" type="xs:string"/>
                <xs:element minOccurs="0" name="searchable" type="xs:boolean"/>
                <xs:element minOccurs="0" name="type" type="tns:propertyType"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

        

References

The following data represents the references to attributeDefinitionUpdater

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions