Overview  Package   Class 
Transfer version 1.1
FRAMES  

transfer.com.object
Class Object

WEB-INF.cftags.component
        extended by transfer.com.object.Object

public class Object

extends WEB-INF.cftags.component

The Object defintion BO

Constructor Summary
init(ObjectManager objectManager)
          Constructor
 
Method Summary
private void addFunction(Function Function)
          add a Custom Function
 void addManyToMany(ManyToMany manyToMany)
          add a Many to Many
 void addManyToOne(ManyToOne manyToOne)
          add a Many to Many
 void addOneToMany(OneToMany oneToMany)
          add a One to Many
 void addParentManyToMany(ManyToMany manyToMany)
          add a Parent Many to Many
 void addParentOneToMany(ParentOneToMany parentOneToMany)
          add a Parent One to Many
private void addProperty(Property Property)
          Adds a property to the Object
 void clearManyToMany()
          Removes all manytoone elements
 void clearManyToOne()
          Removes all manytoone elements
 void clearOneToMany()
          Removes all manytoone elements
private void clearProperties()
          clears the properies
 boolean containsManyToOne(string name)
          returns if this object has this manytoone
 boolean containsParentOneToMany(string className)
          Returns whether or not this object has this parent one to many
 string getClassName()
 string getDecorator()
private array getFunction()
 any getFunctionIterator()
          Gets the java.util.Iterator for the list of custom functions
 string getHash()
 string getLinkingClassName(string compositeName)
          returns the linking class name, throws an CompositionNotFoundException if nothing is found
private array getManyToMany()
 array getManyToManyArrayByLink(string className, [string filterName])
          returns an array of many to many properties that link to this class
 ManyToMany getManyToManyByName(string name)
          Gets a ManyToMany by name. Throws ManyToManyNotFoundException if the ManyToMany doesn't exist
 any getManyToManyIterator()
          Gets the java.util.Iterator for the list of Many to Many
private array getManyToOne()
 array getManyToOneArrayByLink(string className, [string filterName])
          returns an array of many to one properties that link to this class
 ManyToOne getManyToOneByName(string name)
          Gets a manytoone by name. Throws ManyToOneNotFoundException if the manytoone doesn't exist
 any getManyToOneIterator()
          Gets the java.util.Iterator for the list of Many to One
private ObjectManager getObjectManager()
 string getObjectName()
private array getOneToMany()
 array getOneToManyArrayByLink(string className, [string filterName])
          returns an array of one to many properties that link to this class
 OneToMany getOneToManyByName(string name)
          Gets a OneToMany by name. Throws OneToManyNotFoundException if the OneToMany doesn't exist
 any getOneToManyIterator()
          Gets the java.util.Iterator for the list of One to Many
private array getParentManyToMany()
 any getParentManyToManyIterator()
          Gets the java.util.Iterator for the list of Parent Many to Many
private array getParentOneToMany()
 ParentOneToMany getParentOneToManyByClass(string className)
          Gets a Parent OneToMany by Class. Throws ParentOneToManyNotFoundException if the ParentOneToMany doesn't exist
 ParentOneToMany getParentOneToManyByName(string name)
          Gets a Parent OneToMany by name. Throws ParentOneToManyNotFoundException if the ParentOneToMany doesn't exist
 any getParentOneToManyIterator()
          Gets the java.util.Iterator for the list of Parent One to Many
 AbstractBaseKey getPrimaryKey()
private array getProperties()
 Property getPropertyByName(string name)
          Gets a property by name. Throws PropertyNotFoundException if the property doesn't exist
 any getPropertyIterator()
          Gets the java.util.Iterator for the list of properties
private struct getPropertyMap()
 string getSequence()
 string getTable()
 string getTableAlias()
 boolean hasDecorator()
 boolean hasManyToMany()
          Whether or not the object has any manytomany collections
 boolean hasManyToOne()
          Whether or not the object has any manytoone collections
 boolean hasOneToMany()
          Whether or not the object has any onetomany collections
 boolean hasParentManyToMany()
          Whether or not the object has a parent manytomany collections
 boolean hasParentOneToMany()
          Whether or not the object has a parent onetomany collections
 boolean hasProperty(string name)
          does the object have a property of a given name
 boolean hasTableAlias()
          if the object has a table alias
package void notifyComplete()
          notifies the object that it has finished loading, and can do post processing
private void setClassName(string ClassName)
private void setDecorator(string Decorator)
private void setFunction(array Function)
private void setHash(string Hash)
private void setManyToMany(array ManyToMany)
private void setManyToOne(array ManyToOne)
 void setMemento(struct memento)
          Sets the state of the object
private void setObjectManager(ObjectManager ObjectManager)
private void setObjectName(string ObjectName)
private void setOneToMany(array OneToMany)
private void setParentManyToMany(array manyToMany)
private void setParentOneToMany(array ParentOneToMany)
private void setPrimaryKey(AbstractBaseKey PrimaryKey)
private void setProperties(array Properties)
private void setPropertyMap(struct PropertyMap)
private void setSequence(string Sequence)
private void setTable(string Table)
private void setTableAlias(string tableAlias)
private any throw(string type, string message, [string detail=''])
          Throws an Exception
 void validate()
          Throws an exception if validation fails
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init(ObjectManager objectManager)
Constructor

Parameters:
objectManager - The object manager
Method Detail

addFunction

private void addFunction(Function Function)
add a Custom Function

Parameters:
Function - A Custom Function BO

addManyToMany

public void addManyToMany(ManyToMany manyToMany)
add a Many to Many

Parameters:
manyToMany - A Many to Many BO

addManyToOne

public void addManyToOne(ManyToOne manyToOne)
add a Many to Many

Parameters:
manyToOne - A Many to One BO

addOneToMany

public void addOneToMany(OneToMany oneToMany)
add a One to Many

Parameters:
oneToMany - A One to Many BO

addParentManyToMany

public void addParentManyToMany(ManyToMany manyToMany)
add a Parent Many to Many

Parameters:
manyToMany - A Many to Many BO

addParentOneToMany

public void addParentOneToMany(ParentOneToMany parentOneToMany)
add a Parent One to Many

Parameters:
parentOneToMany - A Parent to Many BO

addProperty

private void addProperty(Property Property)
Adds a property to the Object

Parameters:
Property - The property to add

clearManyToMany

public void clearManyToMany()
Removes all manytoone elements

clearManyToOne

public void clearManyToOne()
Removes all manytoone elements

clearOneToMany

public void clearOneToMany()
Removes all manytoone elements

clearProperties

private void clearProperties()
clears the properies

containsManyToOne

public boolean containsManyToOne(string name)
returns if this object has this manytoone

Parameters:
name - The name of the manytoone

containsParentOneToMany

public boolean containsParentOneToMany(string className)
Returns whether or not this object has this parent one to many

Parameters:
className - The class of the parent onetomany

getClassName

public string getClassName()

getDecorator

public string getDecorator()

getFunction

private array getFunction()

getFunctionIterator

public any getFunctionIterator()
Gets the java.util.Iterator for the list of custom functions

getHash

public string getHash()

getLinkingClassName

public string getLinkingClassName(string compositeName)
returns the linking class name, throws an CompositionNotFoundException if nothing is found

Parameters:
compositeName - The name of the composition to search for

getManyToMany

private array getManyToMany()

getManyToManyArrayByLink

public array getManyToManyArrayByLink(string className, [string filterName])
returns an array of many to many properties that link to this class

Parameters:
className - the name of the class to search for
filterName - The many to many name to filter by

getManyToManyByName

public ManyToMany getManyToManyByName(string name)
Gets a ManyToMany by name. Throws ManyToManyNotFoundException if the ManyToMany doesn't exist

Parameters:
name - The name of the property

getManyToManyIterator

public any getManyToManyIterator()
Gets the java.util.Iterator for the list of Many to Many

getManyToOne

private array getManyToOne()

getManyToOneArrayByLink

public array getManyToOneArrayByLink(string className, [string filterName])
returns an array of many to one properties that link to this class

Parameters:
className - the name of the class to search for
filterName - The many to many name to filter by

getManyToOneByName

public ManyToOne getManyToOneByName(string name)
Gets a manytoone by name. Throws ManyToOneNotFoundException if the manytoone doesn't exist

Parameters:
name - The name of the manytoone

getManyToOneIterator

public any getManyToOneIterator()
Gets the java.util.Iterator for the list of Many to One

getObjectManager

private ObjectManager getObjectManager()

getObjectName

public string getObjectName()

getOneToMany

private array getOneToMany()

getOneToManyArrayByLink

public array getOneToManyArrayByLink(string className, [string filterName])
returns an array of one to many properties that link to this class

Parameters:
className - the name of the class to search for
filterName - The many to many name to filter by

getOneToManyByName

public OneToMany getOneToManyByName(string name)
Gets a OneToMany by name. Throws OneToManyNotFoundException if the OneToMany doesn't exist

Parameters:
name - The name of the property

getOneToManyIterator

public any getOneToManyIterator()
Gets the java.util.Iterator for the list of One to Many

getParentManyToMany

private array getParentManyToMany()

getParentManyToManyIterator

public any getParentManyToManyIterator()
Gets the java.util.Iterator for the list of Parent Many to Many

getParentOneToMany

private array getParentOneToMany()

getParentOneToManyByClass

public ParentOneToMany getParentOneToManyByClass(string className)
Gets a Parent OneToMany by Class. Throws ParentOneToManyNotFoundException if the ParentOneToMany doesn't exist

Parameters:
className - The class of the parent onetomany

getParentOneToManyByName

public ParentOneToMany getParentOneToManyByName(string name)
Gets a Parent OneToMany by name. Throws ParentOneToManyNotFoundException if the ParentOneToMany doesn't exist

Parameters:
name - The name of the parent onetoomany

getParentOneToManyIterator

public any getParentOneToManyIterator()
Gets the java.util.Iterator for the list of Parent One to Many

getPrimaryKey

public AbstractBaseKey getPrimaryKey()

getProperties

private array getProperties()

getPropertyByName

public Property getPropertyByName(string name)
Gets a property by name. Throws PropertyNotFoundException if the property doesn't exist

Parameters:
name - The name of the property

getPropertyIterator

public any getPropertyIterator()
Gets the java.util.Iterator for the list of properties

getPropertyMap

private struct getPropertyMap()

getSequence

public string getSequence()

getTable

public string getTable()

getTableAlias

public string getTableAlias()

hasDecorator

public boolean hasDecorator()

hasManyToMany

public boolean hasManyToMany()
Whether or not the object has any manytomany collections

hasManyToOne

public boolean hasManyToOne()
Whether or not the object has any manytoone collections

hasOneToMany

public boolean hasOneToMany()
Whether or not the object has any onetomany collections

hasParentManyToMany

public boolean hasParentManyToMany()
Whether or not the object has a parent manytomany collections

hasParentOneToMany

public boolean hasParentOneToMany()
Whether or not the object has a parent onetomany collections

hasProperty

public boolean hasProperty(string name)
does the object have a property of a given name

Parameters:
name - The name of the property

hasTableAlias

public boolean hasTableAlias()
if the object has a table alias

notifyComplete

package void notifyComplete()
notifies the object that it has finished loading, and can do post processing

setClassName

private void setClassName(string ClassName)

Parameters:
ClassName

setDecorator

private void setDecorator(string Decorator)

Parameters:
Decorator

setFunction

private void setFunction(array Function)

Parameters:
Function

setHash

private void setHash(string Hash)

Parameters:
Hash

setManyToMany

private void setManyToMany(array ManyToMany)

Parameters:
ManyToMany

setManyToOne

private void setManyToOne(array ManyToOne)

Parameters:
ManyToOne

setMemento

public void setMemento(struct memento)
Sets the state of the object

Parameters:
memento - The memento to set the state of the object

setObjectManager

private void setObjectManager(ObjectManager ObjectManager)

Parameters:
ObjectManager

setObjectName

private void setObjectName(string ObjectName)

Parameters:
ObjectName

setOneToMany

private void setOneToMany(array OneToMany)

Parameters:
OneToMany

setParentManyToMany

private void setParentManyToMany(array manyToMany)

Parameters:
manyToMany

setParentOneToMany

private void setParentOneToMany(array ParentOneToMany)

Parameters:
ParentOneToMany

setPrimaryKey

private void setPrimaryKey(AbstractBaseKey PrimaryKey)

Parameters:
PrimaryKey

setProperties

private void setProperties(array Properties)

Parameters:
Properties

setPropertyMap

private void setPropertyMap(struct PropertyMap)

Parameters:
PropertyMap

setSequence

private void setSequence(string Sequence)

Parameters:
Sequence

setTable

private void setTable(string Table)

Parameters:
Table

setTableAlias

private void setTableAlias(string tableAlias)

Parameters:
tableAlias

throw

private any throw(string type, string message, [string detail=''])
Throws an Exception

Parameters:
type - The type of exception
message - The message to accompany the exception
detail - The detail message for the exception

validate

public void validate()
Throws an exception if validation fails

Overview  Package   Class 
Transfer version 1.1
FRAMES