ITransaction

​

Interface ITransaction

interface ITransaction

Extends com.amazon.apmf.IStandard This interface provides methods for building and committing UCC transactions.

​

Methods

​

commit()

void commit()

Commit this transaction

---

​

abandon()

void abandon()

Abandon this transaction

---

​

addTag()

void addTag(string name, com.amazon.kepler.ucc.v1_0.common.ElementId id)

Add a tag to this transaction

​

Parameters

name

string — Required the name of the tag

id

com.amazon.kepler.ucc.v1_0.common.ElementId — Required the id of the element to which the tag pertains

---

​

makeElement()

com.amazon.kepler.ucc.v1_0.common.ElementId makeElement()

Create a UCC element.

​

Returns

com.amazon.kepler.ucc.v1_0.common.ElementId id the globally unique id of the newly created element

---

​

destroyElement()

void destroyElement(com.amazon.kepler.ucc.v1_0.common.ElementId id)

Destroy a UCC element.

​

Parameters

id

com.amazon.kepler.ucc.v1_0.common.ElementId — Required The id of the UCC element to destroy

---

​

addChild()

void addChild(com.amazon.kepler.ucc.v1_0.common.ElementId parent, com.amazon.kepler.ucc.v1_0.common.ElementId child)

Add a child UCC element.

​

Parameters

parent

com.amazon.kepler.ucc.v1_0.common.ElementId — Required The id of the parent element.

child

com.amazon.kepler.ucc.v1_0.common.ElementId — Required The id of the child element to add.

---

​

insertChild()

void insertChild(com.amazon.kepler.ucc.v1_0.common.ElementId parent, u32 index, com.amazon.kepler.ucc.v1_0.common.ElementId child)

Insert a child UCC element. This method is used to insert an element before an existing child element. To add a child element to an empty container, or to the end of an existing list of children, use addChild instead.

​

Parameters

parent

com.amazon.kepler.ucc.v1_0.common.ElementId — Required The id of the parent element

index

u32 — Required the position at which to insert the new element (0 … childCount-1)

child

com.amazon.kepler.ucc.v1_0.common.ElementId — Required The id of the child element to insert

---

​

describeElement()

com.amazon.kepler.ucc.v1_0.common.IDescribeElement* describeElement(com.amazon.kepler.ucc.v1_0.common.ElementId id)

Describe an element.

​

Parameters

id

com.amazon.kepler.ucc.v1_0.common.ElementId — Required the id of the element to describe

​

Returns

com.amazon.kepler.ucc.v1_0.common.IDescribeElement* the IDescribeElement interface

---

​

clear()

void clear(com.amazon.kepler.ucc.v1_0.common.ElementId id)

Clear all properties and traits on an element.

​

Parameters

id

com.amazon.kepler.ucc.v1_0.common.ElementId — Required the id of the element to clear

---