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

Beehive Development Kit » All Representations » clientApplication
Contents

Overview

Represents a native application that contains different ClientApplicationVersions. The application will be installed and run on user divices.

To install an application in a user device each ClientApplication should at least have one clientApplicationVersion. Each ClientApplication is uniquely identified by five parameters which are:

Projection.BASIC loads all the attributes loaded by Projection.EMPTY and the following attributes : name, display name, description, vendor, os, processor, device class, type, isPlatform(deprecated).

Projection.FULL includes all the attributes. The embedded attributes, e.g. Creator, Versions, are loaded with Projection.EMPTY.

Members

Name Type Required Description

attachedMarkers

marker[]
Set of marker elements associated with the entity.

attachedReminders

reminder[]
List of reminders attached to the entity

attachedSubscriptions

subscription[]
List of subscriptions attached to the entity

collabId

beeId
CollabId of the snapshot

createdOn

dateTime
Entity's creation date

creator

actor
The actor that created this entity

deleted

boolean
Deletion flag. If this property is set to true the entity is deleted.

description

string
Get the description.

deviceClass

string
Get the device class on which this ClientApplication can run.

displayName

string
Get the display name.

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

os

string
Get the OS on which this ClientApplication can run.

parent

entity
The parent for this entity.

processor

string
Get the processor on which this ClientApplication can run.

requiredPrivileges

privilege[]
Get required privileges.

snapshotId

string
Contains the snapshot identifier for this snapshot. Snapshot identifiers are used to implement optimistic locking on the server.

type

clientApplicationType
Get the type of this ClientApplication.

vendor

string
Get the vendor who this ClientApplication belongs to.

versions

clientApplicationVersion[]
Gets an ordered list of clientApplicationVersion. This list will be ordered based on the versionNum in clientApplicationVersion.

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:clientApplication xsi:type="obh:clientApplication" xmlns:obh="http://www.oracle.com/beehive" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
        <obh:attachedMarkers>your_marker_0</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_1</obh:attachedMarkers>
        <obh:attachedMarkers>your_marker_2</obh:attachedMarkers>
         <obh:attachedReminders>your_reminder_0</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_1</obh:attachedReminders>
        <obh:attachedReminders>your_reminder_2</obh:attachedReminders>
         <obh:attachedSubscriptions>your_subscription_0</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_1</obh:attachedSubscriptions>
        <obh:attachedSubscriptions>your_subscription_2</obh:attachedSubscriptions>
         <obh:collabId>your_beeId_0</obh:collabId>
         <obh:createdOn>your_dateTime_0</obh:createdOn>
         <obh:creator>your_actor_0</obh:creator>
         <obh:deleted>your_boolean_0</obh:deleted>
         <obh:description>your_string_0</obh:description>
         <obh:deviceClass>your_string_0</obh:deviceClass>
         <obh:displayName>your_string_0</obh:displayName>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:os>your_string_0</obh:os>
         <obh:parent>your_entity_0</obh:parent>
         <obh:processor>your_string_0</obh:processor>
         <obh:requiredPrivileges>your_privilege_0</obh:requiredPrivileges>
        <obh:requiredPrivileges>your_privilege_1</obh:requiredPrivileges>
        <obh:requiredPrivileges>your_privilege_2</obh:requiredPrivileges>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:type>your_clientApplicationType_0</obh:type>
         <obh:vendor>your_string_0</obh:vendor>
         <obh:versions>your_clientApplicationVersion_0</obh:versions>
        <obh:versions>your_clientApplicationVersion_1</obh:versions>
        <obh:versions>your_clientApplicationVersion_2</obh:versions>
 </obh:clientApplication>

JSON Example

(show inherited members)

{
    "beeType":"clientApplication",
        "attachedMarkers":[
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker0 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker1 },
            { your_{http://www.oracle.com/beehive}attachedMarkers_as_marker2 }
        ],
         "attachedReminders":[
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder0 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder1 },
            { your_{http://www.oracle.com/beehive}attachedReminders_as_reminder2 }
        ],
         "attachedSubscriptions":[
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription0 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription1 },
            { your_{http://www.oracle.com/beehive}attachedSubscriptions_as_subscription2 }
        ],
         "collabId":{ your_{http://www.oracle.com/beehive}collabId_as_beeId0 },
         "createdOn":"your_{http://www.oracle.com/beehive}createdOn_as_dateTime0",
         "creator":{ your_{http://www.oracle.com/beehive}creator_as_actor0 },
         "deleted":your_{http://www.oracle.com/beehive}deleted_as_boolean0,
         "description":"your_{http://www.oracle.com/beehive}description_as_string0",
         "deviceClass":"your_{http://www.oracle.com/beehive}deviceClass_as_string0",
         "displayName":"your_{http://www.oracle.com/beehive}displayName_as_string0",
         "modifiedBy":{ your_{http://www.oracle.com/beehive}modifiedBy_as_actor0 },
         "modifiedOn":"your_{http://www.oracle.com/beehive}modifiedOn_as_dateTime0",
         "name":"your_{http://www.oracle.com/beehive}name_as_string0",
         "os":"your_{http://www.oracle.com/beehive}os_as_string0",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "processor":"your_{http://www.oracle.com/beehive}processor_as_string0",
         "requiredPrivileges":[
            { your_{http://www.oracle.com/beehive}requiredPrivileges_as_privilege0 },
            { your_{http://www.oracle.com/beehive}requiredPrivileges_as_privilege1 },
            { your_{http://www.oracle.com/beehive}requiredPrivileges_as_privilege2 }
        ],
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
         "type":{ your_{http://www.oracle.com/beehive}type_as_clientApplicationType0 },
         "vendor":"your_{http://www.oracle.com/beehive}vendor_as_string0",
         "versions":[
            { your_{http://www.oracle.com/beehive}versions_as_clientApplicationVersion0 },
            { your_{http://www.oracle.com/beehive}versions_as_clientApplicationVersion1 },
            { your_{http://www.oracle.com/beehive}versions_as_clientApplicationVersion2 }
        ]
 }

XML Schema


<xs:complexType final="extension restriction" name="clientApplication">
    <xs:complexContent>
        <xs:extension base="tns:entity">
            <xs:sequence>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element minOccurs="0" name="deviceClass" type="xs:string"/>
                <xs:element minOccurs="0" name="displayName" type="xs:string"/>
                <xs:element minOccurs="0" name="os" type="xs:string"/>
                <xs:element minOccurs="0" name="processor" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="requiredPrivileges" nillable="true" type="tns:privilege"/>
                <xs:element minOccurs="0" name="type" type="tns:clientApplicationType"/>
                <xs:element minOccurs="0" name="vendor" type="xs:string"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="versions" nillable="true" type="tns:clientApplicationVersion"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to clientApplication

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