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

Beehive Development Kit » All Representations » attributeTemplate
Contents

Overview

An attribute template is a template for creating an attribute according to a specific attribute definition. The AttributeTemplate also defines the behavioral aspects of the attribute with regards to collection of values. Note: For Minimum and Maximum values only Number and Date types are supported.

Members

Name Type Required Description

allowedValues

collabProperties
Gets the allowed values for the AttributeDefinition associated with this AttributeTemplate.

attributeDefinition

attributeDefinition
Returns the AttributeDefinition associated with this AttributeTemplate.

collabId

beeId
CollabId of the snapshot

defaultValue

anyType
Returns the default value defined for the AttributeDefinition associated with this AttributeTemplate.

final

boolean
Returns true/false based on whether this AttributeTemplate can be overridden / re-configured.

forceDefault

boolean
Returns true/false based on whether the value for the AttributeDefinition associated with this template is always forced to the default value when the attribute value is to be collected.

handle

beeId<attributeTemplate>
Returns the handle for this AttributeTemplate.

mandatory

boolean
Returns true/false based on whether a value is required for the AttributeDefinition associated with this template when the attribute value is to be collected. For example: When a category is applied to an entity it is mandatory to assign values (default or from user) to all Mandatory attributes as classified by the attribute templates for that category.

maxValueInclusive

boolean

maximumValue

anyType
Returns the maximum value allowed for the AttributeDefinition associated with this AttributeTemplate.

maximumValueInclusive

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

minValueInclusive

boolean

minimumValue

anyType
Returns the minimum value allowed for the AttributeDefinition associated with this AttributeTemplate.

minimumValueInclusive

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

prompted

boolean
Returns true/false based on whether an user is to be prompted for a value for the AttributeDefinition associated with this template when the attribute value is to be collected.

valueMissing

boolean
Returns true/false based on whether a value is missing for this attribute template.

Hierarchy

Inherits From

Applied Markers

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:attributeTemplate xsi:type="obh:attributeTemplate" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:allowedValues>your_collabProperties_0</obh:allowedValues>
         <obh:attributeDefinition>your_attributeDefinition_0</obh:attributeDefinition>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:defaultValue>your_anyType_0</obh:defaultValue>
         <obh:final>your_boolean_0</obh:final>
         <obh:forceDefault>your_boolean_0</obh:forceDefault>
         <obh:handle>your_beeId_0</obh:handle>
         <obh:mandatory>your_boolean_0</obh:mandatory>
         <obh:maxValueInclusive>your_boolean_0</obh:maxValueInclusive>
         <obh:maximumValue>your_anyType_0</obh:maximumValue>
         <obh:maximumValueInclusive>your_boolean_0</obh:maximumValueInclusive>
         <obh:minValueInclusive>your_boolean_0</obh:minValueInclusive>
         <obh:minimumValue>your_anyType_0</obh:minimumValue>
         <obh:minimumValueInclusive>your_boolean_0</obh:minimumValueInclusive>
         <obh:prompted>your_boolean_0</obh:prompted>
         <obh:valueMissing>your_boolean_0</obh:valueMissing>
 </obh:attributeTemplate>

JSON Example

(show inherited members)

{
    "beeType":"attributeTemplate",
        "allowedValues":{ your_{http://www.oracle.com/beehive}allowedValues_as_collabProperties0 },
         "attributeDefinition":{ your_{http://www.oracle.com/beehive}attributeDefinition_as_attributeDefinition0 },
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "defaultValue":"your_{http://www.oracle.com/beehive}defaultValue_as_anyType0",
         "final":your_{http://www.oracle.com/beehive}final_as_boolean0,
         "forceDefault":your_{http://www.oracle.com/beehive}forceDefault_as_boolean0,
         "handle":{ your_{http://www.oracle.com/beehive}handle_as_beeId0 },
         "mandatory":your_{http://www.oracle.com/beehive}mandatory_as_boolean0,
         "maxValueInclusive":your_{http://www.oracle.com/beehive}maxValueInclusive_as_boolean0,
         "maximumValue":"your_{http://www.oracle.com/beehive}maximumValue_as_anyType0",
         "maximumValueInclusive":your_{http://www.oracle.com/beehive}maximumValueInclusive_as_boolean0,
         "minValueInclusive":your_{http://www.oracle.com/beehive}minValueInclusive_as_boolean0,
         "minimumValue":"your_{http://www.oracle.com/beehive}minimumValue_as_anyType0",
         "minimumValueInclusive":your_{http://www.oracle.com/beehive}minimumValueInclusive_as_boolean0,
         "prompted":your_{http://www.oracle.com/beehive}prompted_as_boolean0,
         "valueMissing":your_{http://www.oracle.com/beehive}valueMissing_as_boolean0
 }

XML Schema


<xs:complexType name="attributeTemplate">
    <xs:complexContent>
        <xs:extension base="tns:identifiableSnapshot">
            <xs:sequence>
                <xs:element minOccurs="0" name="allowedValues" type="tns:collabProperties"/>
                <xs:element minOccurs="0" name="attributeDefinition" type="tns:attributeDefinition"/>
                <xs:element minOccurs="0" name="defaultValue" type="xs:anyType"/>
                <xs:element name="final" type="xs:boolean"/>
                <xs:element name="forceDefault" type="xs:boolean"/>
                <xs:element minOccurs="0" name="handle" type="tns:beeId"/>
                <xs:element name="mandatory" type="xs:boolean"/>
                <xs:element minOccurs="0" name="maxValueInclusive" type="xs:boolean"/>
                <xs:element minOccurs="0" name="maximumValue" type="xs:anyType"/>
                <xs:element minOccurs="0" name="maximumValueInclusive" type="xs:boolean"/>
                <xs:element minOccurs="0" name="minValueInclusive" type="xs:boolean"/>
                <xs:element minOccurs="0" name="minimumValue" type="xs:anyType"/>
                <xs:element minOccurs="0" name="minimumValueInclusive" type="xs:boolean"/>
                <xs:element name="prompted" type="xs:boolean"/>
                <xs:element name="valueMissing" type="xs:boolean"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to attributeTemplate

Referenced By Resources

Not Referenced Directly by Resources

Referenced By Representaions

Oracle Logo
Copyright © 2008, 2012, Oracle and/or its affiliates. All rights reserved.
Legal Notices