org.enhydra.shark.appmappersistence.data
Class ToolAgentAppUserDataStruct

java.lang.Object
  extended bycom.lutris.appserver.server.sql.CoreDataStruct
      extended byorg.enhydra.shark.appmappersistence.data.ToolAgentAppUserDataStruct
All Implemented Interfaces:
java.lang.Cloneable, java.io.Serializable

public class ToolAgentAppUserDataStruct
extends com.lutris.appserver.server.sql.CoreDataStruct
implements java.lang.Cloneable, java.io.Serializable

Data structure for DO class. A container for data members of a DO class. A DO class contains a reference to a DataStruct class. This reference can be null (a DO whose data has not yet been retrieved from the database), allowing a DO object to be a lightweight placeholder until its data is needed.

Since:
DODS Project;
Version:
$Revision: 1.21 $
Author:
NN
See Also:
Serialized Form

Field Summary
static int COLUMN_OID
          Used for query caching.
static int COLUMN_TOOLAGENT_APPOID
          Used for query caching.
static int COLUMN_USEROID
          Used for query caching.
 boolean readOnly
          A DO refers to this DataStruct.
 
Fields inherited from class com.lutris.appserver.server.sql.CoreDataStruct
newVersion, oId, version
 
Constructor Summary
ToolAgentAppUserDataStruct()
           
 
Method Summary
 boolean compareCond(org.enhydra.dods.cache.Condition cond)
          Compares whether this DataStruct object satisfies condition cond.
 com.lutris.appserver.server.sql.CoreDataStruct dumpData(boolean incrementVersion)
           
 ToolAgentAppUserDataStruct duplicate()
          Create a copy of the guts of a DO.
 java.lang.String get_CacheHandle()
          Returns this object's cache handle (String in the form: ".
 java.lang.String get_Database()
           
 java.lang.String get_Handle()
          Returns this object's handle (identifier as a string).
protected  int get_Version()
          Returns DataStruct's version.
 com.lutris.appserver.server.sql.ObjectId getTOOLAGENT_APPOID()
          Return value of TOOLAGENT_APPOID column.
 com.lutris.appserver.server.sql.ObjectId getUSEROID()
          Return value of USEROID column.
protected  boolean isEmpty()
          Returns indicator if DataStruct has any useful content.
 void set_Database(java.lang.String dbName)
           
protected  void set_Empty(boolean b)
          Sets indicator if DataStruct has any useful content.
protected  void set_OId(com.lutris.appserver.server.sql.ObjectId oId)
          Sets this object's identifier.
protected  void set_Version(int v)
          Sets DataStruct's version.
 void setTOOLAGENT_APPOID(com.lutris.appserver.server.sql.ObjectId val4TOOLAGENT_APPOID)
          Sets TOOLAGENT_APPOID column.
 void setUSEROID(com.lutris.appserver.server.sql.ObjectId val4USEROID)
          Sets USEROID column.
 java.lang.String toString()
           
 java.lang.String toString(int indentCount)
           
 void writeXMLData(java.io.Writer w)
           
 
Methods inherited from class com.lutris.appserver.server.sql.CoreDataStruct
get_OId, get_OIdColumnName, get_versionColumnName, getHandle, getOId, getVersion, set_OIdColumnName, set_versionColumnName, setOId, setVersion, writeXMLhead
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

readOnly

public boolean readOnly
A DO refers to this DataStruct. readOnly is set to true when the DO is stored in its class cache.


COLUMN_TOOLAGENT_APPOID

public static final int COLUMN_TOOLAGENT_APPOID
Used for query caching.

See Also:
Constant Field Values

COLUMN_USEROID

public static final int COLUMN_USEROID
Used for query caching.

See Also:
Constant Field Values

COLUMN_OID

public static final int COLUMN_OID
Used for query caching.

See Also:
Constant Field Values
Constructor Detail

ToolAgentAppUserDataStruct

public ToolAgentAppUserDataStruct()
Method Detail

isEmpty

protected boolean isEmpty()
Returns indicator if DataStruct has any useful content.

Returns:
true if DataStruct has any useful content, otherwise false.

set_Empty

protected void set_Empty(boolean b)
Sets indicator if DataStruct has any useful content.

Parameters:
b - new value of indicator if DataStruct has any useful content.

get_Version

protected int get_Version()
Returns DataStruct's version.

Returns:
DataStruct's version.

set_Version

protected void set_Version(int v)
Sets DataStruct's version.

Parameters:
v - new DataStruct's version.

set_OId

protected void set_OId(com.lutris.appserver.server.sql.ObjectId oId)
Sets this object's identifier.

Parameters:
oId - this object's identifier.

get_Handle

public java.lang.String get_Handle()
                            throws com.lutris.appserver.server.sql.DatabaseManagerException
Returns this object's handle (identifier as a string).

Returns:
This object's identifier as a string.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.

get_CacheHandle

public java.lang.String get_CacheHandle()
                                 throws com.lutris.appserver.server.sql.DatabaseManagerException
Returns this object's cache handle (String in the form: ".").

Returns:
cache handle.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - If a connection to the database cannot be established, etc.

set_Database

public void set_Database(java.lang.String dbName)
Parameters:
dbName - - name of the logical database this DataStruct should belong to.

get_Database

public java.lang.String get_Database()
Returns:
name of the logical database this DataStruct belongs to.

dumpData

public com.lutris.appserver.server.sql.CoreDataStruct dumpData(boolean incrementVersion)

writeXMLData

public void writeXMLData(java.io.Writer w)
                  throws java.io.IOException
Throws:
java.io.IOException

toString

public java.lang.String toString()

toString

public java.lang.String toString(int indentCount)

setTOOLAGENT_APPOID

public void setTOOLAGENT_APPOID(com.lutris.appserver.server.sql.ObjectId val4TOOLAGENT_APPOID)
Sets TOOLAGENT_APPOID column.

Parameters:
val4TOOLAGENT_APPOID - new column value.

getTOOLAGENT_APPOID

public com.lutris.appserver.server.sql.ObjectId getTOOLAGENT_APPOID()
Return value of TOOLAGENT_APPOID column.

Returns:
value of TOOLAGENT_APPOID column.

setUSEROID

public void setUSEROID(com.lutris.appserver.server.sql.ObjectId val4USEROID)
Sets USEROID column.

Parameters:
val4USEROID - new column value.

getUSEROID

public com.lutris.appserver.server.sql.ObjectId getUSEROID()
Return value of USEROID column.

Returns:
value of USEROID column.

compareCond

public boolean compareCond(org.enhydra.dods.cache.Condition cond)
Compares whether this DataStruct object satisfies condition cond.

Parameters:
cond - Condition of the query.
Returns:
true if this DataStruct object satisfies condition of this query, otherwise false.

duplicate

public ToolAgentAppUserDataStruct duplicate()
                                     throws com.lutris.dods.builder.generator.query.DataObjectException
Create a copy of the guts of a DO.

Returns:
Copied DataStruct object.
Throws:
com.lutris.appserver.server.sql.DatabaseManagerException - if createExisting() fails for a contained DO
com.lutris.appserver.server.sql.ObjectIdException - if GenericDO has trouble obtaining a valid id.
com.lutris.dods.builder.generator.query.DataObjectException