public class TdbControlObject
extends java.lang.Object
implements com.tietoenator.trip.jxp.internal.utils.DOMSink, java.lang.Iterable<java.lang.String>
TdbControlObjectList
Constructor and Description |
---|
TdbControlObject()
Constructor, creates a blank object
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clear the object's state
|
int |
getCategoryId()
If this object is a category object, this property will contain the
category's unique identifier
|
java.lang.String |
getComment()
Get any comment stored with the object
|
java.lang.String |
getCreateDate()
Get the date on which the object was first committed to CONTROL.
|
java.lang.String |
getCreateTime()
The time on which the first was last committed to CONTROL.
|
java.lang.String |
getCustom(java.lang.String name)
Retrieve the value of the custom key provided
|
java.lang.String |
getDatabase()
If this object is a form object (output format, entry form, search form), this
method will return the form's associated database name
|
int |
getDatabaseRecordCount()
If this object is a database, thesaurus or database cluster object, this
method will return the number of records in the database, thesaurus or cluster
|
TdbExtendedDatabaseType |
getExtendedDatabaseType()
When used with a database, thesaurus or cluster object, this method
retrieves the extended type of that object.
|
java.lang.String |
getExtendedDatabaseTypeName()
Retrieves the name of the extended database type, currently limited to one of
USER, SYSTEM, DEMO, or CLASSES
|
int |
getManagerRights()
If this object is a user object, this method will return the user's management privileges
as a bitmask: bit 0 means user management, bit 1 means file management, bit 2 means system
|
java.lang.String |
getModifiedDate()
Get the date on which the object was last committed to CONTROL.
|
java.lang.String |
getModifiedTime()
Get the time on which the object was last committed to CONTROL.
|
java.lang.String |
getName()
Get the name of the object.
|
TdbControlObjectType |
getObjectType()
Returns the type of this control object.
|
java.lang.String |
getOwnerName()
Retrieve the name of the TRIP user that owns this object
|
TdbAccessRights |
getReadAccess()
If this object is an access rights object, this method will return the
read access level, as a value from the TdbAccessRights enumeration.
|
java.lang.String |
getRealName()
If this object is a user object, this will return the user's real name
|
int |
getSubsystemId()
If this object is a classification subsystem object, this method
will return the subsystem's unique identifier
|
TdbAccessRights |
getWriteAccess()
If this object is an access rights object, this method will return the
write access level, as a value from the TdbAccessRights enumeration
|
boolean |
isAccessRight()
Returns a value reflecting whether this object is an access right object
|
boolean |
isCategory()
Returns a value reflecting whether this object is a category from a classification container object
|
boolean |
isClassificationContainer()
Returns a value reflecting whether this object is a classification container object
|
boolean |
isCluster()
Returns a value reflecting whether this object is a database cluster object
|
boolean |
isDatabase()
Returns a value reflecting whether this object is a database object
|
boolean |
isEntryForm()
Returns a value reflecting whether this object is a TRIPclassic entry form object
|
boolean |
isField()
Returns a value reflecting whether this object is a database field object
|
boolean |
isFileManager()
Returns a value reflecting whether this object is a user object and if that user is an FM
|
boolean |
isGridCluster()
Returns a value reflecting whether this object is a TRIPgrid cluster object
|
boolean |
isGridClusterMember()
Returns a value reflecting whether this object is a TRIPgrid cluster member object
|
boolean |
isGridHost()
Returns a value reflecting whether this object is a TRIPgrid host object
|
boolean |
isGridReplicaSet()
Returns a value reflecting whether this object is a TRIPgrid replica set object
|
boolean |
isGroup()
Returns a value reflecting whether this object is a user group object
|
boolean |
isManager()
Returns a value reflecting whether this object is a user object and if that user is a
manager of any type
|
boolean |
isOutputFormat()
Returns a value reflecting whether this object is an output format object
|
boolean |
isProcedure()
Returns a value reflecting whether this object is a stored procedure object
|
boolean |
isSearchForm()
Returns a value reflecting whether this object is a TRIPclassic search form object
|
boolean |
isSubsystem()
Returns a value reflecting whether this object is a classification subsystem object
|
boolean |
isSystemManager()
Returns a value reflecting whether this object is a user object and if that user is SYSTEM
|
boolean |
isThesaurus()
Returns a value reflecting whether this object is a thesaurus object
|
boolean |
isUser()
Returns a value reflecting whether this object is a user object
|
boolean |
isUserManager()
Returns a value reflecting whether this object is a user object and if that user is a UM
|
boolean |
isXmlEnabled()
Returns a value reflecting whether this database is XML enabled.
|
java.util.Iterator<java.lang.String> |
iterator()
Retrieve an iterator over the custom keys of the object, which may be
a zero-size set.
|
void |
setComment(java.lang.String comment)
Set a comment to accompany the object
|
void |
setDatabase(java.lang.String name)
Set the database with which a form is to be associated; only valid for form types
|
void |
setName(java.lang.String name)
Set the name of the object.
|
void |
setOwnerName(java.lang.String owner)
Set the name of the TRIP user that owns this object (local only)
|
void |
setRealName(java.lang.String name)
If this object is a user object, store the user's real name property
|
public java.lang.String getName()
public void setName(java.lang.String name)
name
- The name to be assigned to the objectpublic java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- The commentpublic java.lang.String getModifiedDate()
public java.lang.String getModifiedTime()
public java.lang.String getCreateDate()
public java.lang.String getCreateTime()
public java.lang.String getOwnerName()
public void setOwnerName(java.lang.String owner)
owner
- The owning user's namepublic TdbExtendedDatabaseType getExtendedDatabaseType()
public java.lang.String getExtendedDatabaseTypeName()
public TdbControlObjectType getObjectType()
public boolean isAccessRight()
public boolean isDatabase()
public boolean isCluster()
public boolean isThesaurus()
public boolean isClassificationContainer()
public boolean isGridCluster()
public boolean isGridClusterMember()
public boolean isGridReplicaSet()
public boolean isGridHost()
public boolean isUser()
public boolean isUserManager()
public boolean isFileManager()
public boolean isSystemManager()
public boolean isManager()
public boolean isGroup()
public boolean isProcedure()
public boolean isOutputFormat()
public boolean isEntryForm()
public boolean isSearchForm()
public boolean isField()
public boolean isSubsystem()
public boolean isCategory()
public boolean isXmlEnabled()
public java.lang.String getRealName()
public void setRealName(java.lang.String name)
name
- The user's real namepublic int getManagerRights()
public java.lang.String getDatabase()
public void setDatabase(java.lang.String name)
name
- The name of the database / thesauruspublic TdbAccessRights getReadAccess()
public TdbAccessRights getWriteAccess()
public int getSubsystemId()
public int getCategoryId()
public int getDatabaseRecordCount()
public java.lang.String getCustom(java.lang.String name)
name
- Name of the custom keypublic void clear()
public java.util.Iterator<java.lang.String> iterator()
iterator
in interface java.lang.Iterable<java.lang.String>