net.wotonomy.control
Interface EOEnterpriseObject

All Superinterfaces:
EODeferredFaulting, EOFaulting, EOKeyValueCoding, EOKeyValueCodingAdditions, EORelationshipManipulation, EOValidation, net.wotonomy.foundation.NSKeyValueCoding, net.wotonomy.foundation.NSKeyValueCodingAdditions
All Known Implementing Classes:
EOCustomObject, EOGenericRecord

public interface EOEnterpriseObject
extends EOKeyValueCodingAdditions, EORelationshipManipulation, EODeferredFaulting, EOValidation

EOEnterpriseObject defines the required methods a data object must implement to take full advantage of the control package.

Version:
$Revision: 894 $
Author:
michael@mpowers.net, $Author: cgruber $

Nested Class Summary
 
Nested classes/interfaces inherited from interface net.wotonomy.control.EOKeyValueCodingAdditions
EOKeyValueCodingAdditions.DefaultImplementation, EOKeyValueCodingAdditions.Utility
 
Nested classes/interfaces inherited from interface net.wotonomy.foundation.NSKeyValueCoding
net.wotonomy.foundation.NSKeyValueCoding.Null
 
Nested classes/interfaces inherited from interface net.wotonomy.foundation.NSKeyValueCoding
net.wotonomy.foundation.NSKeyValueCoding.Null
 
Field Summary
 
Fields inherited from interface net.wotonomy.foundation.NSKeyValueCoding
NullValue
 
Fields inherited from interface net.wotonomy.foundation.NSKeyValueCoding
NullValue
 
Method Summary
 net.wotonomy.foundation.NSArray allPropertyKeys()
          Returns a List of all property keys defined on this object.
 net.wotonomy.foundation.NSArray attributeKeys()
          Returns a list of all attributes defined on this object.
 void awakeFromFetch(EOEditingContext anEditingContext)
          Called when the object has first been fetched into the specified editing context.
 void awakeFromInsertion(EOEditingContext anEditingContext)
          Called when the object has been inserted into the specified editing context.
 net.wotonomy.foundation.NSDictionary changesFromSnapshot(net.wotonomy.foundation.NSDictionary snapshot)
          Returns a Map representing the delta of the current state from the state represented in the specified snapshot.
 EOClassDescription classDescription()
          Returns a class description for this object.
 EOClassDescription classDescriptionForDestinationKey(java.lang.String aKey)
          Returns a class description for the object at the other end of the specified relationship key.
 void clearProperties()
          Clears all property values for this object.
 int deleteRuleForRelationshipKey(java.lang.String aRelationshipKey)
          Returns the delete rule constant defined on EOClassDescription for the relationship defined by the specified key.
 EOEditingContext editingContext()
          Returns the editing context in which this object is registered.
 java.lang.String entityName()
          Returns the name of the entity that this object represents.
 java.lang.String eoDescription()
          Returns a String containing all property keys and values for this object.
 java.lang.String eoShallowDescription()
          Returns a String containing all attribute keys and values for this object.
 java.lang.String inverseForRelationshipKey(java.lang.String aRelationshipKey)
          Returns the key used to reference this object on the object at the other end of the specified relationship.
 boolean isToManyKey(java.lang.String aKey)
          Returns whether the specified relationship key represents a to-many relationship.
 boolean ownsDestinationObjectsForRelationshipKey(java.lang.String aKey)
          Returns whether the objects at the other end of the specified relationship should be deleted when this object is deleted.
 void propagateDeleteWithEditingContext(EOEditingContext aContext)
          Called to perform the delete propagation for this object on the specified editing context.
 void reapplyChangesFromDictionary(net.wotonomy.foundation.NSDictionary aDeltaSnapshot)
          Applies the changes from the specified snapshot to this object.
 net.wotonomy.foundation.NSDictionary snapshot()
          Returns a snapshot of the current state of this object.
 net.wotonomy.foundation.NSArray toManyRelationshipKeys()
          Returns a List of the to-many relationship keys for this object.
 net.wotonomy.foundation.NSArray toOneRelationshipKeys()
          Returns a List of the to-one relationship keys for this object.
 void updateFromSnapshot(net.wotonomy.foundation.NSDictionary aSnapshot)
          Applies the specified snapshot to this object, converting NSNulls to null and calling takeStoredValueForKey for each key in the Map.
 java.lang.String userPresentableDescription()
          Returns a short, stateful string representation of this object.
 void willChange()
          This method should be implemented to call EOObserverCenter.objectWillChange( this ), and it should be called by each setter method on this object before changes are made to the object's internal state.
 
Methods inherited from interface net.wotonomy.control.EOKeyValueCoding
handleQueryWithUnboundKey, handleTakeValueForUnboundKey, storedValueForKey, takeStoredValueForKey, takeValueForKey, unableToSetNullForKey, valueForKey
 
Methods inherited from interface net.wotonomy.foundation.NSKeyValueCodingAdditions
takeValueForKeyPath, takeValuesFromDictionary, valueForKeyPath, valuesForKeys
 
Methods inherited from interface net.wotonomy.control.EORelationshipManipulation
addObjectToBothSidesOfRelationshipWithKey, addObjectToPropertyWithKey, removeObjectFromBothSidesOfRelationshipWithKey, removeObjectFromPropertyWithKey
 
Methods inherited from interface net.wotonomy.control.EODeferredFaulting
willReadRelationship
 
Methods inherited from interface net.wotonomy.control.EOFaulting
clearFault, faultHandler, isFault, turnIntoFault, willRead, willRead
 
Methods inherited from interface net.wotonomy.control.EOValidation
validateForDelete, validateForInsert, validateForSave, validateForUpdate
 

Method Detail

allPropertyKeys

net.wotonomy.foundation.NSArray allPropertyKeys()
Returns a List of all property keys defined on this object. This includes both attributes and relationships.


attributeKeys

net.wotonomy.foundation.NSArray attributeKeys()
Returns a list of all attributes defined on this object. Attributes are all properties that are not relationships.


awakeFromFetch

void awakeFromFetch(EOEditingContext anEditingContext)
Called when the object has first been fetched into the specified editing context.


awakeFromInsertion

void awakeFromInsertion(EOEditingContext anEditingContext)
Called when the object has been inserted into the specified editing context.


changesFromSnapshot

net.wotonomy.foundation.NSDictionary changesFromSnapshot(net.wotonomy.foundation.NSDictionary snapshot)
Returns a Map representing the delta of the current state from the state represented in the specified snapshot. The result will contain only the keys that have changed and their values. Relationship keys will map to an NSArray that contains an NSArray of added objects and an NSArray of removed objects, in that order.


classDescription

EOClassDescription classDescription()
Returns a class description for this object.


classDescriptionForDestinationKey

EOClassDescription classDescriptionForDestinationKey(java.lang.String aKey)
Returns a class description for the object at the other end of the specified relationship key.


clearProperties

void clearProperties()
Clears all property values for this object. This method is called to clean-up an object that will no longer be used, and implementations should ensure that all references are set to null to prevent problems with garbage-collection.


deleteRuleForRelationshipKey

int deleteRuleForRelationshipKey(java.lang.String aRelationshipKey)
Returns the delete rule constant defined on EOClassDescription for the relationship defined by the specified key.


editingContext

EOEditingContext editingContext()
Returns the editing context in which this object is registered.


entityName

java.lang.String entityName()
Returns the name of the entity that this object represents.


eoDescription

java.lang.String eoDescription()
Returns a String containing all property keys and values for this object. Relationships should be represented by calling eoShallowDescription() on the object.


eoShallowDescription

java.lang.String eoShallowDescription()
Returns a String containing all attribute keys and values for this object. Relationships are not included.


inverseForRelationshipKey

java.lang.String inverseForRelationshipKey(java.lang.String aRelationshipKey)
Returns the key used to reference this object on the object at the other end of the specified relationship.


isToManyKey

boolean isToManyKey(java.lang.String aKey)
Returns whether the specified relationship key represents a to-many relationship.


ownsDestinationObjectsForRelationshipKey

boolean ownsDestinationObjectsForRelationshipKey(java.lang.String aKey)
Returns whether the objects at the other end of the specified relationship should be deleted when this object is deleted.


propagateDeleteWithEditingContext

void propagateDeleteWithEditingContext(EOEditingContext aContext)
Called to perform the delete propagation for this object on the specified editing context. All relationships should be processed according to their corresponding delete rule.


reapplyChangesFromDictionary

void reapplyChangesFromDictionary(net.wotonomy.foundation.NSDictionary aDeltaSnapshot)
Applies the changes from the specified snapshot to this object.

See Also:
changesFromSnapshot(NSDictionary)

snapshot

net.wotonomy.foundation.NSDictionary snapshot()
Returns a snapshot of the current state of this object. All property keys are mapped to their values; nulls are represented by NSNull.


toManyRelationshipKeys

net.wotonomy.foundation.NSArray toManyRelationshipKeys()
Returns a List of the to-many relationship keys for this object.


toOneRelationshipKeys

net.wotonomy.foundation.NSArray toOneRelationshipKeys()
Returns a List of the to-one relationship keys for this object.


updateFromSnapshot

void updateFromSnapshot(net.wotonomy.foundation.NSDictionary aSnapshot)
Applies the specified snapshot to this object, converting NSNulls to null and calling takeStoredValueForKey for each key in the Map.


userPresentableDescription

java.lang.String userPresentableDescription()
Returns a short, stateful string representation of this object.


willChange

void willChange()
This method should be implemented to call EOObserverCenter.objectWillChange( this ), and it should be called by each setter method on this object before changes are made to the object's internal state.



Copyright © 2006 null. All Rights Reserved.