kaos.core.csi.registration
Class PropertyImpl

java.lang.Object
  kaos.core.csi.registration.PropertyImpl

All Implemented Interfaces:

java.io.Serializable, Property

public class PropertyImpl
extends java.lang.Object
implements Property

$Revision: 1.7 $

See Also:

Serialized Form

Field Summary

protected java.lang.String	_description
protected ModificationResult	_modResult
protected java.lang.String	_name
protected java.io.Serializable	_propertyObj
protected int	_scope
protected java.io.Serializable	_value

Constructor Summary

PropertyImpl()
Specifies operations used to update entity properties.

PropertyImpl(java.lang.String name, java.lang.String description, ModificationResult modResult, int scope, java.io.Serializable value)

Method Summary

java.lang.String	getDescription() Return the OWL description of the property to be modified.
ModificationResult	getModificationResult() Obtain the result of the property modification.
java.lang.String	getName() Obtain the property name.
java.io.Serializable	getPropertyObject() Return a Serializable, encapsulating a property, which this Property represents.
int	getScope() Obtain the scope of the modification: 0 = PUBLIC scope indicates updates to the Directory Service 1 = PRIVATE scope indicates local updates only
java.lang.String	getSequenceId() Obtain the unique sequence id of this property.
java.io.Serializable	getValue() Obtain the new value of the property.
void	setDescription(java.lang.String desc) Set the OWL description of the property to be modified.
void	setModificationResult(ModificationResult result) Set the result of the property modification.
void	setName(java.lang.String name) Set the property name.
void	setPropertyObject(java.io.Serializable property) Set the given Serializable property, which this Property represents.
void	setScope(int scope) Set the scope of the modification: 0 = PUBLIC scope indicates updates to the Directory Service 1 = PRIVATE scope indicates local updates only
void	setValue(java.io.Serializable value) Set the new value of the property.
java.lang.String	toString() A utility method to create a String representation of the Property.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

_name

protected java.lang.String _name

_description

protected java.lang.String _description

_modResult

protected ModificationResult _modResult

_scope

protected int _scope

_value

protected java.io.Serializable _value

_propertyObj

protected java.io.Serializable _propertyObj

Constructor Detail

PropertyImpl

public PropertyImpl()

Specifies operations used to update entity properties. In addition to the property name, value, description and modification type, operations include also accessing modification result.

PropertyImpl

public PropertyImpl(java.lang.String name,
                    java.lang.String description,
                    ModificationResult modResult,
                    int scope,
                    java.io.Serializable value)

Method Detail

setName

public void setName(java.lang.String name)

Set the property name.

Specified by:

setName in interface Property

Parameters:

name - String containing the name of the property.

getName

public java.lang.String getName()

Obtain the property name.

Specified by:

getName in interface Property

Returns:

String containing the name of the property.

setModificationResult

public void setModificationResult(ModificationResult result)

Set the result of the property modification.

Specified by:

setModificationResult in interface Property

Parameters:

result - ModificationResult describing the result of modifying the property.

getModificationResult

public ModificationResult getModificationResult()

Obtain the result of the property modification.

Specified by:

getModificationResult in interface Property

Returns:

ModificationResult describing the result of modifying the property.

setValue

public void setValue(java.io.Serializable value)

Set the new value of the property.

Specified by:

setValue in interface Property

Parameters:

value - Serializable containing the new valueof the property.

getValue

public java.io.Serializable getValue()

Obtain the new value of the property.

Specified by:

getValue in interface Property

Returns:

Serializable containing the new value of the property.

setDescription

public void setDescription(java.lang.String desc)

Set the OWL description of the property to be modified.

Specified by:

setDescription in interface Property

Parameters:

desc - String containing the OWL description of the property to be modified.

getDescription

public java.lang.String getDescription()

Return the OWL description of the property to be modified.

Specified by:

getDescription in interface Property

Returns:

String containing the OWL description of the property to be modified

setScope

public void setScope(int scope)

Set the scope of the modification: 0 = PUBLIC scope indicates updates to the Directory Service 1 = PRIVATE scope indicates local updates only

Specified by:

setScope in interface Property

Parameters:

scope - int specifying the scope of the property update.

getScope

public int getScope()

Obtain the scope of the modification: 0 = PUBLIC scope indicates updates to the Directory Service 1 = PRIVATE scope indicates local updates only

Specified by:

getScope in interface Property

Returns:

int specifying the scope of the property update.

getSequenceId

public java.lang.String getSequenceId()

Obtain the unique sequence id of this property. This id is used in remote updates of this property in the DS. If the property update failes, then the Property is returned back to the requestor and the requestor can identify the failed property and not update its local collection of Properties.

Specified by:

getSequenceId in interface Property

Returns:

String containing the unique sequence id of this Property.

getPropertyObject

public java.io.Serializable getPropertyObject()

Return a Serializable, encapsulating a property, which this Property represents. This method is used to manipulate spatial properties, ex. Location3D, Orientation3D, etc.

Specified by:

getPropertyObject in interface Property

Returns:

Serializable containing a property.

setPropertyObject

public void setPropertyObject(java.io.Serializable property)

Set the given Serializable property, which this Property represents. The Serializable may have its own API.

Specified by:

setPropertyObject in interface Property

Parameters:

property - Serializable encapsulating a property.

toString

public java.lang.String toString()

A utility method to create a String representation of the Property.

Overrides:

toString in class java.lang.Object

Returns:

String representing the Property.