ERXPartial (Project Wonder Reference Documentation)

java.lang.Object
- er.extensions.partials.ERXPartial<T>

Type Parameters:

T - the EO class that this is a partial of

All Implemented Interfaces:

Serializable
```
public class ERXPartial<T extends ERXGenericRecord>
extends Object
implements Serializable
```
For overview information on partials, read the package.html in er.extensions.partials.
ERXPartial is the superclass of all partial entity implementations. ERXPartial is not itself an EO, but is acts as a partial typesafe wrapper around an existing base EO (which must extend ERXPartialGenericRecord). For instance, the base entity might be Person, but the partial may be CalendarPerson which might expose methods like calendarPerson.scheduledEvents().
To obtain a partial, you request an instance from a base EO. Take the Person example from above. You can access the interface of the CalendarPerson partial in two ways:
```
 Person person = ...;
 CalendarPerson calendarPerson = person.partialForClass(CalendarPerson.class);
 
```
or
```
 Person person = ...;
 CalendarPerson calendarPerson = person.valueForKey("@CalendarPerson");
 
```
which allows easy use of the partial entities in component bindings, like person.@CalendarPerson.scheduledEvents.
See Also:

Serialized Form

Author:

mschrag

Constructor Summary

Constructors
Constructor and Description

ERXPartial()

Constructors
Constructor and Description
`ERXPartial()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addObjectToBothSidesOfRelationshipWithKey(EORelationshipManipulation eo, String key)` Calls `_primaryEO.addObjectToBothSidesOfRelationshipWithKey(eo, key)`.
`void`	`awakeFromFetch(EOEditingContext editingContext)` Delegated from the base entity.
`void`	`delete()` Delegated from the base entity.
`void`	`didDelete(EOEditingContext ec)` Delegated from the base entity.
`void`	`didInsert()` Delegated from the base entity.
`void`	`didRevert(EOEditingContext ec)` Delegated from the base entity.
`void`	`didUpdate()` Delegated from the base entity.
`EOEditingContext`	`editingContext()` Returns the primary EO's `EOEditingContext`.
`void`	`excludeObjectFromPropertyWithKey(Object value, String key)` Calls `_primaryEO.excludeObjectFromPropertyWithKey(value, key)`.
`void`	`includeObjectIntoPropertyWithKey(Object value, String key)` Calls `_primaryEO.includeObjectIntoPropertyWithKey(value, key)`.
`protected void`	`init(EOEditingContext editingContext)` Delegated from the base entity.
`boolean`	`isPartialKeypath(String keypath)` Tests the given keypath to see if it is a valid attribute or relationship for this partial.
`void`	`mightDelete()` Delegated from the base entity.
`static NSArray<String>`	`partialAttributes()` When partial entities are initialized the `EOEntity` is removed from the model, making it impossible to query attributes and relationships later.
`static NSArray<String>`	`partialProperties()` When partial entities are initialized the `EOEntity` is removed from the model making it impossible to query attributes and relationships later.
`static NSArray<String>`	`partialRelationships()` When partial entities are initialized the `EOEntity` is removed from the model making it impossible to query attributes and relationships later.
`T`	`primaryEO()` Returns this partial's primary EO.
`void`	`removeObjectFromBothSidesOfRelationshipWithKey(EORelationshipManipulation eo, String key)` Calls `_primaryEO.removeObjectFromBothSidesOfRelationshipWithKey(eo, key)`.
`void`	`setPrimaryEO(T primaryEO)` Sets this partial's primary EO.
`Object`	`storedValueForKey(String key)` Returns `_primaryEO.storedValueForKey(key)`.
`void`	`takeStoredValueForKey(Object value, String key)` Calls `_primaryEO.takeStoredValueForKey(value, key)`.
`void`	`validateForInsert()` Delegated from the base entity.
`void`	`validateForSave()` Delegated from the base entity.
`void`	`validateForUpdate()` Delegated from the base entity.
`Object`	`validateTakeValueForKeyPath(Object value, String keyPath)` Delegated from the base entity.
`Object`	`validateValueForKey(Object value, String key)` Delegated from the base entity.
`void`	`willDelete()` Delegated from the base entity.
`void`	`willInsert()` Delegated from the base entity.
`void`	`willRevert()` Delegated from the base entity.
`void`	`willUpdate()` Delegated from the base entity.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ERXPartial
```
public ERXPartial()
```
- Method Detail
  - setPrimaryEO
```
public void setPrimaryEO(T primaryEO)
```
    Sets this partial's primary EO.
    
    Parameters:
    
    primaryEO - the primary EO
  - primaryEO
```
public T primaryEO()
```
    Returns this partial's primary EO.
    
    Returns:
    
    primary EO
  - partialAttributes
```
public static NSArray<String> partialAttributes()
```
    When partial entities are initialized the EOEntity is removed from the model, making it impossible to query attributes and relationships later.
    
    Returns:
    
    array of String keys for the partial entity attributes
  - partialRelationships
```
public static NSArray<String> partialRelationships()
```
    When partial entities are initialized the EOEntity is removed from the model making it impossible to query attributes and relationships later.
    
    Returns:
    
    array of String keys for the partial entity relationships
  - partialProperties
```
public static NSArray<String> partialProperties()
```
    When partial entities are initialized the EOEntity is removed from the model making it impossible to query attributes and relationships later.
    
    Returns:
    
    array of String keys for the partial entity attributes and relationships
  - isPartialKeypath
```
public boolean isPartialKeypath(String keypath)
```
    Tests the given keypath to see if it is a valid attribute or relationship for this partial.
    
    Parameters:
    
    keypath - a keypath
    
    Returns:
    
    true if keypath matches an attribute or relationship
  - editingContext
```
public EOEditingContext editingContext()
```
    Returns the primary EO's EOEditingContext.
    
    Returns:
    
    primary EO's EOEditingContext
  - storedValueForKey
```
public Object storedValueForKey(String key)
```
    Returns _primaryEO.storedValueForKey(key).
    
    Parameters:
    
    key - a key
    
    Returns:
    
    _primaryEO.storedValueForKey(key)
  - takeStoredValueForKey
```
public void takeStoredValueForKey(Object value,
                                  String key)
```
    Calls _primaryEO.takeStoredValueForKey(value, key).
    
    Parameters:
    
    value - a value
    
    key - a key
  - includeObjectIntoPropertyWithKey
```
public void includeObjectIntoPropertyWithKey(Object value,
                                             String key)
```
    Calls _primaryEO.includeObjectIntoPropertyWithKey(value, key).
    
    Parameters:
    
    value - a value
    
    key - a key
  - excludeObjectFromPropertyWithKey
```
public void excludeObjectFromPropertyWithKey(Object value,
                                             String key)
```
    Calls _primaryEO.excludeObjectFromPropertyWithKey(value, key).
    
    Parameters:
    
    value - a value
    
    key - a key
  - addObjectToBothSidesOfRelationshipWithKey
```
public void addObjectToBothSidesOfRelationshipWithKey(EORelationshipManipulation eo,
                                                      String key)
```
    Calls _primaryEO.addObjectToBothSidesOfRelationshipWithKey(eo, key).
    
    Parameters:
    
    eo - an EORelationshipManipulation
    
    key - a key
  - removeObjectFromBothSidesOfRelationshipWithKey
```
public void removeObjectFromBothSidesOfRelationshipWithKey(EORelationshipManipulation eo,
                                                           String key)
```
    Calls _primaryEO.removeObjectFromBothSidesOfRelationshipWithKey(eo, key).
    
    Parameters:
    
    eo - an EORelationshipManipulation
    
    key - a key
  - awakeFromFetch
```
public void awakeFromFetch(EOEditingContext editingContext)
```
    Delegated from the base entity.
    
    Parameters:
    
    editingContext - this object's EOEditingContext
  - delete
```
public void delete()
```
    Delegated from the base entity.
  - mightDelete
```
public void mightDelete()
```
    Delegated from the base entity.
  - willDelete
```
public void willDelete()
                throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - didDelete
```
public void didDelete(EOEditingContext ec)
```
    Delegated from the base entity.
    
    Parameters:
    
    ec - this object's EOEditingContext
  - willInsert
```
public void willInsert()
```
    Delegated from the base entity.
  - didInsert
```
public void didInsert()
```
    Delegated from the base entity.
  - willUpdate
```
public void willUpdate()
```
    Delegated from the base entity.
  - didUpdate
```
public void didUpdate()
```
    Delegated from the base entity.
  - willRevert
```
public void willRevert()
```
    Delegated from the base entity.
  - didRevert
```
public void didRevert(EOEditingContext ec)
```
    Delegated from the base entity.
    
    Parameters:
    
    ec - this object's EOEditingContext
  - validateForSave
```
public void validateForSave()
                     throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - validateForInsert
```
public void validateForInsert()
                       throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - validateForUpdate
```
public void validateForUpdate()
                       throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - validateTakeValueForKeyPath
```
public Object validateTakeValueForKeyPath(Object value,
                                          String keyPath)
                                   throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Parameters:
    
    value - a value
    
    keyPath - a keypath
    
    Returns:
    
    the destination object
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - validateValueForKey
```
public Object validateValueForKey(Object value,
                                  String key)
                           throws NSValidation.ValidationException
```
    Delegated from the base entity.
    
    Parameters:
    
    value - a value
    
    key - a key
    
    Returns:
    
    the destination object
    
    Throws:
    
    NSValidation.ValidationException - in the case of a validation failure
  - init
```
protected void init(EOEditingContext editingContext)
```
    Delegated from the base entity. A partial entity can override this method to perform object initialisation. It will be called when the base entity's init() method is called.
    
    Parameters:
    
    editingContext - this object's EOEditingContext

Class ERXPartial<T extends ERXGenericRecord>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ERXPartial

Method Detail

setPrimaryEO

primaryEO

partialAttributes

partialRelationships

partialProperties

isPartialKeypath

editingContext

storedValueForKey

takeStoredValueForKey

includeObjectIntoPropertyWithKey

excludeObjectFromPropertyWithKey

addObjectToBothSidesOfRelationshipWithKey

removeObjectFromBothSidesOfRelationshipWithKey

awakeFromFetch

delete

mightDelete

willDelete

didDelete

willInsert

didInsert

willUpdate

didUpdate

willRevert

didRevert

validateForSave

validateForInsert

validateForUpdate

validateTakeValueForKeyPath

validateValueForKey

init