org.omus.core
Class PropertyUpdate

java.lang.Object
  |
  +--org.omus.core.PropertySet
        |
        +--org.omus.core.PropertyUpdate
All Implemented Interfaces:
java.io.Serializable

public final class PropertyUpdate
extends PropertySet

A subset of a PropertySet instance that gets passed to the syncUserProperties and syncGroupProperties methods in org.omus.ext.GroupExtension. It contains only the properties that were modified. It inherits all the methods of PropertySet and adds three additional methods to read and set an additional error code or to obtain a reference to the parent ProprtySet.

See Also:
Serialized Form

Method Summary
 java.lang.String getErrorCode()
          Returns the error code of this instance or null if none was specified yet.
 PropertySet getParent()
          Returns the parent object of this PropertyUpdate.
 void setErrorCode(java.lang.String err)
          Sets the error code of this instance to the specified string.
 
Methods inherited from class org.omus.core.PropertySet
contains, getOwner, getPrimaryKey, getType, getValue, isLoaded, isModified, load, loadAll, size, synchronize
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getErrorCode

public java.lang.String getErrorCode()
Returns the error code of this instance or null if none was specified yet.

setErrorCode

public void setErrorCode(java.lang.String err)
Sets the error code of this instance to the specified string. Useful if you want to abort a synchronization from within the syncUserProperties and syncGroupProperties methods in org.omus.ext.GroupExtension> and send a customized error code to the client. Otherwise a default error code would be sent.

getParent

public PropertySet getParent()
Returns the parent object of this PropertyUpdate. The PropertyUpdate instances that get passed to the syncUserProperties or syncGroupProperties methods in the GroupExtension class are only subsets of the original PropertySet objects, containing only those properties that were modified. In these cases you can use this method to obtain the parent object which contains all properties.