codestructure_net.htm

LLBLGen 1.21 Sourcecode

	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table and View.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">Delete</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table9">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <b>[SP prefix]<i>TableName</i>_Delete</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>bool (C#) or Boolean (VB.NET)</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td><b>True</b> if the method succeeded, <b>false</b> otherwise. When an error occures, the method will throw an exception, which
			is the exception caught encapsulated in a new Exception exception.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <b>[SP prefix]<i>TableName</i>_Delete</b>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class. This method is part of the ICommonDBAccess interface.
			When this method is not generated in the table / view class, the virtual method <i>Delete</i>, declared in the
			[Class prefix]DBInteractionBase class, is still present, but is an empty method.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. In general:
		    all properties corresponding to all the fields of the Primary Key. </td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">DeleteW<i>PrimaryKeyField</i>Logic</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table10">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <br><b>[SP prefix]<i>TableName</i>_DeleteW<i>PrimaryKeyField</i>Logic</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>bool (C#) or Boolean (VB.NET)</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td><b>True</b> if the method succeeded, <b>false</b> otherwise. When an error occures, the method will throw an exception, which
			is the exception caught encapsulated in a new Exception exception.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <br><b>[SP prefix]<i>TableName</i>_DeleteW<i>PrimaryKeyField</i>Logic</b>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. </td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">Update</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table6">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <b>[SP prefix]<i>TableName</i>_Update</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>bool (C#) or Boolean (VB.NET)</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td><b>True</b> if the method succeeded, <b>false</b> otherwise. When an error occures, the method will throw an exception, which
			is the exception caught encapsulated in a new Exception exception.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <b>[SP prefix]<i>TableName</i>_Update</b>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class. This method is part of the ICommonDBAccess interface.
			When this method is not generated in the table / view class, the virtual method <i>Update</i>, declared in the
			[Class prefix]DBInteractionBase class, is still present, but is an empty method.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. See the specification
		    of <br><b>[SP prefix]<i>TableName</i>_Update</b> on <a href="codestructure_tsql.htm">Structure of T-SQL code</a> for details.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">UpdateAllW<i>ForeignKeyField</i>Logic</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table7">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <br><b>[SP prefix]<i>TableName</i>_UpdateAllW<i>ForeignKeyField</i>Logic</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>bool (C#) or Boolean (VB.NET)</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td><b>True</b> if the method succeeded, <b>false</b> otherwise. When an error occures, the method will throw an exception, which
			is the exception caught encapsulated in a new Exception exception.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <br><b>[SP prefix]<i>TableName</i>_UpdateAllW<i>ForeignKeyField</i>Logic</b>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. In general:
		    all properties corresponding with <i>ForeignKeyField</i>, which means both <i>ForeignKeyField</i> and the
		    'old' value property for <i>ForeignKeyField</i>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">SelectOne</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table11">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <b>[SP prefix]<i>TableName</i>_SelectOne</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>DataTable</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td>A DataTable object with the row selected.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <b>[SP prefix]<i>TableName</i>_SelectOne</b>. A succesful call of this method
			will fill each property which corresponds with a field in <i>TableName</i> with the corresponding value in the
			row selected.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class. This method is part of the ICommonDBAccess interface.
			When this method is not generated in the table / view class, the virtual method <i>SelectOne</i>, declared in the
			[Class prefix]DBInteractionBase class, is still present, but is an empty method.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. In general:
		    all properties corresponding with the fields in the Primary Key.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">SelectOneW<i>UniqueField</i>Logic</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table13">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <br><b>[SP prefix]<i>TableName</i>_SelectOneW<i>UniqueField</i>Logic</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>DataTable.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td>A DataTable object with the row selected.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <br><b>[SP prefix]<i>TableName</i>_SelectOneW<i>UniqueField</i>Logic</b>.
			A succesful call of this method	will fill each property which corresponds with a field in <i>TableName</i> 
			with the corresponding value in the	row selected.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Declared where</b></td>
		<td>[Class prefix]<i>Table / View Name</i> class.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Parameters</b></td>
		<td>None.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Properties needed</b></td>
		<td>Depends on table or view. See comment block generated above method declaration header for an exact list of 
		    needed properties plus for a list of properties which are affected by a succesful call. In general:
		    the property corresponding to the field <i>UniqueField</i>.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Table / View</b></td>
		<td>Table.</td>
	</tr>
	</table>
	<br clear="all"><br>
	<b class="SmallHdr">SelectAll</b>
	<table width="100%" cellpadding="2" cellspacing="0" border="1" ID="Table14">
	<tr>
		<td valign="top" width="140"><b>When generated</b></td>
		<td>When the stored procedure <b>[SP prefix]<i>TableName</i>_SelectAll</b> is generated.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type</b></td>
		<td>DataTable</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Return Type desc.</b></td>
		<td>A DataTable object with all the rows selected.</td>
	</tr>
	<tr>
		<td valign="top" width="140"><b>Purpose</b></td>
		<td>For calling the stored procedure <b>[SP prefix]<i>TableName</i>_SelectAll</b>.</td>
	</tr>
	<tr>