OAObject (OA Java Code Documentation)

java.lang.Object
- com.viaoa.object.OAObject

All Implemented Interfaces:

Serializable, Comparable

Direct Known Subclasses:

DBMetaData, IODummy, NextNumber, OAEditMode, OAGroupBy, OALeftJoin, OALogRecord, OAObjectLocal, VDate, VDateTime, VDouble, VInteger, VLong, VNameValue, VString, VTime
```
public class OAObject
extends Object
implements Serializable, Comparable
```
OAObject is the Base Class used for Application Data Objects. It is a central class for OA, where all other objects are designed to automatically work with the OAObject class, along with the Hub collection class.
OAObjects have built-in functionality to allow it to work with other Classes. This includes other OAObjects, Hub Collections, any datasource/database, JFC component, JSP component, XML, other applications (distributed) and any other Class.

Subclasses of OAObject can be created that add properties and methods for building customized software applications. OAObject then supplies the capability for these subclasses to automatically work with any OA Enabled Class.
This is a summary of some of the features included in OAObject.
- Object Key - property values that makes this object unique.
- Reference Information - how objects are related to other object. All references use the actual objects and not the key (or foreign key value). References types include one-one, one-many, many-many, recursive self references, owned and un-owned references, and more.
- Manages reference objects when working with database/datasource.
- "Moves" objects when changes are made to a reference property.
- Methods to set and get properties and convert from and to Strings.
- Store miscellaneous data in name/value pairs, where name is case insensitive.
- Initialization during creation
- Null Values - to know if a primitive property value is null
- Knows which Hub Collections that an object is a member of.
- Handles events for object, including property changes and calculated properties.
- Knows if object is "new"
- Cascading rules. Cancel, Save, Delete can be cascaded to reference objects.
- Works directly with OADataSource for storing and retrieving objects.
- Save Method
- Delete Method
- Calculated Properties - properties that rely on other properties or objects for their value.
- Serialization Support - to file/stream, other applications using RMI
- XML support - reading and writing
- Locking
- Client/Server - changes to objects can be automatically updated on other computers.
This is a listing of the types of relationships that an OAObject can have with another OAObject. This information is built into the object information. Relationships between objects are "two-way", meaning that both objects are related to each other.
- One-One relationship
- One-Many relationship
- Many-Many relationship
- Recursive - this is where an object can have many children objects of the same class and each of these children can themselves have children, recursively.
- An Owned relationship is one where the children can not exist without the parent (owner) and all are treated as a single unit.
- Cascading Rules for save, delete, cancel
Managing Relationships
OAObject manages the relationships between objects, and is responsible for retrieving and populating reference objects and for managing changes. An OAObject subclass does not have to have any code to handle retrieving or storing reference objects, OAObject does it completely. If a reference property is changed, then OAObject manages the change so that other objects are updated correctly.
For example, if a Department has many Employees, and an Employee has one Department: if an Employee's Department is changed, then the Employee object is removed from the original Department collection and added to the new assigned Department collection. This also works when an Employee is added to a different Departments Employee collection - the Employee's Department property is changed to the newly assigned Department.
Working with DataSources
OAObjects work directly with OADataSource for initializing properties, saving, deleting. This is all done so that the OAObjects are independent from datasource/database.
For more information about this package, see documentation.
Author:

Vince Via

See Also:

for observable collection class that has "linkage" features for automatically managing relationships. see OAHtmlSelect for datasource independent queries based on object and property paths., Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CASCADE_ALL_LINKS` Cascade rule where all reference objects are followed, even if cascade rule is false.
`static int`	`CASCADE_LINK_RULES` Cascade rule where all defined rules for references will be included.
`static int`	`CASCADE_NONE` Cascade rule where no reference objects will be included.
`static int`	`CASCADE_OWNED_LINKS` Cascade rule where all only the owned references will be included.
`protected boolean`	`changedFlag`
`static int`	`cntFinal`
`static int`	`cntNew`
`protected boolean`	`deletedFlag`
`protected int`	`guid`
`protected boolean`	`newFlag`
`protected byte[]`	`nulls`
`static Logger`	`OALOG`
`protected OAObjectKey`	`objectKey`
`protected Object[]`	`properties` managed by OAObjectPropertyDelegate.java
`protected WeakReference<Hub<?>>[]`	`weakhubs`

Constructor Summary

Constructors
Constructor and Description

OAObject()
Creates new OAObject and calls OAObjectDelegate.initialize()

Constructors
Constructor and Description
`OAObject()` Creates new OAObject and calls OAObjectDelegate.initialize()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`afterDelete()` called after an object is deleted.
`void`	`afterLoad()` Called after an object has been loaded from a datasource.
`void`	`afterSave()` called after an object is saved
`boolean`	`beginServerOnly()` Makes sure that the following code is only ran on the server.
`static Object`	`callRemote(Hub hub, Object... args)`
`boolean`	`canDelete()`
`boolean`	`canSave()`
`int`	`compareTo(Object obj)`
`void`	`copyInto(OAObject toObject)`
`OAObject`	`createCopy()` Copies the properties and some of the links from a source object (this) to a new object.
`Object`	`createCopy(String[] excludePropertyNames)`
`void`	`delete()` Remove this object from all hubs and deletes object from OADataSource.
`void`	`endServerOnly()`
`boolean`	`equals(Object obj)` OAObjects are equal if: the objects are the same address.
`protected void`	`finalize()` Removes object from HubController and calls super.finalize().
`Object`	`find(String propertyPath, Object value)` Using a propertyPath from this object, find the first matching object.
`Object[]`	`findAll(String propertyPath, Object value)` Using a propertyPath from this object, find all of the matching objects.
`protected void`	`fireBeforePropertyChange(String property, boolean oldObj, boolean newObj)`
`protected void`	`fireBeforePropertyChange(String property, double oldObj, double newObj)`
`protected void`	`fireBeforePropertyChange(String property, int oldObj, int newObj)`
`protected void`	`fireBeforePropertyChange(String property, long oldObj, long newObj)`
`protected void`	`fireBeforePropertyChange(String propertyName, Object oldObj, Object newObj)`
`protected void`	`fireBeforePropertyChange(String propertyName, Object oldObj, Object newObj, boolean bLocalOnly)` Used to manage property changes.
`protected void`	`fireLocalPropertyChange(String property)`
`protected void`	`fireLocalPropertyChange(String property, int oldObj, int newObj)`
`protected void`	`fireLocalPropertyChange(String property, Object oldObj, Object newObj)`
`protected void`	`firePropertyChange(String propertyName)`
`protected void`	`firePropertyChange(String property, boolean oldObj, boolean newObj)`
`protected void`	`firePropertyChange(String property, double oldObj, double newObj)`
`protected void`	`firePropertyChange(String property, int oldObj, int newObj)`
`protected void`	`firePropertyChange(String property, long oldObj, long newObj)`
`protected void`	`firePropertyChange(String propertyName, Object oldObj, Object newObj)`
`protected void`	`firePropertyChange(String propertyName, Object oldObj, Object newObj, boolean bLocalOnly)`
`boolean`	`getAutoAdd()`
`protected byte[]`	`getBlob(String linkPropertyName)` DataSource independent method to retrieve a blob/byte[] property.
`boolean`	`getChanged()` Returns true if this object is new or any changes have been made to this object or any objects in Links that are CASCADE=true
`boolean`	`getChanged(boolean bIncludeLinks)`
`boolean`	`getChanged(int relationshipType)` Returns true if this object is new or any changes have been made to this object or any objects in Links that are TYPE=MANY and CASCADE=true that match the relationshipType parameter.
`static boolean`	`getDebugMode()`
`boolean`	`getDeleted()` Flag to know if object was deleted.
`static boolean`	`getFinalizeSave()`
`int`	`getGuid()`
`protected Hub`	`getHub(String linkPropertyName)`
`protected Hub`	`getHub(String linkPropertyName, Hub hubMatch)`
`protected Hub`	`getHub(String linkPropertyName, String sortOrder)` DataSource independent method to retrieve a reference property that is a Hub Collection.
`protected Hub`	`getHub(String linkPropertyName, String sortOrder, boolean bSequence)`
`protected Hub`	`getHub(String linkPropertyName, String sortOrder, boolean bSequence, Hub hubMatch)`
`protected Hub`	`getHub(String linkPropertyName, String sortOrder, Hub hubMatch)`
`boolean`	`getNew()` Flag to know if object is new and has not been saved.
`static String`	`getOAVersion()`
`protected Object`	`getObject(String linkPropertyName)` DataSource independent method to retrieve a reference property.
`OAObjectKey`	`getObjectKey()`
`Object`	`getProperty(String propName)` Generic way for getting any property or value.
`String`	`getPropertyAsString(String propName)` Generic way for getting any property or value as a String value.
`String`	`getPropertyAsString(String propName, boolean bUseDefaultFormatting)`
`String`	`getPropertyAsString(String propName, String fmt)` Generic way for getting any property or value as a String value.
`String`	`getPropertyAsString(String propName, String fmt, String nullValue)`
`static OAObject`	`getUniqueInstance(Class<? extends OAObject> clazz, String propertyName, Object uniqueKey, boolean bAutoCreate)`
`int`	`hashCode()`
`Object`	`hierFind(String propertyName, String heirarchyPropertyPath)`
`boolean`	`isChanged()`
`boolean`	`isChanged(boolean bIncludeLinks)`
`boolean`	`isClient()`
`boolean`	`isDeleted()`
`boolean`	`isEmpty(Object obj)`
`boolean`	`isEnabled()`
`boolean`	`isEnabled(String propertyName)`
`boolean`	`isHubLoaded(String name)`
`boolean`	`isLoaded(String prop)`
`boolean`	`isLoading()` True if this object is in process of being loaded.
`boolean`	`isLocked()` Checks to see if object is locked.
`boolean`	`isNew()`
`boolean`	`isNull(String prop)`
`boolean`	`isPropertyLoaded(String prop)`
`boolean`	`isPropertyLocked(String prop)`
`boolean`	`isReferenceNull(String prop)`
`boolean`	`isReferenceObjectNull(String name)`
`boolean`	`isRemoteAvailable()` returns true if this is a oaclient and is not a remoteThread.
`static boolean`	`isRemoteAvailable(Hub hub)`
`boolean`	`isRemoteThread()` All OASync messages will be processed by an OARemoteThread.
`boolean`	`isServer()` This is used so that code will only be ran on the server.
`boolean`	`isUnique(String property, Object value)`
`boolean`	`isValidPropertyChange(String propertyName, Object oldValue, Object newValue)`
`boolean`	`isVisible()`
`boolean`	`isVisible(String propertyName)`
`void`	`loadReferences(boolean bIncludeCalc)`
`void`	`loadReferences(boolean bOne, boolean bMany, boolean bIncludeCalc)`
`void`	`loadReferences(int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc)`
`void`	`loadReferences(int maxLevelsToLoad, int additionalOwnedLevelsToLoad, boolean bIncludeCalc, int maxRefsToLoad)`
`void`	`lock()` Creates a lock on this object.
`protected Object`	`readResolve()`
`Object`	`remote(Object... args)`
`void`	`removeProperty(String name)` removing property.
`void`	`save()` This is used to save object to OADataSource and flag object as being saved and no longer new.
`void`	`save(int iCascadeRule)`
`void`	`saveAll()` Cascade save all links.
`boolean`	`sendMessages()`
`boolean`	`sendMessages(boolean b)` This is used to send out OASync messages, even if the currentThread is a OARemoteThread.
`void`	`setAutoAdd(boolean b)` Used to determine if an object should be added to a reference/master hub when one of it's OAObject properties is set.
`void`	`setChanged(boolean tf)` Flag to know if object has been changed.
`static void`	`setDebugMode(boolean b)`
`void`	`setDeleted(boolean tf)`
`static void`	`setFinalizeSave(boolean b)` Option to have finalized objects automatically saved to datasource.
`void`	`setHub(String linkPropertyName, Hub hub)`
`void`	`setNew(boolean b)`
`void`	`setNull(String propName)`
`void`	`setProperty(String propName, boolean value)`
`void`	`setProperty(String propName, double value)`
`void`	`setProperty(String propName, int value)` calls setProperty()
`void`	`setProperty(String propName, long value)`
`void`	`setProperty(String propName, Object value)`
`void`	`setProperty(String propName, Object value, String fmt)` Generic way for setting any property and storing name/value pairs. If propertyName is a valid property, then the setX method will be called, where X is the name of property. If propertyName is a valid property and obj is a String, obj will be converted to the correct obj that the method needs.
`boolean`	`startServerOnly()`
`void`	`unlock()` Unlocks this object.
`boolean`	`verifyCommand(String methodName)`
`boolean`	`wasDeleted()`

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

Field Detail
- OALOG
```
public static final Logger OALOG
```
- guid
```
protected int guid
```
- objectKey
```
protected volatile OAObjectKey objectKey
```
- changedFlag
```
protected volatile boolean changedFlag
```
- newFlag
```
protected volatile boolean newFlag
```
- nulls
```
protected byte[] nulls
```
- deletedFlag
```
protected volatile boolean deletedFlag
```
- weakhubs
```
protected transient volatile WeakReference<Hub<?>>[] weakhubs
```
- properties
```
protected transient volatile Object[] properties
```
  managed by OAObjectPropertyDelegate.java
- CASCADE_NONE
```
public static final int CASCADE_NONE
```
  Cascade rule where no reference objects will be included.
  
  See Also:
  
  Constant Field Values
- CASCADE_LINK_RULES
```
public static final int CASCADE_LINK_RULES
```
  Cascade rule where all defined rules for references will be included. This is default for save() and delete().
  
  See Also:
  
  Constant Field Values
- CASCADE_OWNED_LINKS
```
public static final int CASCADE_OWNED_LINKS
```
  Cascade rule where all only the owned references will be included.
  
  See Also:
  
  Constant Field Values
- CASCADE_ALL_LINKS
```
public static final int CASCADE_ALL_LINKS
```
  Cascade rule where all reference objects are followed, even if cascade rule is false.
  
  See Also:
  
  Constant Field Values
- cntNew
```
public static volatile int cntNew
```
- cntFinal
```
public static volatile int cntFinal
```

Constructor Detail
- OAObject
```
public OAObject()
```
  Creates new OAObject and calls OAObjectDelegate.initialize()
  
  See Also:
  
  OAObjectDelegate.initialize(com.viaoa.object.OAObject)

Method Detail

getOAVersion
```
public static String getOAVersion()
```

readResolve

protected Object readResolve()
                      throws ObjectStreamException

Throws:: ObjectStreamException

setProperty

public void setProperty(String propName,
                        boolean value)

setProperty

public void setProperty(String propName,
                        int value)

calls setProperty()

See Also:: setProperty(String, Object, String)

setProperty

public void setProperty(String propName,
                        long value)

setProperty

public void setProperty(String propName,
                        double value)

setProperty

public void setProperty(String propName,
                        Object value)

setNull
```
public void setNull(String propName)
```

setProperty
```
public void setProperty(String propName,
                        Object value,
                        String fmt)
```
Generic way for setting any property and storing name/value pairs.
If propertyName is a valid property, then the setX method will be called, where X is the name of property.
If propertyName is a valid property and obj is a String, obj will be converted to the correct obj that the method needs. Ex: if property method is for an OADate and obj = "05/04/65", then obj will be converted to a date.
If propertyName is a valid property that is an OAObject reference, then obj can be the ObjectKey value instead of the object itself.
if value is a String and property is a reference property, then value will be converted to match objectId type.

Ex: if employee.setProperty("Dept", 12), where Dept is a reference object, 12 will be used to find correct Dept obj
Ex: if employee.setProperty("Dept", "12"), "12" will be converted to int 12
Ex: employee.setSalary("32,500"), where salary property is an int. "32,500" will be converted to (int) 32500
Ex: employee.setHireDate("05/24/1988"), where HireDate property is an OADate and will be converted

If property is a Hub, then the following is done:
1. if hub has already loaded by calling getHub(propName), then value is converted to object and then added into Hub.
2. if hub has not been loaded by calling getHub(propName), but has been created:
  a: if value is an OAObject, then getHub(propName) is called and value is added to Hub.
  b: Hub for class OAObjectKey is created and value is converted to OAObjectKey and then added. When getHub(propName) is called, then all of the ObjectKeys will be converted to objects.
Parameters:

propName - name of property

value - new value

fmt - format to convert from

See Also:

OAObjectReflectDelegate.setProperty(com.viaoa.object.OAObject, java.lang.String, java.lang.Object, java.lang.String)

getProperty
```
public Object getProperty(String propName)
```
Generic way for getting any property or value. This will first look for get"PropName" method in this object (including superclass OAObject) Note: this supports property paths. For example: "dept.manager.lastname" from an Employee.class Note: if the property is of a primitive type, it can return null.

Parameters:

propName - can be a property path. If a Hub property is in the path and is not the last property, then the ActiveObject will be used.

getPropertyAsString
```
public String getPropertyAsString(String propName)
```
Generic way for getting any property or value as a String value.

getPropertyAsString

public String getPropertyAsString(String propName,
                                  boolean bUseDefaultFormatting)

getPropertyAsString
```
public String getPropertyAsString(String propName,
                                  String fmt)
```
Generic way for getting any property or value as a String value.

Parameters:

propName -

fmt -

Returns:

if value is null then "", else formatted value using OAConverter.toString(value,fmt)

getPropertyAsString

public String getPropertyAsString(String propName,
                                  String fmt,
                                  String nullValue)

removeProperty
```
public void removeProperty(String name)
```
removing property. If this property caused isChanged() to be true, then isChanged() will be false.

Parameters:

name - of property to remove. (case insensitive)

isValidPropertyChange

public boolean isValidPropertyChange(String propertyName,
                                     Object oldValue,
                                     Object newValue)

isEnabled

public boolean isEnabled(String propertyName)

isEnabled
```
public boolean isEnabled()
```

isVisible

public boolean isVisible(String propertyName)

isVisible
```
public boolean isVisible()
```

verifyCommand

public boolean verifyCommand(String methodName)

getNew
```
public boolean getNew()
```
Flag to know if object is new and has not been saved.

isNew
```
public boolean isNew()
```

setNew
```
public void setNew(boolean b)
```

getDeleted
```
public boolean getDeleted()
```
Flag to know if object was deleted.

wasDeleted
```
public boolean wasDeleted()
```

isDeleted
```
public boolean isDeleted()
```

setDeleted
```
public void setDeleted(boolean tf)
```

equals
```
public final boolean equals(Object obj)
```
OAObjects are equal if:
- the objects are the same address.
- the objects are the same class and the values of the propertyIds are equal. If both objects isNew() and either one has a its propertyId.isNull(), then they will never be equal.
- if the object being compared to is equal to the objectId property of this object.
Overrides:

equals in class Object

Parameters:

obj - object to compare to, object or objects[] to compare this object's objectId(s) with or OAObjectKey to compare with this object's objectId

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

compareTo
```
public int compareTo(Object obj)
```
Specified by:

compareTo in interface Comparable

getChanged
```
public boolean getChanged()
```
Returns true if this object is new or any changes have been made to this object or any objects in Links that are CASCADE=true

isChanged
```
public boolean isChanged()
```

getChanged

public boolean getChanged(boolean bIncludeLinks)

isChanged

public boolean isChanged(boolean bIncludeLinks)

getChanged
```
public boolean getChanged(int relationshipType)
```
Returns true if this object is new or any changes have been made to this object or any objects in Links that are TYPE=MANY and CASCADE=true that match the relationshipType parameter.

setChanged
```
public void setChanged(boolean tf)
```
Flag to know if object has been changed.
This is automatically set to true whenever firePropertyChange. It is set to false when save() is called.

Parameters:

tf - if false then all original values of changed properties will be removed.

createCopy
```
public OAObject createCopy()
```
Copies the properties and some of the links from a source object (this) to a new object. For links of type One, all of the links are used, the same ref object from the source object is used. For links of type Many, only the owned links are used, and clones of the objects are created in the Hub of the new object. Note: this is done on the server.

See Also:

OAObjectReflectDelegate.copyInto(OAObject, OAObject, String[], OACopyCallback)

createCopy

public Object createCopy(String[] excludePropertyNames)

copyInto

public void copyInto(OAObject toObject)

setFinalizeSave
```
public static void setFinalizeSave(boolean b)
```
Option to have finalized objects automatically saved to datasource. Default is false.

Parameters:

b - to set value

getFinalizeSave

public static boolean getFinalizeSave()

finalize
```
protected void finalize()
                 throws Throwable
```
Removes object from HubController and calls super.finalize().

Overrides:

finalize in class Object

Throws:

Throwable

isLoading
```
public boolean isLoading()
```
True if this object is in process of being loaded.

fireBeforePropertyChange

protected void fireBeforePropertyChange(String propertyName,
                                        Object oldObj,
                                        Object newObj,
                                        boolean bLocalOnly)

Used to manage property changes. Sends a "beforePropertyChange()" to all listeners of the Hubs that this object is a member of.

Parameters:: propertyName - is not case sensitive

fireBeforePropertyChange

protected void fireBeforePropertyChange(String propertyName,
                                        Object oldObj,
                                        Object newObj)

fireBeforePropertyChange

protected void fireBeforePropertyChange(String property,
                                        boolean oldObj,
                                        boolean newObj)

fireBeforePropertyChange

protected void fireBeforePropertyChange(String property,
                                        int oldObj,
                                        int newObj)

fireBeforePropertyChange

protected void fireBeforePropertyChange(String property,
                                        long oldObj,
                                        long newObj)

fireBeforePropertyChange

protected void fireBeforePropertyChange(String property,
                                        double oldObj,
                                        double newObj)

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldObj,
                                  Object newObj,
                                  boolean bLocalOnly)

firePropertyChange

protected void firePropertyChange(String propertyName,
                                  Object oldObj,
                                  Object newObj)

firePropertyChange

protected void firePropertyChange(String propertyName)

firePropertyChange

protected void firePropertyChange(String property,
                                  boolean oldObj,
                                  boolean newObj)

firePropertyChange

protected void firePropertyChange(String property,
                                  int oldObj,
                                  int newObj)

firePropertyChange

protected void firePropertyChange(String property,
                                  long oldObj,
                                  long newObj)

firePropertyChange

protected void firePropertyChange(String property,
                                  double oldObj,
                                  double newObj)

fireLocalPropertyChange

protected void fireLocalPropertyChange(String property,
                                       Object oldObj,
                                       Object newObj)

fireLocalPropertyChange

protected void fireLocalPropertyChange(String property)

fireLocalPropertyChange

protected void fireLocalPropertyChange(String property,
                                       int oldObj,
                                       int newObj)

getHub

protected Hub getHub(String linkPropertyName)

setHub

public void setHub(String linkPropertyName,
                   Hub hub)

getHub
```
protected Hub getHub(String linkPropertyName,
                     String sortOrder)
```
DataSource independent method to retrieve a reference property that is a Hub Collection.

Parameters:

linkPropertyName - name of property to retrieve. (case insensitive)

getHub

protected Hub getHub(String linkPropertyName,
                     String sortOrder,
                     boolean bSequence)

Parameters:: bSequence - if true, then a setAutoSequence will be called on the hub

getHub

protected Hub getHub(String linkPropertyName,
                     String sortOrder,
                     boolean bSequence,
                     Hub hubMatch)

Parameters:: bSequence - if true, then a setAutoSequence will be called on the hub

getHub

protected Hub getHub(String linkPropertyName,
                     String sortOrder,
                     Hub hubMatch)

getHub

protected Hub getHub(String linkPropertyName,
                     Hub hubMatch)

getObject
```
protected Object getObject(String linkPropertyName)
```
DataSource independent method to retrieve a reference property.
If reference object is not already loaded, then OADataSource will be used to retreive object.

isReferenceObjectNull

public boolean isReferenceObjectNull(String name)

getBlob
```
protected byte[] getBlob(String linkPropertyName)
```
DataSource independent method to retrieve a blob/byte[] property.
If reference object is not already loaded, then OADataSource will be used to retreive object.

save
```
public void save()
```
This is used to save object to OADataSource and flag object as being saved and no longer new.
It does the following:
1. calls canSave() to verify that object and its LinkInfo objects that TYPE=MANY and CASCADE=true can be saved. This will call this objects beforeSave() method. It will then call hubBeforeSave() for all listeners .
2. calls this Objects "onSave()" method. The default onSave() will call OADataSource to save.
3. calls listeners hubAfterSave()
4. calls "cascadeSave()" to save all Links with TYPE=ONE and CASCADE=true
See Also:

isChanged()

save
```
public void save(int iCascadeRule)
```
Parameters:

iCascadeRule - OR combination of CASCADE, ALL, FORCE, NOCHECK

See Also:

save()

canSave
```
public boolean canSave()
```

saveAll
```
public void saveAll()
```
Cascade save all links.

afterSave
```
public void afterSave()
```
called after an object is saved

delete
```
public void delete()
```
Remove this object from all hubs and deletes object from OADataSource. Calls canDelete first. see Hub#deleted

canDelete
```
public boolean canDelete()
```

afterDelete
```
public void afterDelete()
```
called after an object is deleted.

lock
```
public void lock()
```
Creates a lock on this object. see OALock#lock(Object,Object,Object)

unlock
```
public void unlock()
```
Unlocks this object.

isLocked
```
public boolean isLocked()
```
Checks to see if object is locked.

find
```
public Object find(String propertyPath,
                   Object value)
```
Using a propertyPath from this object, find the first matching object.
Example: find a SectionItem from a SectionItem
SectionItem si = (SectionItem) secItem.find("section.templateRow.template.templateRows.sections.sectionItems.item", item);

See Also:

findAll(String,Object)

findAll
```
public Object[] findAll(String propertyPath,
                        Object value)
```
Using a propertyPath from this object, find all of the matching objects.
Example: find a SectionItem from a SectionItem
SectionItem si = (SectionItem) secItem.find("section.templateRow.template.templateRows.sections.sectionItems.item", item);

See Also:

find(String,Object)

isNull
```
public boolean isNull(String prop)
```

isServer
```
public boolean isServer()
```
This is used so that code will only be ran on the server. If the current thread is an OAClientThread, then it will still send messages to other clients.

isClient
```
public boolean isClient()
```

isRemoteThread
```
public boolean isRemoteThread()
```
All OASync messages will be processed by an OARemoteThread.

sendMessages
```
public boolean sendMessages(boolean b)
```
This is used to send out OASync messages, even if the currentThread is a OARemoteThread.

sendMessages
```
public boolean sendMessages()
```

afterLoad
```
public void afterLoad()
```
Called after an object has been loaded from a datasource.

getObjectKey
```
public OAObjectKey getObjectKey()
```

getGuid
```
public int getGuid()
```

setAutoAdd
```
public void setAutoAdd(boolean b)
```
Used to determine if an object should be added to a reference/master hub when one of it's OAObject properties is set. If false, then the object will not be added to masterHubs until this is called with "true" or when oaObj is saved.

Parameters:

b - (default is true)

getAutoAdd
```
public boolean getAutoAdd()
```

isEmpty
```
public boolean isEmpty(Object obj)
```

isHubLoaded

public boolean isHubLoaded(String name)

loadReferences

public void loadReferences(boolean bIncludeCalc)

loadReferences

public void loadReferences(boolean bOne,
                           boolean bMany,
                           boolean bIncludeCalc)

loadReferences

public void loadReferences(int maxLevelsToLoad,
                           int additionalOwnedLevelsToLoad,
                           boolean bIncludeCalc)

loadReferences

public void loadReferences(int maxLevelsToLoad,
                           int additionalOwnedLevelsToLoad,
                           boolean bIncludeCalc,
                           int maxRefsToLoad)

callRemote

public static Object callRemote(Hub hub,
                                Object... args)

remote
```
public Object remote(Object... args)
```

isUnique

public boolean isUnique(String property,
                        Object value)

getUniqueInstance

public static OAObject getUniqueInstance(Class<? extends OAObject> clazz,
                                         String propertyName,
                                         Object uniqueKey,
                                         boolean bAutoCreate)

isRemoteAvailable
```
public boolean isRemoteAvailable()
```
returns true if this is a oaclient and is not a remoteThread.

isRemoteAvailable

public static boolean isRemoteAvailable(Hub hub)

isLoaded
```
public boolean isLoaded(String prop)
```

isPropertyLoaded

public boolean isPropertyLoaded(String prop)

isReferenceNull

public boolean isReferenceNull(String prop)

hierFind

public Object hierFind(String propertyName,
                       String heirarchyPropertyPath)

beginServerOnly
```
public boolean beginServerOnly()
```
Makes sure that the following code is only ran on the server. Any oasync changes will be sent to clients.

See Also:

endServerOnly()

startServerOnly
```
public boolean startServerOnly()
```

endServerOnly
```
public void endServerOnly()
```

setDebugMode

public static void setDebugMode(boolean b)

getDebugMode
```
public static boolean getDebugMode()
```

isPropertyLocked

public boolean isPropertyLocked(String prop)

Class OAObject

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OALOG

guid

objectKey

changedFlag

newFlag

nulls

deletedFlag

weakhubs

properties

CASCADE_NONE

CASCADE_LINK_RULES

CASCADE_OWNED_LINKS

CASCADE_ALL_LINKS

cntNew

cntFinal

Constructor Detail

OAObject

Method Detail

getOAVersion

readResolve

setProperty

setProperty

setProperty

setProperty

setProperty

setNull

setProperty

getProperty

getPropertyAsString

getPropertyAsString

getPropertyAsString

getPropertyAsString

removeProperty

isValidPropertyChange

isEnabled

isEnabled

isVisible

isVisible

verifyCommand

getNew

isNew

setNew

getDeleted

wasDeleted

isDeleted

setDeleted

equals

hashCode

compareTo

getChanged

isChanged

getChanged

isChanged

getChanged

setChanged

createCopy

createCopy

copyInto

setFinalizeSave

getFinalizeSave

finalize

isLoading

fireBeforePropertyChange

fireBeforePropertyChange

fireBeforePropertyChange

fireBeforePropertyChange

fireBeforePropertyChange

fireBeforePropertyChange

firePropertyChange

firePropertyChange

firePropertyChange

firePropertyChange

firePropertyChange

firePropertyChange