kaos.core.csi.registration
Interface ModificationResult

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ModificationResultImpl

public interface ModificationResult
extends java.io.Serializable

Contains the modification type, its succes/failure flag and the description and error code for the modification failure.

Field Summary

static java.lang.String	ADD
static java.lang.String	ADD_ELEMENT_TO_LIST
static java.lang.String	ADD_ELEMENT_TO_TABLE
static java.lang.String	ADD_ELEMENTS_TO_LIST
static java.lang.String	ADD_ELEMENTS_TO_TABLE
static java.lang.String	DELETE
static java.lang.String	DELETE_ELEMENT_FROM_LIST
static java.lang.String	DELETE_ELEMENT_FROM_TABLE
static java.lang.String	DELETE_ELEMENTS_FROM_LIST
static java.lang.String	DELETE_ELEMENTS_FROM_TABLE
static java.lang.String	REPLACE

Method Summary

int	getModificationFailureCode() Return the error code of the modification failure.
java.lang.String	getModificationFailureDescription() Return the description of modification failure.
java.lang.String	getModificationType() Returns a String specifying the type of modification.
boolean	isSuccess() Obtain the success/failure status of the modification.
void	setModificationFailureCode(int code) Store the error code of the modification failure.
void	setModificationFailureDescription(java.lang.String desc) Store the description of modification failure.
void	setModificationType(java.lang.String type) Set the type of the modification.
void	setSuccess(boolean flag) Set the success/failure status of the modification.

Field Detail

ADD

static final java.lang.String ADD

See Also:

Constant Field Values

ADD_ELEMENT_TO_LIST

static final java.lang.String ADD_ELEMENT_TO_LIST

See Also:

Constant Field Values

ADD_ELEMENTS_TO_LIST

static final java.lang.String ADD_ELEMENTS_TO_LIST

See Also:

Constant Field Values

REPLACE

static final java.lang.String REPLACE

See Also:

Constant Field Values

DELETE

static final java.lang.String DELETE

See Also:

Constant Field Values

DELETE_ELEMENT_FROM_LIST

static final java.lang.String DELETE_ELEMENT_FROM_LIST

See Also:

Constant Field Values

DELETE_ELEMENTS_FROM_LIST

static final java.lang.String DELETE_ELEMENTS_FROM_LIST

See Also:

Constant Field Values

ADD_ELEMENT_TO_TABLE

static final java.lang.String ADD_ELEMENT_TO_TABLE

See Also:

Constant Field Values

ADD_ELEMENTS_TO_TABLE

static final java.lang.String ADD_ELEMENTS_TO_TABLE

See Also:

Constant Field Values

DELETE_ELEMENT_FROM_TABLE

static final java.lang.String DELETE_ELEMENT_FROM_TABLE

See Also:

Constant Field Values

DELETE_ELEMENTS_FROM_TABLE

static final java.lang.String DELETE_ELEMENTS_FROM_TABLE

See Also:

Constant Field Values

Method Detail

getModificationType

java.lang.String getModificationType()

Returns a String specifying the type of modification. The possible values are: ADD - a new key-value pair to the properties Hashtable. The key is the name of the property, the value is the value of the property. ADD_ELEMENT_TO_LIST - add the specified property value to the existing property, whose value is a List, for example, to add a domain name to the existing List of domain names. ADD_ELEMENTS_TO_LIST - to add the specified property value (which is a List) to the existing property, whose value is a List , for example, to add a List of new domain names to the existing List of domain names. REPLACE - to replace a value of the existing key-value pair with the specified property value. DELETE - delete the key-value pair from the properties Hashtable. DELETE_ELEMENT_FROM_LIST - to delete the specified property value from the existing property, whose value is a List, for example, to remove an ontological type from the existing List of types. DELETE_ELEMENTS_FROM_LIST - to remove the specified property value (which is a List) from the existing property, whose value is a List , for example, to remove a List of ontological types from the existing List of types. ADD_ELEMENT_TO_TABLE - add the specified property value ( a 1-element Hashtable)to the existing property, whose value is a Table, for example, to add an ontological type and its description to the existing Table of types and their descriptions. ADD_ELEMENTS_TO_TABLE - to add the specified property value (which is a Hashtable)) to the existing property, whose value is a Hashtable , for example, to add a Hashtable of new ontological types and their descriptions to the existing Hashtable of types and their descriptions. DELETE_ELEMENT_FROM_TABLE - to delete the specified property value from the existing property, whose value is a Hashtable, for example, to remove an ontological type and its description from the existing Hashtable of types. DELETE_ELEMENTS_FROM_TABLE - to remove the specified property value, which is a Collection of keys to remove from the existing property, whose value is a Hashtable, for example, to remove a Collection of ontological types from the existing Hashtable of types->descriptions.

Returns:

String describing the type of the modification.

setModificationType

void setModificationType(java.lang.String type)

Set the type of the modification.

Parameters:

type - String containing the type of modification.

setSuccess

void setSuccess(boolean flag)

Set the success/failure status of the modification.

Parameters:

flag - boolean indicating modification success/failure; true means success.

isSuccess

boolean isSuccess()

Obtain the success/failure status of the modification.

Returns:

boolean indicating modification success/failure; true means success

getModificationFailureDescription

java.lang.String getModificationFailureDescription()

Return the description of modification failure.

Returns:

String describing modification failure.

setModificationFailureDescription

void setModificationFailureDescription(java.lang.String desc)

Store the description of modification failure.

Parameters:

desc - String containing the description of modification failure.

getModificationFailureCode

int getModificationFailureCode()

Return the error code of the modification failure.

Returns:

int describing modification failure.

setModificationFailureCode

void setModificationFailureCode(int code)

Store the error code of the modification failure.

Parameters:

code - int containing the error code of the modification failure.