|
DODS 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--com.lutris.appserver.server.sql.CoreDO | +--com.lutris.appserver.server.sql.CloneableDO | +--com.lutris.dods.builder.generator.dataobject.GenericDO | +--org.webdocwf.dods.access.SecureDO | +--org.webdocwf.util.genericstore.GenericStoreDO | +--org.webdocwf.util.genericstore.data.TypeDefinitionDO
Data core class, used to set, retrieve the TypeDefinitionDO information.
Field Summary | |
protected static boolean |
isView
|
static RDBColumn |
KEYVALUE
|
static int |
KEYVALUE_MaxLength
|
static RDBColumn |
LONGNAME
|
static int |
LONGNAME_MaxLength
|
static RDBColumn |
PrimaryKey
static final RDBColumn PrimaryKey for use with QueryBuilder. |
static RDBColumn |
SHORTNAME
|
static int |
SHORTNAME_MaxLength
|
static RDBTable |
table
static final data members name the table and columns for this DO. |
static RDBColumn |
XMLNAME
|
static int |
XMLNAME_MaxLength
|
Fields inherited from class com.lutris.dods.builder.generator.dataobject.GenericDO |
dirty |
Fields inherited from class com.lutris.appserver.server.sql.CoreDO |
persistent, versioning |
Constructor Summary | |
protected |
TypeDefinitionDO()
Protected constructor. |
protected |
TypeDefinitionDO(boolean is_view)
Protected constructor. |
protected |
TypeDefinitionDO(ObjectId id)
Protected constructor used by createExisting(ObjectId) above. |
protected |
TypeDefinitionDO(java.sql.ResultSet rs)
Protected constructor. |
Method Summary | |
void |
addGenericObjectDO(GenericObjectDO referrer)
Add (set & commit) a GenericObjectDO object that refers to this DO. |
void |
addGenericObjectDO(GenericObjectDO referrer,
DBTransaction tran)
Add (set & commit) a GenericObjectDO object that refers to this DO. |
void |
addGenericObjectDO(GenericObjectDO referrer,
DBTransaction tran,
User usr)
Add (set & commit) a GenericObjectDO object that refers to this DO. |
void |
addGenericObjectDO(GenericObjectDO referrer,
User usr)
Add (set & commit) a GenericObjectDO object that refers to this DO. |
static TypeDefinitionDO |
addToCache(TypeDefinitionDO newDO)
Add DO to cache. |
static void |
assertDOCreateAccess(User usr)
Ensure that the given user is allowed to create new instances |
void |
assertDOGetAttrKEYVALUEAccess(User usr)
Ensure that the given user is allowed to read the attribute |
void |
assertDOGetAttrLONGNAMEAccess(User usr)
Ensure that the given user is allowed to read the attribute |
void |
assertDOGetAttrSHORTNAMEAccess(User usr)
Ensure that the given user is allowed to read the attribute |
void |
assertDOGetAttrXMLNAMEAccess(User usr)
Ensure that the given user is allowed to read the attribute |
void |
assertDOSetAttrKEYVALUEAccess(java.lang.String KEYVALUE,
User usr)
Ensure that the given user is allowed to update the attribute |
void |
assertDOSetAttrLONGNAMEAccess(java.lang.String LONGNAME,
User usr)
Ensure that the given user is allowed to update the attribute |
void |
assertDOSetAttrSHORTNAMEAccess(java.lang.String SHORTNAME,
User usr)
Ensure that the given user is allowed to update the attribute |
void |
assertDOSetAttrXMLNAMEAccess(java.lang.String XMLNAME,
User usr)
Ensure that the given user is allowed to update the attribute |
protected void |
checkLoad()
Load the actual DO data if necessary. |
void |
commit()
Deprecated. Use save() instead. |
void |
commit(DBTransaction dbt)
Deprecated. Use save() instead. |
static TypeDefinitionDO |
createCopy(TypeDefinitionDataStruct data)
createCopy() Creates a DO that has no ObjectId but has a copy of an existing DO's data. |
static TypeDefinitionDO |
createCopy(TypeDefinitionDO orig)
createCopy() Creates a DO that has no ObjectId but has a copy of an existing DO's data. |
static TypeDefinitionDO |
createCopy(TypeDefinitionDO orig,
User usr)
createCopy() Creates a DO that has no ObjectId but has a copy of an existing DO's data. |
static TypeDefinitionDO |
createExisting(java.math.BigDecimal bd)
createExisting( BigDecimal ) Factory method creates a TypeDefinitionDO object by searching for it in the database using the passed BigDecimal value as the primary key. |
static TypeDefinitionDO |
createExisting(java.math.BigDecimal bd,
User usr)
createExisting( BigDecimal ) Factory method creates a TypeDefinitionDO object by searching for it in the database using the passed BigDecimal value as the primary key. |
protected static TypeDefinitionDO |
createExisting(ObjectId id)
createExisting( ObjectId ) Factory method creates a TypeDefinitionDO object by searching for it in the database using the passed ObjectID value as the primary key. |
protected static TypeDefinitionDO |
createExisting(RDBColumnValue pk)
createExisting( RDBColumnValue ) Factory method creates a TypeDefinitionDO object by searching for it in the database using the passed TypeDefinitionDO.PrimaryKey. |
protected static TypeDefinitionDO |
createExisting(RDBRow row)
createExisting( RDBRow ) Factory method creates a TypeDefinitionDO object by searching for it in the database using the TypeDefinitionDO.PrimaryKey value in the passed RDBRow. |
protected static TypeDefinitionDO |
createExisting(java.sql.ResultSet rs)
createExisting( ResultSet ) Factory method used to create an instance of this class to represent a Data Object already existing in the database. |
static TypeDefinitionDO |
createExisting(java.lang.String handle)
The createExisting method is used to create a TypeDefinitionDO
from a string handle. |
static TypeDefinitionDO |
createExisting(java.lang.String handle,
User usr)
The createExisting method is used to create a TypeDefinitionDO
from a string handle. |
GenericStoreDO |
createForExisting(java.math.BigDecimal bd)
Create an instance for an existing row This is a strange hack for having an instance method Maybe there is a better solution ? WebDocWf extension |
static TypeDefinitionDO |
createVirgin()
createVirgin() Creates a DO that has no ObjectId or data. |
static TypeDefinitionDO |
createVirgin(User usr)
createVirgin() Creates a DO that has no ObjectId or data. |
void |
delete()
Deletes the DO from its table. |
void |
delete(DBTransaction dbt)
Deletes the DO from its table. |
static TypeDefinitionDO |
findCachedObjectByHandle(java.lang.String handle)
findCachedObjectByHandle |
static TypeDefinitionDO |
findCachedObjectByHandle(java.lang.String handle,
User usr)
findCachedObjectByHandle |
static java.util.Enumeration |
getCacheContents()
Retrieve contents of cache as an enumeration of DO objects. |
java.sql.PreparedStatement |
getDeleteStatement(DBConnection conn)
Prepares the statement used to delete this object from the database. |
GenericObjectDO |
getGenericObjectDO()
Get the single GenericObjectDO object that refers to this DO. |
GenericObjectDO |
getGenericObjectDO(User usr)
Get the single GenericObjectDO object that refers to this DO. |
GenericObjectDO[] |
getGenericObjectDOArray()
Get array of GenericObjectDO objects that refer to this DO. |
GenericObjectDO[] |
getGenericObjectDOArray(User usr)
Get array of GenericObjectDO objects that refer to this DO. |
int |
getGenericObjectDOArrayCount()
Get the number of GenericObjectDOs that refer to this DO. |
int |
getGenericObjectDOArrayCount(User usr)
Get the number of GenericObjectDOs that refer to this DO. |
java.lang.String |
getHandle()
The methods
getHandle
hasMatchingHandle
findCachedObjectByHandle
are used by Presentation Objects that need to populate
HTML select lists with Data Objects as options. |
java.sql.PreparedStatement |
getInsertStatement(DBConnection conn)
Prepares the statement used to insert this object into the database. |
java.lang.String |
getKEYVALUE()
Get KEYVALUE of the GENERICTYPEDEFINITION |
java.lang.String |
getKEYVALUE(User usr)
Get KEYVALUE of the GENERICTYPEDEFINITION |
java.lang.String |
getLONGNAME()
Get LONGNAME of the GENERICTYPEDEFINITION |
java.lang.String |
getLONGNAME(User usr)
Get LONGNAME of the GENERICTYPEDEFINITION |
java.lang.String |
getSHORTNAME()
Get SHORTNAME of the GENERICTYPEDEFINITION |
java.lang.String |
getSHORTNAME(User usr)
Get SHORTNAME of the GENERICTYPEDEFINITION |
java.lang.String |
getTableName()
Return GENERICTYPEDEFINITION as the name of the table in the database which contains TypeDefinitionDO objects. |
java.sql.PreparedStatement |
getUpdateStatement(DBConnection conn)
Prepares the statement used to update this object in the database. |
java.lang.String |
getXMLNAME()
Get XMLNAME of the GENERICTYPEDEFINITION |
java.lang.String |
getXMLNAME(User usr)
Get XMLNAME of the GENERICTYPEDEFINITION |
static boolean |
hasDOCreateAccess(User usr)
Check whether the given user is allowed to create new instances |
static boolean |
hasDOGetAccess(java.math.BigDecimal bd,
User usr)
Check whether the given user is allowed to read the DO existance Static function to be called without having the object |
static boolean |
hasDOGetAccess(java.lang.String handle,
User usr)
Check whether the given user is allowed to read the DO existance Static function to be called without having the object |
boolean |
hasDOGetAttrKEYVALUEAccess(User usr)
Check whether the given user is allowed to read the attribute |
boolean |
hasDOGetAttrLONGNAMEAccess(User usr)
Check whether the given user is allowed to read the attribute |
boolean |
hasDOGetAttrSHORTNAMEAccess(User usr)
Check whether the given user is allowed to read the attribute |
boolean |
hasDOGetAttrXMLNAMEAccess(User usr)
Check whether the given user is allowed to read the attribute |
boolean |
hasDOGetDOValueKEYVALUEAccess(User usr)
Check whether the given user is allowed to read object in a pointer attribute |
boolean |
hasDOGetDOValueLONGNAMEAccess(User usr)
Check whether the given user is allowed to read object in a pointer attribute |
boolean |
hasDOGetDOValueSHORTNAMEAccess(User usr)
Check whether the given user is allowed to read object in a pointer attribute |
boolean |
hasDOGetDOValueXMLNAMEAccess(User usr)
Check whether the given user is allowed to read object in a pointer attribute |
boolean |
hasDOSetAttrKEYVALUEAccess(java.lang.String KEYVALUE,
User usr)
Check whether the given user is allowed to update the attribute |
boolean |
hasDOSetAttrLONGNAMEAccess(java.lang.String LONGNAME,
User usr)
Check whether the given user is allowed to update the attribute |
boolean |
hasDOSetAttrSHORTNAMEAccess(java.lang.String SHORTNAME,
User usr)
Check whether the given user is allowed to update the attribute |
boolean |
hasDOSetAttrXMLNAMEAccess(java.lang.String XMLNAME,
User usr)
Check whether the given user is allowed to update the attribute |
boolean |
hasMatchingHandle(java.lang.String handle)
hasMatchingHandle |
boolean |
isLoaded()
isLoaded() Returns true if the data for this objects has been retrieved from the database. |
boolean |
isReadOnly()
isReadOnly() Returns true if the data for this object has been marked read-only. |
void |
loadData()
loadData() Load the fields for the DO from the database. |
protected void |
makeIdentical(TypeDefinitionDO orig)
makeIdentical() Assigns the DataStruct of an existing DO to this DO. |
void |
makeReadOnly()
makeReadOnly() Mark the object as readonly WebDocWf extension |
void |
makeReadWrite()
makeReadWrite() |
protected void |
modifyDO(DBTransaction dbt,
boolean delete)
Modifies the DO within its table. |
protected void |
modifyDO(DBTransaction dbt,
boolean delete,
boolean references)
Modifies the DO within its table. |
protected void |
okToCommit()
A stub method for implementing pre-commit assertions for this TypeDefinitionDO. |
protected void |
okToDelete()
A stub method for implementing pre-delete assertions for this TypeDefinitionDO. |
static void |
refreshCache()
Queries all rows in table, and for each row creates a DO instance in the cache. |
void |
reload()
reload() Causes the DO to refresh itself from the database the next time a set or get method is called. |
void |
removeGenericObjectDO(GenericObjectDO referrer)
Remove (delete) a GenericObjectDO object that refers to this DO. |
void |
removeGenericObjectDO(GenericObjectDO referrer,
DBTransaction tran)
Remove (delete) a GenericObjectDO object that refers to this DO. |
void |
removeGenericObjectDO(GenericObjectDO referrer,
DBTransaction tran,
User usr)
Remove (delete) a GenericObjectDO object that refers to this DO. |
void |
removeGenericObjectDO(GenericObjectDO referrer,
User usr)
Remove (delete) a GenericObjectDO object that refers to this DO. |
void |
save()
Inserts/Updates the DO into its table. |
void |
save(boolean references)
Inserts/Updates the DO into its table. |
void |
save(DBTransaction dbt)
Inserts/Updates the DO into its table. |
void |
save(DBTransaction dbt,
boolean references)
Inserts/Updates the DO into its table. |
void |
setKEYVALUE(java.lang.String KEYVALUE)
Set KEYVALUE of the GENERICTYPEDEFINITION |
void |
setKEYVALUE(java.lang.String KEYVALUE,
User usr)
Set KEYVALUE of the GENERICTYPEDEFINITION |
void |
setLONGNAME(java.lang.String LONGNAME)
Set LONGNAME of the GENERICTYPEDEFINITION |
void |
setLONGNAME(java.lang.String LONGNAME,
User usr)
Set LONGNAME of the GENERICTYPEDEFINITION |
void |
setSHORTNAME(java.lang.String SHORTNAME)
Set SHORTNAME of the GENERICTYPEDEFINITION |
void |
setSHORTNAME(java.lang.String SHORTNAME,
User usr)
Set SHORTNAME of the GENERICTYPEDEFINITION |
void |
setXMLNAME(java.lang.String XMLNAME)
Set XMLNAME of the GENERICTYPEDEFINITION |
void |
setXMLNAME(java.lang.String XMLNAME,
User usr)
Set XMLNAME of the GENERICTYPEDEFINITION |
java.lang.String |
toString()
|
java.lang.String |
toString(int indentCount)
|
Methods inherited from class com.lutris.appserver.server.sql.CloneableDO |
clone |
Methods inherited from class com.lutris.appserver.server.sql.CoreDO |
addToCache, deleteFromCache, disableVersioning, evict, finalizeDelete, getNewVersion, getOId, getOIdColumnName, getVersionColumnName, isPersistent, refresh, setNewVersion, setOIdColumnName, setPersistent, setVersion, setVersionColumnName, updateCache |
Methods inherited from class java.lang.Object |
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final RDBTable table
public static final RDBColumn PrimaryKey
protected static final boolean isView
public static final RDBColumn KEYVALUE
public static final int KEYVALUE_MaxLength
public static final RDBColumn SHORTNAME
public static final int SHORTNAME_MaxLength
public static final RDBColumn LONGNAME
public static final int LONGNAME_MaxLength
public static final RDBColumn XMLNAME
public static final int XMLNAME_MaxLength
Constructor Detail |
protected TypeDefinitionDO(boolean is_view) throws ObjectIdException, DatabaseManagerException
DatabaseManagerException
- If a connection to the database cannot be established, etc.
ObjectIdException
- If an object id can't be allocated for this object.protected TypeDefinitionDO() throws ObjectIdException, DatabaseManagerException
DatabaseManagerException
- If a connection to the database cannot be established, etc.
ObjectIdException
- If an object id can't be allocated for this object.protected TypeDefinitionDO(ObjectId id) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
id
- The ObjectId for the object.
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- Should never see this exception since GenericDO.ctor(ObjectId)
never accesses the database.protected TypeDefinitionDO(java.sql.ResultSet rs) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
rs
- Result set from which to obtain product data.
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.Method Detail |
public java.lang.String getTableName()
getTableName
in class CoreDO
CoreDO
public boolean isReadOnly()
isReadOnly
in class SecureDO
public boolean isLoaded()
public void loadData() throws java.sql.SQLException, ObjectIdException, DataObjectException
ObjectIdException
- If an object id can't be allocated for this object.
DataObjectException
- If the object is not found in the database.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.protected void checkLoad() throws DataObjectException
checkLoad
in class SecureDO
DataObjectException
- If a data access error occurs.public static void refreshCache() throws java.sql.SQLException, DatabaseManagerException, ObjectIdException, DataObjectException
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.public static TypeDefinitionDO addToCache(TypeDefinitionDO newDO)
public static java.util.Enumeration getCacheContents()
public static TypeDefinitionDO createVirgin() throws DatabaseManagerException, ObjectIdException
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.public static TypeDefinitionDO createVirgin(User usr) throws DatabaseManagerException, ObjectIdException, AccessException
usr
- The user for security check
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
AccessException
- The user is not allowed to create new instances
WebDocWf extensionpublic static void assertDOCreateAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to create new instances
WebDocWf extensionpublic static boolean hasDOCreateAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public GenericStoreDO createForExisting(java.math.BigDecimal bd) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
createForExisting
in class GenericStoreDO
bd
- ObjectID as BigDecimal of the object which must be read from the DB
java.sql.SQLException
ObjectIdException
DataObjectException
DatabaseManagerException
public static TypeDefinitionDO createExisting(java.math.BigDecimal bd) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
bd
- The BigDecimal representation of the ObjectId for the object.
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.public static TypeDefinitionDO createExisting(java.math.BigDecimal bd, User usr) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException, AccessException
bd
- The BigDecimal representation of the ObjectId for the object.usr
- The user for security check
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.
AccessException
- The user is not allowed to read the instance existance
WebDocWf extensionpublic static boolean hasDOGetAccess(java.math.BigDecimal bd, User usr) throws AccessEvalException
bd
- The BigDecimal representation of the ObjectId for the object.usr
- The user for security check
AccessEvalException
public static TypeDefinitionDO createExisting(java.lang.String handle)
TypeDefinitionDO
from a string handle.
public static TypeDefinitionDO createExisting(java.lang.String handle, User usr) throws AccessException
TypeDefinitionDO
from a string handle.
WebDocWf extension
AccessException
public static boolean hasDOGetAccess(java.lang.String handle, User usr) throws AccessEvalException
handle
- The string representation of the ObjectId for the object.usr
- The user for security check
AccessEvalException
protected static TypeDefinitionDO createExisting(ObjectId id) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
id
- The ObjectId for the object.
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.protected static TypeDefinitionDO createExisting(java.sql.ResultSet rs) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
rs
- The ResultSet returned by the Query class for
an existing Data Object stored in the database.
DataObjectException
- If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.protected static TypeDefinitionDO createExisting(RDBRow row) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
DataObjectException
- If the RDBRow does not contain a TypeDefinitionDO.PrimaryKey.
If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.protected static TypeDefinitionDO createExisting(RDBColumnValue pk) throws java.sql.SQLException, ObjectIdException, DataObjectException, DatabaseManagerException
DataObjectException
- If the RDBColumnValue does not contain a TypeDefinitionDO.PrimaryKey.
If the object is not found in the database.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
java.sql.SQLException
- If the database rejects the SQL generated to retrieve data
for this object, or if the table contains a bad foreign key, etc.public static TypeDefinitionDO createCopy(TypeDefinitionDataStruct data) throws DatabaseManagerException, ObjectIdException
data
- The data struct to copy values from.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.public static TypeDefinitionDO createCopy(TypeDefinitionDO orig) throws DatabaseManagerException, ObjectIdException
orig
- The original DO to copy.
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.public static TypeDefinitionDO createCopy(TypeDefinitionDO orig, User usr) throws DatabaseManagerException, ObjectIdException, AccessException
orig
- The original DO to copy.usr
- The user for security check
ObjectIdException
- If an object id can't be allocated for this object.
DatabaseManagerException
- If a connection to the database cannot be established, etc.
AccessException
- The user is not allowed to make a copy
WebDocWf extensionpublic void reload()
public java.lang.String getHandle() throws DatabaseManagerException
getHandle
hasMatchingHandle
findCachedObjectByHandle
are used by Presentation Objects that need to populate
HTML select lists with Data Objects as options.
The getHandle()
method is used
to set the value for each option,
and the hasMatchingHandle()
and findCachedObjectByHandle()
methods are used to lookup the Data Object when the selection has
been made.
- Specified by:
getHandle
in class SecureDO
- Returns:
- id of this DO as a string
If an object id can't be allocated for this object.
- Throws:
DatabaseManagerException
- If a connection to the database cannot be established, etc.
public boolean hasMatchingHandle(java.lang.String handle)
hasMatchingHandle
in class SecureDO
handle
- String
version of DO id
public static TypeDefinitionDO findCachedObjectByHandle(java.lang.String handle)
handle
- String
version of DO id
TypeDefinitionDO
Object if one is found in cache, otherwise null.public static TypeDefinitionDO findCachedObjectByHandle(java.lang.String handle, User usr) throws AccessException
handle
- String
version of DO idusr
- The user for security check
TypeDefinitionDO
Object if one is found in cache, otherwise null.
AccessException
- The user is not allowed to read the object existance
WebDocWf extensionprotected void makeIdentical(TypeDefinitionDO orig)
orig
- The original DO.public void makeReadOnly()
makeReadOnly
in class SecureDO
public void makeReadWrite()
makeReadWrite
in class SecureDO
public java.lang.String getKEYVALUE() throws DataObjectException
getKEYVALUE
in interface TypeDefinitionDOI
DataObjectException
- If the object is not found in the database.public java.lang.String getKEYVALUE(User usr) throws DataObjectException, AccessException
usr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOGetAttrKEYVALUEAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOGetAttrKEYVALUEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public boolean hasDOGetDOValueKEYVALUEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public void setKEYVALUE(java.lang.String KEYVALUE) throws DataObjectException
setKEYVALUE
in interface TypeDefinitionDOI
KEYVALUE
- of the GENERICTYPEDEFINITION
DataObjectException
- If the object is not found in the database.public void setKEYVALUE(java.lang.String KEYVALUE, User usr) throws DataObjectException, AccessException
KEYVALUE
- of the GENERICTYPEDEFINITIONusr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOSetAttrKEYVALUEAccess(java.lang.String KEYVALUE, User usr) throws AccessException
KEYVALUE
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOSetAttrKEYVALUEAccess(java.lang.String KEYVALUE, User usr) throws AccessEvalException
KEYVALUE
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessEvalException
public java.lang.String getSHORTNAME() throws DataObjectException
getSHORTNAME
in interface TypeDefinitionDOI
DataObjectException
- If the object is not found in the database.public java.lang.String getSHORTNAME(User usr) throws DataObjectException, AccessException
usr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOGetAttrSHORTNAMEAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOGetAttrSHORTNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public boolean hasDOGetDOValueSHORTNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public void setSHORTNAME(java.lang.String SHORTNAME) throws DataObjectException
setSHORTNAME
in interface TypeDefinitionDOI
SHORTNAME
- of the GENERICTYPEDEFINITION
DataObjectException
- If the object is not found in the database.public void setSHORTNAME(java.lang.String SHORTNAME, User usr) throws DataObjectException, AccessException
SHORTNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOSetAttrSHORTNAMEAccess(java.lang.String SHORTNAME, User usr) throws AccessException
SHORTNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOSetAttrSHORTNAMEAccess(java.lang.String SHORTNAME, User usr) throws AccessEvalException
SHORTNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessEvalException
public java.lang.String getLONGNAME() throws DataObjectException
getLONGNAME
in interface TypeDefinitionDOI
DataObjectException
- If the object is not found in the database.public java.lang.String getLONGNAME(User usr) throws DataObjectException, AccessException
usr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOGetAttrLONGNAMEAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOGetAttrLONGNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public boolean hasDOGetDOValueLONGNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public void setLONGNAME(java.lang.String LONGNAME) throws DataObjectException
setLONGNAME
in interface TypeDefinitionDOI
LONGNAME
- of the GENERICTYPEDEFINITION
DataObjectException
- If the object is not found in the database.public void setLONGNAME(java.lang.String LONGNAME, User usr) throws DataObjectException, AccessException
LONGNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOSetAttrLONGNAMEAccess(java.lang.String LONGNAME, User usr) throws AccessException
LONGNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOSetAttrLONGNAMEAccess(java.lang.String LONGNAME, User usr) throws AccessEvalException
LONGNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessEvalException
public java.lang.String getXMLNAME() throws DataObjectException
getXMLNAME
in interface TypeDefinitionDOI
DataObjectException
- If the object is not found in the database.public java.lang.String getXMLNAME(User usr) throws DataObjectException, AccessException
usr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOGetAttrXMLNAMEAccess(User usr) throws AccessException
usr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOGetAttrXMLNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public boolean hasDOGetDOValueXMLNAMEAccess(User usr) throws AccessEvalException
usr
- The user for security check
AccessEvalException
public void setXMLNAME(java.lang.String XMLNAME) throws DataObjectException
setXMLNAME
in interface TypeDefinitionDOI
XMLNAME
- of the GENERICTYPEDEFINITION
DataObjectException
- If the object is not found in the database.public void setXMLNAME(java.lang.String XMLNAME, User usr) throws DataObjectException, AccessException
XMLNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
DataObjectException
- If the object is not found in the database.
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic void assertDOSetAttrXMLNAMEAccess(java.lang.String XMLNAME, User usr) throws AccessException
XMLNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessException
- The user is not allowed to read the attribute(value)
WebDocWf extensionpublic boolean hasDOSetAttrXMLNAMEAccess(java.lang.String XMLNAME, User usr) throws AccessEvalException
XMLNAME
- of the GENERICTYPEDEFINITIONusr
- The user for security check
AccessEvalException
public java.sql.PreparedStatement getInsertStatement(DBConnection conn) throws java.sql.SQLException
getInsertStatement
in class CoreDO
conn
- the database connection.
java.sql.SQLException
- if an error occurs.public java.sql.PreparedStatement getUpdateStatement(DBConnection conn) throws java.sql.SQLException
getUpdateStatement
in class CoreDO
conn
- the database connection
java.sql.SQLException
- if an error occurs.public java.sql.PreparedStatement getDeleteStatement(DBConnection conn) throws java.sql.SQLException
getDeleteStatement
in class CoreDO
conn
- the database connection
java.sql.SQLException
- if an error occurs.public java.lang.String toString()
toString
in class java.lang.Object
public java.lang.String toString(int indentCount)
toString
in class GenericDO
public GenericObjectDO[] getGenericObjectDOArray() throws DataObjectException, QueryException
DataObjectException
- If the object is not found in the database.
QueryException
- If an error occured while building the query before execution.public GenericObjectDO getGenericObjectDO() throws DataObjectException, QueryException, NonUniqueQueryException
DataObjectException
- If the object is not found in the database.
QueryException
- If an error occured while building the query before execution.
NonUniqueQueryException
- If more than one GenericObjectDO object was found.public void addGenericObjectDO(GenericObjectDO referrer) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
referrer
- GenericObjectDO to be set to point to this DO and committed.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
RefAssertionException
DBRowUpdateException
QueryException
public void addGenericObjectDO(GenericObjectDO referrer, DBTransaction tran) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
referrer
- GenericObjectDO to be set to point to this DO and committed.tran
- The transaction to be used for the commit.
If null, a new transaction is created.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
RefAssertionException
DBRowUpdateException
QueryException
public void removeGenericObjectDO(GenericObjectDO referrer) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
referrer
- GenericObjectDO to be deleted.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
RefAssertionException
DBRowUpdateException
QueryException
public void removeGenericObjectDO(GenericObjectDO referrer, DBTransaction tran) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
referrer
- GenericObjectDO to be deleted.tran
- The transaction to be used for the commit.
If null, a new transaction is created.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
RefAssertionException
DBRowUpdateException
QueryException
public GenericObjectDO[] getGenericObjectDOArray(User usr) throws DataObjectException, QueryException, AccessException
usr
- The user for security checks
DataObjectException
- If the object is not found in the database.
QueryException
- If an error occured while building the query before execution.
AccessException
- The user is not allowed to create a query for
org.webdocwf.util.genericstore.data.GenericObject or
to access the foreign key attribute TYPEDEFINITIONOID.
This is a WebDocWf extension for DODS row instance securitypublic GenericObjectDO getGenericObjectDO(User usr) throws DataObjectException, QueryException, NonUniqueQueryException, AccessException
usr
- The user for security checks
DataObjectException
- If the object is not found in the database.
QueryException
- If an error occured while building the query before execution.
NonUniqueQueryException
- If more than one GenericObjectDO object was found.
AccessException
- The user is not allowed to create a query for
org.webdocwf.util.genericstore.data.GenericObject or
to access the foreign key attribute TYPEDEFINITIONOID.
This is a WebDocWf extension for DODS row instance securitypublic void addGenericObjectDO(GenericObjectDO referrer, User usr) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException, AccessException
referrer
- GenericObjectDO to be set to point to this DO and committed.usr
- The user for security checks
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
WebDocWf extension
RefAssertionException
DBRowUpdateException
QueryException
AccessException
public void addGenericObjectDO(GenericObjectDO referrer, DBTransaction tran, User usr) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException, AccessException
referrer
- GenericObjectDO to be set to point to this DO and committed.usr
- The user for security checkstran
- The transaction to be used for the commit.
If null, a new transaction is created.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
WebDocWf extension
RefAssertionException
DBRowUpdateException
QueryException
AccessException
public void removeGenericObjectDO(GenericObjectDO referrer, User usr) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException, AccessException
referrer
- GenericObjectDO to be deleted.usr
- The user for security checks
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
WebDocWf extension
RefAssertionException
DBRowUpdateException
QueryException
AccessException
public void removeGenericObjectDO(GenericObjectDO referrer, DBTransaction tran, User usr) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException, AccessException
referrer
- GenericObjectDO to be deleted.usr
- The user for security checkstran
- The transaction to be used for the commit.
If null, a new transaction is created.
DatabaseManagerException
- if could not create a transaction
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
- If object is not found in the database.
WebDocWf extension
RefAssertionException
DBRowUpdateException
QueryException
AccessException
public int getGenericObjectDOArrayCount() throws DataObjectException, QueryException, NonUniqueQueryException, java.sql.SQLException, DatabaseManagerException
DataObjectException
- If object is not found in the database.
This is a WebDocWf extension for DODS row instance security
QueryException
NonUniqueQueryException
java.sql.SQLException
DatabaseManagerException
public int getGenericObjectDOArrayCount(User usr) throws DataObjectException, QueryException, NonUniqueQueryException, java.sql.SQLException, DatabaseManagerException, AccessException
usr
- The user for security checks
DataObjectException
- If object is not found in the database.
AccessException
- The user is not allowed to create a query for
org.webdocwf.util.genericstore.data.GenericObject or
to access the foreign key attribute TYPEDEFINITIONOID.
This is a WebDocWf extension for DODS row instance security
QueryException
NonUniqueQueryException
java.sql.SQLException
DatabaseManagerException
protected void okToCommit() throws RefAssertionException
RefAssertionException
protected void okToDelete() throws RefAssertionException
RefAssertionException
public void commit() throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
commit
in interface TypeDefinitionDOI
DatabaseManagerException
- if a Transaction can not be created.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
DBRowUpdateException
QueryException
public void save() throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
save
in interface TypeDefinitionDOI
save
in class GenericStoreDO
DatabaseManagerException
- if a Transaction can not be created.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
DBRowUpdateException
QueryException
public void save(boolean references) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
references
- True if references should be saved with this DO
DatabaseManagerException
- if a Transaction can not be created.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
DBRowUpdateException
QueryException
public void commit(DBTransaction dbt) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
commit
in interface TypeDefinitionDOI
dbt
- The transaction object to use for this operation.
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
QueryException
public void save(DBTransaction dbt) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
save
in interface TypeDefinitionDOI
save
in class GenericStoreDO
dbt
- The transaction object to use for this operation.
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
QueryException
public void save(DBTransaction dbt, boolean references) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
dbt
- The transaction object to use for this operation.references
- True if references of this DO should be saved
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
QueryException
public void delete() throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
delete
in interface TypeDefinitionDOI
delete
in class GenericStoreDO
DatabaseManagerException
- if a Transaction can not be created.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
DBRowUpdateException
QueryException
public void delete(DBTransaction dbt) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
delete
in interface TypeDefinitionDOI
delete
in class GenericStoreDO
dbt
- The transaction object to use for this operation.
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
DataObjectException
QueryException
protected void modifyDO(DBTransaction dbt, boolean delete) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
dbt
- The transaction object to use for this operation.delete
- True if doing a delete, otherwise doing insert/update.
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
QueryException
protected void modifyDO(DBTransaction dbt, boolean delete, boolean references) throws java.sql.SQLException, DatabaseManagerException, DataObjectException, RefAssertionException, DBRowUpdateException, QueryException
dbt
- The transaction object to use for this operation.delete
- True if doing a delete, otherwise doing insert/update.references
- True if references should be saved
DatabaseManagerException
- if a Transaction can not be created.
DBRowUpdateException
- if a version error occurs.
RefAssertionException
- thrown by okTo method.
java.sql.SQLException
- if any SQL errors occur.
WebDocWf extension
DataObjectException
QueryException
|
DODS 5.1 API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |