Kanzi Java API
Condition Class Referenceabstract

Condition for triggers. More...

Inheritance diagram for Condition:
[legend]
Collaboration diagram for Condition:
[legend]

Public Member Functions

boolean check ()
 Check function for condition.
 
void close ()
 Immediately releases the ownership of the backing native object, as opposed to deferring to garbage collection.
 
Trigger getTrigger ()
 Returns the pointer to a trigger to which an condition is attached. More...
 
- Public Member Functions inherited from KanziObject
boolean equals (Object object)
 
Domain getDomain ()
 Returns the domain the object belongs to. More...
 
Metaclass getDynamicMetaclass ()
 Returns the metaclass of the dynamic type of the object. More...
 
boolean isStale ()
 Test if the object is stale i.e. More...
 
void releaseOwnership ()
 Release ownership of the backing native object from this object. More...
 
void removeLocalValue (PropertyType propertyType)
 Removes the local value associated with the property. More...
 
boolean takeOwnership ()
 Take ownership of the backing native object in this object. More...
 

Static Public Member Functions

static Metaclass getStaticMetaclass ()
 Returns the metaclass of this class. More...
 
- Static Public Member Functions inherited from KanziObject
static Metaclass getStaticMetaclass ()
 Returns the metaclass of this class. More...
 

Protected Member Functions

 Condition (Domain domain, Metaclass metaclass)
 Creates a new action of a type derived from Condition. More...
 
void onAttach ()
 Callback called by Kanzi during attach.
 
abstract boolean onCheck ()
 Check function for condition. More...
 
void onDetach ()
 Callback called by Kanzi during detach.
 

Additional Inherited Members

- Public Attributes inherited from Condition
AbstractMetaclass ConditionMetaclass = new AbstractMetaclass("Kanzi.Condition")
 

Detailed Description

Condition for triggers.

Constructor & Destructor Documentation

Condition ( Domain  domain,
Metaclass  metaclass 
)
protected

Creates a new action of a type derived from Condition.

Call this from constructor of your custom Condition derivation.

Parameters
domainUI Domain where this condition belongs.
metaclassMetaclass data for this condition.

Member Function Documentation

static Metaclass getStaticMetaclass ( )
static

Returns the metaclass of this class.

Returns
Static instance of metaclass of this Condition.
Trigger getTrigger ( )

Returns the pointer to a trigger to which an condition is attached.

Returns
The attached trigger.
abstract boolean onCheck ( )
abstractprotected

Check function for condition.

Returns
true if the condition is valid