kaos.core.csi.registration
Interface Property

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

PropertyImpl

public interface Property
extends java.io.Serializable

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

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.

Method Detail

setName

void setName(java.lang.String name)

Set the property name.

Parameters:

name - String containing the name of the property.

getName

java.lang.String getName()

Obtain the property name.

Returns:

String containing the name of the property.

setModificationResult

void setModificationResult(ModificationResult result)

Set the result of the property modification.

Parameters:

result - ModificationResult describing the result of modifying the property.

getModificationResult

ModificationResult getModificationResult()

Obtain the result of the property modification.

Returns:

ModificationResult describing the result of modifying the property.

setValue

void setValue(java.io.Serializable value)

Set the new value of the property.

Parameters:

value - Serializable containing the new valueof the property.

getValue

java.io.Serializable getValue()

Obtain the new value of the property.

Returns:

Serializable containing the new value of the property.

setDescription

void setDescription(java.lang.String desc)

Set the OWL description of the property to be modified.

Parameters:

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

getDescription

java.lang.String getDescription()

Return the OWL description of the property to be modified.

Returns:

String containing the OWL description of the property to be modified

setScope

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

Parameters:

scope - int specifying the scope of the property update.

getScope

int getScope()

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

Returns:

int specifying the scope of the property update.

getSequenceId

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.

Returns:

String containing the unique sequence id of this Property.

getPropertyObject

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.

Returns:

Serializable containing a property.

setPropertyObject

void setPropertyObject(java.io.Serializable property)

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

Parameters:

property - Serializable encapsulating a property.