com.yourcompany.yourapp.client
Class CustomerSalesOrderServiceDAO


public class CustomerSalesOrderServiceDAO
extends CustomerSalesOrderBean
implements ServiceDataObject, java.lang.Cloneable, java.io.Serializable, java.lang.Comparable

CustomerSalesOrderServiceDAO implements the ServiceDataObject interface for the CustomerSalesOrder service data access and update object..

Since:
JDK 1.4
Version:
4.5
Author:
Generated by the PRO-Gen expert system.
See Also:
CustomerSalesOrderBean, ServiceDataObject, Serialized Form

Field Summary
Fields inherited from class com.yourcompany.yourapp.client.CustomerSalesOrderBean
ADDRESSATTRIBUTEID, AREACODEATTRIBUTEID, ATTRIBUTECOUNT, CITYATTRIBUTEID, CLASSNAME, CLASSNAMEBASE, COMMENTSATTRIBUTEID, CREDITLIMITATTRIBUTEID, CUSTOMERIDATTRIBUTEID, customersalesorderremoteobject_, DATAACCESSOBHECTSUFFIX, FIELDDESCRIPTORKEYS, instancecount__, ISATTRIBUTEOBJECTKEY, MAXKEYCOUNT, MINKEYCOUNT, NAMEATTRIBUTEID, ORDERDATEATTRIBUTEID, ORDERIDATTRIBUTEID, PHONENUMBERATTRIBUTEID, registry_, rules_, SALESPERSONIDATTRIBUTEID, SHIPDATEATTRIBUTEID, STATEATTRIBUTEID, TOTALATTRIBUTEID, ZIPCODEATTRIBUTEID
 
Constructor Summary
CustomerSalesOrderServiceDAO()
          Zero-arg default constructor.
Method Summary
 java.lang.String[] create(java.lang.String[] _insertvalues)
          Create a new single, specific data access object in the persistent store on hehalf of the web service.
 int getAttributeCount()
          Gets the attribute count for CustomerSalesOrder service data object.
 int getDefiningAttributeID()
          For a the CustomerSalesOrder service data object, return the zero-relative attribute offset that makes this object unique or distinct.
 java.util.List getFieldDescriptors(java.lang.String _iso639language)
          Obtain the resource bundle for the CustomerSalesOrder web service data object for the specified language.
 java.lang.String getNextObjectKey(int _attributeid)
          Obtain the next unique object key for an upcoming create() operation.
 boolean[] getObjectKeyOffsetsAsBooleanList()
          The CustomerSalesOrder service data objects returns a boolean for each attribibute in the object, true if the attribute at the given offset is an object key, false if not.
 java.lang.String inputEdit(java.lang.String[] _attributes)
          Invokes the edit rules chain on _attributes.
 java.lang.String[] load(java.lang.String[] _objectkeylist)
          Load a single, CustomerSalesOrder service data object from the persistent store for the web services.
 java.util.List load(java.lang.String[] _objectkeylist, int _blocksize)
          Load a block of CustomerSalesOrder service data objects from the persistent store on behalf of the web service.
 void remove(java.lang.String[] _objectkeylist)
          Remove a specific CustomerSalesOrder service data access object from the persistent store.
 void store(java.lang.String[] _expectedvaluelist, java.lang.String[] _newvaluelist)
          Store changes made to existing CustomerSalesOrder service data objects.
 

Constructor Detail

CustomerSalesOrderServiceDAO

public CustomerSalesOrderServiceDAO()
Zero-arg default constructor.

Method Detail

load

public java.lang.String[] load(java.lang.String[] _objectkeylist)
                        throws  DAOException
Load a single, CustomerSalesOrder service data object from the persistent store for the web services.

Specified by:
load in interface ServiceDataObject
Parameters:
_objectkeylist - A fully qualified list of object keys to access the desired Service Data Object. An element of this _objectkeylist is needed for each object key. When mapping to relational databases, include all primary keys for all base tables, in the event of a master-detail relationship. For specifics, please refer to the Java Bean superclass of the implementing class.
Returns:
A normlaized String[] list of normalized attributes in the persistent object, suitable for easy to graphical interfaces of all types and business logic, or null of no object matching the specified key(s) is found.
Throws:
java.lang.IllegalArgumentException - If an insufficient number of keys passed, or the _objectkeylist is null.
DAOException - If any unrecoverable transport / remote server exceptions occur or if a cluster recovery operation times out.

load

public java.util.List load(java.lang.String[] _objectkeylist,
                           int _blocksize)
                    throws  DAOException
Load a block of CustomerSalesOrder service data objects from the persistent store on behalf of the web service.

Specified by:
load in interface ServiceDataObject
Parameters:
_objectkeylist - A partially qualified list of object keys to access the desired Data Access Object. The number of keys in this list is the value of the manifest constant MINKEYCOUNT in the implementing class. For relational data stores, MINKEYCOUNTis the number of primary keys in the highest level parent base table in a 1:n one-to-many relationship, or the number of primary key columns that make up the composite key in a persistent object that maps to a single table.
_blocksize - The maximum number of parent objects to return. Be advised that all children of the parent objects will be recursively located in the remote RDBMS and returned.
Returns:
An array list of normalized attributes that is transmitted over SOAP to the waiting web service client, or null if no matching objects are located.
Throws:
java.lang.IllegalArgumentException - If an insufficient number of keys passed, or the _objectkeylist is null.
DAOException - If any unrecoverable transport / remote server exceptions occur or if a cluster recovery operation times out.

getFieldDescriptors

public java.util.List getFieldDescriptors(java.lang.String _iso639language)
                                   throws  DAOException
Obtain the resource bundle for the CustomerSalesOrder web service data object for the specified language.

Specified by:
getFieldDescriptors in interface ServiceDataObject
Parameters:
_iso639language - THe ISO 639 language code, in lower case, for the specified language, i.e. "en", "es", "fr", "de" and so on. These resource bundles are created on the Interationalization tab in the Generation options step of the PRO-Gen persistent object code generation wizard.
Returns:
A SOAP-compatible and interoperatble Array List of resource keys (keys are same for every _iso639language) and the language specific string resources that correlate to a given key, for the specified _iso639language.
Throws:
java.lang.IllegalArgumentException - If __iso639language is null, empty, or undefined.
DAOException - If an unrecoverable error occurs loading the resources for the given language.

getAttributeCount

public int getAttributeCount()
                      throws  DAOException
Gets the attribute count for CustomerSalesOrder service data object.

Specified by:
getAttributeCount in interface ServiceDataObject
Returns:
Count of attributes in the implementing persistent object, 1-relative.
Throws:
DAOException - If an error occurs obtaining the attribute count, say, if the implementing class failes to load dynamically.

inputEdit

public java.lang.String inputEdit(java.lang.String[] _attributes)
                           throws  DAOException
Invokes the edit rules chain on _attributes.

Specified by:
inputEdit in interface ServiceDataObject
Parameters:
_attributes - A string[] list of object attributes to edit, one element in the list for each attribute in the object, length determined by @{link #getAttributeCount getAttributeCount()}.
Returns:
null if all _attributes passed the rules chains, otherwise an exception string that contains an edit error indicating field and reason for edit failure.
Throws:
DAOException - If an error occurs invoking the edit rules chain upon _attributes.

create

public java.lang.String[] create(java.lang.String[] _insertvalues)
                          throws  DAOException
Create a new single, specific data access object in the persistent store on hehalf of the web service.

Specified by:
create in interface ServiceDataObject
Parameters:
_insertvalues - A list of object attributes / fields, length of which is the same as the length of the string[] list returned by the single-object load() method.
Returns:
The object key(s) that was/were used during the create the object.
Throws:
java.lang.IllegalArgumentException - If an insufficient number of insert value elements is passed passed, or the _insertvalues reference is null, of if the length of _insertvalues does not match the length as returned by getAttributeCount()
DAOException - If any unrecoverable transport / remote server exceptions occur or if a cluster recovery operation times out or if any problem is detected serializing or persisting the new object.

getNextObjectKey

public java.lang.String getNextObjectKey(int _attributeid)
                                  throws  DAOException
Obtain the next unique object key for an upcoming create() operation. getNextObjectKey() is relevant only to data stores that implement the notion of sequences.

Specified by:
getNextObjectKey in interface ServiceDataObject
Parameters:
_attributeid - The zero-relative attributeid that corresponds to the object key in the attribute[] list that makes the object unique.
Returns:
The key value of the next key to use on a subsequent create() operation.
Throws:
java.lang.IllegalArgumentException - If _attributeid exceeds the number of attributes in the implementing object or is less than zero.
DAOException - If the underlying persistent does not implement sequences or if an unerecoverable error occurs accessing the physical sequence object.

remove

public void remove(java.lang.String[] _objectkeylist)
            throws  DAOException
Remove a specific CustomerSalesOrder service data access object from the persistent store.

Specified by:
remove in interface ServiceDataObject
Parameters:
_objectkeylist - A fully qualified list of object keys to delete the desired service data bject. Note that if the object does not exist, this routine will return silently.
Throws:
java.lang.IllegalArgumentException - If an insufficient number of keys passed, or the _objectkeylist is null.
DAOException - If any unrecoverable transport / remote server exceptions occur or if a cluster recovery operation times out.

store

public void store(java.lang.String[] _expectedvaluelist,
                  java.lang.String[] _newvaluelist)
           throws  DAOException
Store changes made to existing CustomerSalesOrder service data objects.

Specified by:
store in interface ServiceDataObject
Parameters:
_expectedvaluelist - The expected state of the persistent object in the relational store. These values, for example, would represent the values returned by the initial load() method, or the values the end-user believe he or she is changing.
_newvaluelist - Revised values, values not being changed should be null; that is, only send modified attributes in this list.
Throws:
java.lang.IllegalArgumentException - If _expecteddbvaluelist or _newvaluelist is not equal to the number of attributes in the implementing object (as defined by getAttributeCount().
DAOException - If the elements in _expecteddbvaluelist that are being mutated do not match the current state of the persistent object; if an object lock can not be acquired to mutate the object, if the object has been removed since the load() took place, or any unrecoverable transport or network errors take place.

getDefiningAttributeID

public int getDefiningAttributeID()
For a the CustomerSalesOrder service data object, return the zero-relative attribute offset that makes this object unique or distinct. Apply sequenced derived object keys or a unique key for new objects to this attribute offset.

Specified by:
getDefiningAttributeID in interface ServiceDataObject
Overrides:
getDefiningAttributeID in class CustomerSalesOrderBean
Returns:
The zero-relative offset of the attribute object key that differentiates this object, or -1 if the attribute is not sequenced assigned.

getObjectKeyOffsetsAsBooleanList

public boolean[] getObjectKeyOffsetsAsBooleanList()
The CustomerSalesOrder service data object returns a boolean for each attribibute in the object, true if the attribute at the given offset is an object key, false if not.

Specified by:
getObjectKeyOffsetsAsBooleanList in interface ServiceDataObject
Returns:
A boolean[] list for for each attribute in the persistent object, true if the attribute at the given offset is an object key, false if not.

Copyright © 2003-2004 TriCoron. All Rights Reserved Worldwide.