The generated <class> represents persistent objects that are mapped to rows in the schema. This class supports object data manipulation, and database access actions such as adding, deleting, or updating a row, and running user-defined methods.
Inherits from:
IBase
|
+----IVBase
|
+----INotifier
|
+----IStandardNotifier
|
+----IPersistentObject
|
+----<class>
Public Functions by Category
public: <Class>(); <Class>(IDatastorexxx* dsm); <Class>(const <Class>DataId& aDataId, IDatastorexxx* dsm = 0); <Class>(const <Class>& partCopy);If a datastore is passed in as a parameter to the constructor (as in the second and third signatures, above), this datastore object becomes the class-level datastore setting, and is used for the current datastore for the object. If no datastore is specified in the constructor, the class-level or application-level datastore is used (unless an object-leve datastore is set using the setObjectsDatastore method).
Supported Platforms Windows OS/2 AIX Y Y Y
public: virtual ~<Class>();
Supported Platforms Windows OS/2 AIX Y Y Y
public: const <Class>DataId& dataId() const;
Use this method to return the <Class>DataId object associated with the current object. You can change this setting by using the setDataId method. This method is generated only if the mapping schema has a data ID.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <Class>& setDataId( const <Class>DataId& aDataId ); <Class>& setDataId( const <Class>DataId* aDataId );
Use this method to change the dataId setting for the current object. This method is generated only if the mapping schema has a data ID.
Supported Platforms Windows OS/2 AIX Y Y Y
public: virtual IString forDisplay( const char* separator = " " ) const;
This method returns an IString representation of the object. Only those attributes specified as For Display in the Attribute Properties notebook are returned in the string. The separator is used to separate the attributes.
Supported Platforms Windows OS/2 AIX Y Y Y
public: virtual IString asString( const char* separator ) const; virtual IString asString() const;
This method returns an IString representation of the object. The separator is used to separate the attributes. If no separator is specified, a period (".") separates the attributes.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IString asDebugInfo() const;Use this method to return a string containing debug information for the current object.
Supported Platforms Windows OS/2 AIX Y Y Y
Data Access and User Defined Methods
public: void retrieve();
This method retrieves a row from the table that corresponds the the current object's data ID. This method is generated only if the schema has a Data ID.
Warning: Trailing blanks in character-type fields are treated differently by ESQL than by CLI or ODBC. Sometimes, trailing blanks are stripped when such a field is retrieved from the database. This may result in unexpected output and equals-operator results.
Supported Platforms Windows OS/2 AIX Y Y Y
public: void add();
This method adds the current persistent object to the table.
Supported Platforms Windows OS/2 AIX Y Y Y
public: void del();
This method deletes a row in the table that corresponds the the current object's data ID. This method is generated only if the schema has a Data ID.
Supported Platforms Windows OS/2 AIX Y Y Y
public: void update(); virtual void update( const <Class>DataId& aNewDataId ); virtual void update( const <Class>DataId* aNewDataId );
This method updates the row in the table that corresponds to the current object's data ID, with the attributes of the current object. Only columns that have changed since the row was retrieved are updated. Use the updateAll method to update all columns, including those that have not changed.
If you pass in a DataId object, it will also update the current row's data ID columns. The passed-in dataId does not determine which row gets updated; rather it overrides the dataId mapped to the current object. This method is generated only if the schema has a Data ID.
Supported Platforms Windows OS/2 AIX Y Y Y
public: void updateAll();This method updates the row in the table that corresponds to the current object's data ID, with the attributes of the current object. All columns of the row are updated, including those that have not changed since the row was retrieved. Use the update method to update only those columns that have changed.
Supported Platforms Windows OS/2 AIX Y Y Y public: <attributeType> <attribute>() const;
Use this method to return the value of the specified attribute. You can change the value of this attribute by calling the set<Attribute> method.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IBoolean is<attribute>Null() const;
Use this method to check whether the specified attribute is null. Returns true if it is null, or false if it is not.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IBoolean is<Attribute>Nullable() const;
Use this method to check whether the specified attribute can be set to null. Returns true if it can be set to null, or false if it cannot.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IString <attribute>AsString() const;
Use this method to return the specified attribute as a string.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <Class>& set<Attribute>ToNull(IBoolean nullState=true);
Use this method to set the specified attribute to null. You can use this method only if is<Attribute>Nullable returns true. If the attribute is not nullable, this method throws an exception.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <Class>& set<Attribute>(const IString& aString ); <Class>& set<Attribute>(<attributeType> an<Attribute>);
Use this method to change the value of the specified attribute.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <returnType> <UDM>( <parameterList> );
If you have defined a user-defined method in the Methods dialog, then this method will be generated. It runs the user-defined method and returns the result, if any.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <returnType> <SPC>( <parameterList> );
If you have defined a stored procedure call in the Methods dialog, then this method will be generated. It runs the stored procedure and returns the result, if any.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IDatastorexxx* objectsDatastore() const;
Use this method to return the current object's datastore setting. If this method returns null, then the object uses the default datastore or the application default datastore for database transactions. If this method returns a non-null value, then the returned datastore is used for all datastore transactions. You can change this setting by calling the setObjectDatastore method.
Supported Platforms Windows OS/2 AIX Y Y Y
public: <Class>& setObjectsDatastore(IDatastorexxx* dsm = 0);
Use this method to change the object's datastore setting. If you pass in null, then the object will use the default datastore (if it is not null) or the application default datastore for database transactions. If you pass in a non-null value, then the object uses the passed-in datastore object for all its datastore transactions. Note: The datastore object that was previously being used by the object is not destroyed by calling this method.
Supported Platforms Windows OS/2 AIX Y Y Y
public: static IDatastorexxx* defaultDatastore();
Use this method to return the default datastore setting for this class. If the default datastore is not null, then objects of this class will use it for database transactions unless an objects datastore has been set for them. You can change this setting by calling the setDefaultDatastore method.
Supported Platforms Windows OS/2 AIX Y Y Y
public: static void setDefaultDatastore( IDatastorexxx* dsm = 0 );
Use this method to change the default datastore setting for the class. If the default datastore is not null, then objects of this class will use it for database transactions unless an objects datastore has been set for them.
Supported Platforms Windows OS/2 AIX Y Y Y
public: IDatastorexxx* currentDatastore() const;
Use this method to return the current datastore for the object. The current datastore is the datastore that the object uses for all datastore transactions. It is calculated as follows:
- the current datastore is the object's datastore, unless that is null;
- if the object's datastore is null, then the current datastore is the default datastore, unless that is null;
- if both object's and default datastores are null, then the current datastore is the application default datastore.
If all three datastore settings are null, then an attempt to make a database transaction will result in an exception.
Supported Platforms Windows OS/2 AIX Y Y Y
public: static void setQualifier(const IString& qual);
Use this method to set the database table qualifier to be used in database transactions for the class. This setting is only used for non-static ESQL transactions.
Supported Platforms Windows OS/2 AIX Y Y Y
public: static const IString& getQualifier();
Use this method to return the database table qualifier to be used in database transactions for the class. You can change this setting by calling the setQualifier method. This setting is only used for non-static ESQL transactions.
Supported Platforms Windows OS/2 AIX Y Y Y
Public Operators
public: <Class>& operator= (const <Class>& a<Class>);public: IBoolean operator == (const <Class>& value) const; IBoolean operator == (const <Class>* value) const;Warning: Trailing blanks in character-type fields are treated differently by ESQL than by CLI or ODBC. Sometimes, trailing blanks are stripped when such a field is retrieved from the database. This may result in unexpected output and equals-operator results.
public: IBoolean operator != (const <Class>& value) const; IBoolean operator != (const <Class>* value) const;public: IBoolean operator < (const <Class>& value) const; IBoolean operator < (const <Class>* value) const;
Supported Platforms Windows OS/2 AIX Y Y Y
Public Data
public: static const INotificationId <attribute>Id; static const INotificationId <attribute>NullId; static const INotificationId retrieveCompleteId; static const INotificationId addCompleteId; static const INotificationId delCompleteId; static const INotificationId updateCompleteId; static const INotificationId updateDataIdCompleteId; static const INotificationId updateAllCompleteId; static const INotificationId <UDM>CompleteId; static const INotificationId <SPC>CompleteId;
Supported Platforms Windows OS/2 AIX Y Y Y
Inherited from IPersistentObject:
Public Methods
Public Data
