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

Beehive Development Kit » All Representations » policy
Contents

Overview

A Policy specifies a plan of actions to govern the lifecycles of the entities. The plan of actions are defined by rule-based policies and workflows. The policies may be placed in the enterprise,organization or workspace to let the policy authors collaborate to update the policies under full access control and version control.

A Policy can be created from the PolicyTemplate or just created on its own with out attaching to any template. When a policy is created from the policy template it can import a subset of the rule defintions from the template. At that time the client is prompted to provide the attribute values for which the attribute definitions are define with in the ruledefinitions.

A Policy is always attached to the container and it sits in that container. This means the parent and the scope of the policy are the same.

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

attributes

attributeApplication[]
the property values of the corresponding AttributeDefinition defined in the PolicyTemplate and PolicySchema are returned. Attribute Application values are not applicable if the policy is not created from PolicyTempate.

bonds

bond[]
List of artifact bonds

changeStatus

changeStatus
The change status of the artifact

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
Description of the policy

enabled

boolean
returns true if the policy is enabled, otherwise false. Policy is applicable and enforced only if the policy is enabled.

extensible

boolean

modifiedBy

actor
The actor that last modified the entity

modifiedOn

dateTime
The date when entity was last modified

name

string
Name of the entity.

parent

entity
The parent for this entity.

properties

collabProperties
The properties of the artifact that are shared among all the actors

rules

rule[]
The rules of a policy are either created in the policy itself or copied from the policy template

scope

anyType

(constrained to Container)
The level at which the policy is defined. It could be Enterprise, Organisation, Workspace

snapshotId

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

template

policyTemplate
Policy template can be option at the creation time of a policy

type

policyType

userCreatedOn

dateTime
The user creation date (if created offline)

userModifiedOn

dateTime
The user last modified date (if modified offline)

viewer

actor
The actor for which this artifact snapshot was loaded. All the artifact viewer properties in this snapshot are loaded for this actor.

viewerProperties

collabProperties
The viewer properties of the artifact that are private to loading actor

Hierarchy

Inherits From

Inherited By

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:policy xsi:type="obh:policy" 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:attributes>your_attributeApplication_0</obh:attributes>
        <obh:attributes>your_attributeApplication_1</obh:attributes>
        <obh:attributes>your_attributeApplication_2</obh:attributes>
         <obh:bonds>your_bond_0</obh:bonds>
        <obh:bonds>your_bond_1</obh:bonds>
        <obh:bonds>your_bond_2</obh:bonds>
         <obh:changeStatus>your_changeStatus_0</obh:changeStatus>
         <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:enabled>your_boolean_0</obh:enabled>
         <obh:extensible>your_boolean_0</obh:extensible>
         <obh:modifiedBy>your_actor_0</obh:modifiedBy>
         <obh:modifiedOn>your_dateTime_0</obh:modifiedOn>
         <obh:name>your_string_0</obh:name>
         <obh:parent>your_entity_0</obh:parent>
         <obh:properties>your_collabProperties_0</obh:properties>
         <obh:rules>your_rule_0</obh:rules>
        <obh:rules>your_rule_1</obh:rules>
        <obh:rules>your_rule_2</obh:rules>
         <obh:scope>your_anyType_0</obh:scope>
         <obh:snapshotId>your_string_0</obh:snapshotId>
         <obh:template>your_policyTemplate_0</obh:template>
         <obh:type>your_policyType_0</obh:type>
         <obh:userCreatedOn>your_dateTime_0</obh:userCreatedOn>
         <obh:userModifiedOn>your_dateTime_0</obh:userModifiedOn>
         <obh:viewer>your_actor_0</obh:viewer>
         <obh:viewerProperties>your_collabProperties_0</obh:viewerProperties>
 </obh:policy>

JSON Example

(show inherited members)

{
    "beeType":"policy",
        "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 }
        ],
         "attributes":[
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication0 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication1 },
            { your_{http://www.oracle.com/beehive}attributes_as_attributeApplication2 }
        ],
         "bonds":[
            { your_{http://www.oracle.com/beehive}bonds_as_bond0 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond1 },
            { your_{http://www.oracle.com/beehive}bonds_as_bond2 }
        ],
         "changeStatus":{ your_{http://www.oracle.com/beehive}changeStatus_as_changeStatus0 },
         "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",
         "enabled":your_{http://www.oracle.com/beehive}enabled_as_boolean0,
         "extensible":your_{http://www.oracle.com/beehive}extensible_as_boolean0,
         "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",
         "parent":{ your_{http://www.oracle.com/beehive}parent_as_entity0 },
         "properties":{ your_{http://www.oracle.com/beehive}properties_as_collabProperties0 },
         "rules":[
            { your_{http://www.oracle.com/beehive}rules_as_rule0 },
            { your_{http://www.oracle.com/beehive}rules_as_rule1 },
            { your_{http://www.oracle.com/beehive}rules_as_rule2 }
        ],
         "scope":"your_{http://www.oracle.com/beehive}scope_as_anyType0",
         "snapshotId":"your_{http://www.oracle.com/beehive}snapshotId_as_string0",
         "template":{ your_{http://www.oracle.com/beehive}template_as_policyTemplate0 },
         "type":{ your_{http://www.oracle.com/beehive}type_as_policyType0 },
         "userCreatedOn":"your_{http://www.oracle.com/beehive}userCreatedOn_as_dateTime0",
         "userModifiedOn":"your_{http://www.oracle.com/beehive}userModifiedOn_as_dateTime0",
         "viewer":{ your_{http://www.oracle.com/beehive}viewer_as_actor0 },
         "viewerProperties":{ your_{http://www.oracle.com/beehive}viewerProperties_as_collabProperties0 }
 }

XML Schema


<xs:complexType name="policy">
    <xs:complexContent>
        <xs:extension base="tns:artifact">
            <xs:sequence>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="attributes" nillable="true" type="tns:attributeApplication"/>
                <xs:element minOccurs="0" name="description" type="xs:string"/>
                <xs:element name="enabled" type="xs:boolean"/>
                <xs:element name="extensible" type="xs:boolean"/>
                <xs:element maxOccurs="unbounded" minOccurs="0"
                    name="rules" nillable="true" type="tns:rule"/>
                <xs:element minOccurs="0" name="scope" type="xs:anyType"/>
                <xs:element minOccurs="0" name="template" type="tns:policyTemplate"/>
                <xs:element minOccurs="0" name="type" type="tns:policyType"/>
            </xs:sequence>
        </xs:extension>
    </xs:complexContent>
</xs:complexType>

References

The following data represents the references to policy

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