public abstract class TdbFormat extends TdbSerializableObject implements com.tietoenator.trip.jxp.internal.utils.DOMSink, java.lang.Iterable<java.lang.String>
Modifier and Type | Method and Description |
---|---|
java.util.List<java.lang.String> |
content()
Retrieve the content of the format, i.e. its definition
|
void |
copy(java.lang.String newdb,
java.lang.String newname,
TdbControlObject ob)
Copy the current format to a new database and new name.
|
void |
create(java.lang.String frmname)
Create a new format with the specified name, of a type that doesn't require
a qualifying database name (e.g. a TRIPclassic search form).
|
void |
create(java.lang.String frmname,
java.lang.String dbname)
Create a new format with the specified name, for the specified database.
|
void |
delete()
Remove the current form from the server; requires this object to have been created
using a TdbControlObject reference.
|
void |
delete(java.lang.String frmname)
Delete a named format, which must be of a type that doesn't require a qualifying database.
|
void |
delete(java.lang.String frmname,
java.lang.String dbname)
Delete a named format from a named database.
|
void |
export(java.lang.String filename)
Export the current format definition to a named file.
|
void |
export(java.lang.String filename,
java.lang.String frmname)
Export a format definition to a named file.
|
void |
export(java.lang.String filename,
java.lang.String frmname,
java.lang.String dbname)
Export a format definition to a named file.
|
void |
get()
Retrieve the content of the current form.
|
void |
get(java.lang.String frmname)
Retrieve the content of a form from the server.
|
void |
get(java.lang.String frmname,
java.lang.String dbname)
Retrieve the content of a form from the server.
|
java.lang.String |
getComment()
Retrieve any comment associated with the format
|
java.lang.String |
getDatabase()
Retrieve the name of the database or thesaurus with which this form is associated
|
java.lang.String |
getName()
Retrieve the name of the format
|
java.lang.String |
getOwnerName()
Retrieve the name of the creator of the form
|
void |
importUpdate(java.lang.String filename)
Updates the current format with a definition read from a named file
This method causes network I/O. |
void |
importUpdate(java.lang.String filename,
java.lang.String frmname)
Update a format with a definition read from a named file
This method causes network I/O. |
void |
importUpdate(java.lang.String filename,
java.lang.String frmname,
java.lang.String dbname)
Update a format with a definition read from a named file
This method causes network I/O. |
java.util.Iterator<java.lang.String> |
iterator()
Retrieve the content of the format, i.e. its definition
|
void |
put()
Store a potentially updated output format -- in order to make the commit stick, you
must have called one of the setXxx() methods first.
|
void |
rename(java.lang.String newname)
Rename the format to the newly specified name
This method causes network I/O. |
void |
setComment(java.lang.String comment)
Establish the comment associated with the format
|
void |
setContent(java.util.Collection<java.lang.String> lines)
Establish the content of the format, i.e. its definition
|
void |
setDatabase(java.lang.String db)
Establish the name of the database or thesaurus with which this form is associated
|
void |
setName(java.lang.String name)
Establish the name of the format
|
getControlObject
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
cancel, getSession, isCancelable, setCancelable
public java.lang.String getOwnerName()
public java.lang.String getDatabase() throws TdbException
TdbException
public void setDatabase(java.lang.String db) throws TdbException
db
- Database or thesaurus nameTdbException
public java.lang.String getName()
public void setName(java.lang.String name)
name
- Format namepublic java.util.List<java.lang.String> content()
public java.util.Iterator<java.lang.String> iterator()
iterator
in interface java.lang.Iterable<java.lang.String>
public void setContent(java.util.Collection<java.lang.String> lines)
lines
- The lines that make up the format's definitionpublic java.lang.String getComment()
public void setComment(java.lang.String comment)
comment
- The format's new commentpublic void create(java.lang.String frmname, java.lang.String dbname) throws TdbException
frmname
- The name of the format to createdbname
- The database for which the format should be created.TdbException
public void create(java.lang.String frmname) throws TdbException
frmname
- The name of the format to createTdbException
public void delete(java.lang.String frmname, java.lang.String dbname) throws TdbException
frmname
- The format to deletedbname
- The database from which to delete the formatTdbException
public void delete(java.lang.String frmname) throws TdbException
frmname
- The format to deleteTdbException
public void delete() throws TdbException
TdbException
public void get(java.lang.String frmname, java.lang.String dbname) throws TdbException
frmname
- The name of the form to retrievedbname
- The name of the database to which the form being retrieved is attached.TdbException
public void get(java.lang.String frmname) throws TdbException
frmname
- Name of the form to retrieve, must refer to a form that doesn't
require a qualifying database, e.g. a search formTdbException
public void get() throws TdbException
TdbException
public void export(java.lang.String filename, java.lang.String frmname, java.lang.String dbname) throws TdbException
filename
- The name of the file to which the definition should be writtenfrmname
- The name of the format to exportdbname
- The name of the database with which the format is associatedTdbException
public void export(java.lang.String filename, java.lang.String frmname) throws TdbException
filename
- The name of the file to which the definition should be writtenfrmname
- The name of the format to exportTdbException
public void export(java.lang.String filename) throws TdbException
filename
- The name of the file to which the definition should be writtenTdbException
public void put() throws TdbException
TdbException
public void importUpdate(java.lang.String filename, java.lang.String frmname, java.lang.String dbname) throws TdbException
filename
- The name of the file from which to read the updated format definitionfrmname
- The name of the format to be updateddbname
- The name of the database with which the form to be updated is associatedTdbException
public void importUpdate(java.lang.String filename, java.lang.String frmname) throws TdbException
filename
- The name of the file from which to read the updated format definitionfrmname
- The name of the format to be updated, assumes a form type that doesn't
require a qualifying database nameTdbException
public void importUpdate(java.lang.String filename) throws TdbException
filename
- The name of the file from which to read the updated format definitionTdbException
public void copy(java.lang.String newdb, java.lang.String newname, TdbControlObject ob) throws TdbException
newdb
- The name of the database to which the form should be copiednewname
- The name of the new copy of the formob
- If non-null, will receive the Control information for the newly created formTdbException
public void rename(java.lang.String newname) throws TdbException
newname
- The name for the formatTdbException