Package com.tietoenator.trip.jxp.forms
Class TdbFormat
java.lang.Object
com.tietoenator.trip.jxp.session.TdbSessionObject
com.tietoenator.trip.jxp.TdbMessageProvider
com.tietoenator.trip.jxp.session.TdbSerializableObject
com.tietoenator.trip.jxp.forms.TdbFormat
- All Implemented Interfaces:
com.tietoenator.trip.jxp.internal.utils.DOMSink
,TdbControlObjectProvider
,Iterable<String>
- Direct Known Subclasses:
TdbEntryForm
,TdbOutputFormat
,TdbSearchForm
public abstract class TdbFormat
extends TdbSerializableObject
implements com.tietoenator.trip.jxp.internal.utils.DOMSink, Iterable<String>
This is an abstract base class for all types of forms exposed by the TRIP
server (output formats or reports, TRIPclassic data entry forms, and
TRIPclassic search forms).
-
Method Summary
Modifier and TypeMethodDescriptioncontent()
Retrieve the content of the format, i.e.void
copy
(String newdb, String newname, TdbControlObject ob) Copy the current format to a new database and new name.void
Create a new format with the specified name, of a type that doesn't require a qualifying database name (e.g.void
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 a named format, which must be of a type that doesn't require a qualifying database.void
Delete a named format from a named database.void
Export the current format definition to a named file.void
Export a format definition to a named file.void
Export a format definition to a named file.void
get()
Retrieve the content of the current form.void
Retrieve the content of a form from the server.void
Retrieve the content of a form from the server.Retrieve any comment associated with the formatRetrieve the name of the database or thesaurus with which this form is associatedgetName()
Retrieve the name of the formatRetrieve the name of the creator of the formvoid
importUpdate
(String filename) Updates the current format with a definition read from a named filevoid
importUpdate
(String filename, String frmname) Update a format with a definition read from a named filevoid
importUpdate
(String filename, String frmname, String dbname) Update a format with a definition read from a named fileiterator()
Retrieve the content of the format, i.e.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 the format to the newly specified namevoid
setComment
(String comment) Establish the comment associated with the formatvoid
setContent
(Collection<String> lines) Establish the content of the format, i.e.void
setDatabase
(String db) Establish the name of the database or thesaurus with which this form is associatedvoid
Establish the name of the formatMethods inherited from class com.tietoenator.trip.jxp.session.TdbSerializableObject
getControlObject
Methods inherited from class com.tietoenator.trip.jxp.TdbMessageProvider
codeList, getLastCode, getLastMessage, hasMessages, messageList, resetMessages
Methods inherited from class com.tietoenator.trip.jxp.session.TdbSessionObject
cancel, getSession, isCancelable, setCancelable
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Method Details
-
getOwnerName
Retrieve the name of the creator of the form- Returns:
- Owning user's name
-
getDatabase
Retrieve the name of the database or thesaurus with which this form is associated- Returns:
- Name of database or thesaurus
- Throws:
TdbException
-
setDatabase
Establish the name of the database or thesaurus with which this form is associated- Parameters:
db
- Database or thesaurus name- Throws:
TdbException
-
getName
Retrieve the name of the format- Returns:
- Format name
-
setName
Establish the name of the format- Parameters:
name
- Format name
-
content
Retrieve the content of the format, i.e. its definition- Returns:
- The lines that make up the format's definition
-
iterator
Retrieve the content of the format, i.e. its definition -
setContent
Establish the content of the format, i.e. its definition- Parameters:
lines
- The lines that make up the format's definition
-
getComment
Retrieve any comment associated with the format- Returns:
- The comment, if any
-
setComment
Establish the comment associated with the format- Parameters:
comment
- The format's new comment
-
create
Create a new format with the specified name, for the specified database.This method causes network I/O.
- Parameters:
frmname
- The name of the format to createdbname
- The database for which the format should be created.- Throws:
TdbException
-
create
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).This method causes network I/O.
- Parameters:
frmname
- The name of the format to create- Throws:
TdbException
-
delete
Delete a named format from a named database.This method causes network I/O.
- Parameters:
frmname
- The format to deletedbname
- The database from which to delete the format- Throws:
TdbException
-
delete
Delete a named format, which must be of a type that doesn't require a qualifying database.This method causes network I/O.
- Parameters:
frmname
- The format to delete- Throws:
TdbException
-
delete
Remove the current form from the server; requires this object to have been created using a TdbControlObject reference.This method causes network I/O.
- Throws:
TdbException
-
get
Retrieve the content of a form from the server.This method causes network I/O.
- Parameters:
frmname
- The name of the form to retrievedbname
- The name of the database to which the form being retrieved is attached.- Throws:
TdbException
-
get
Retrieve the content of a form from the server.This method causes network I/O.
- Parameters:
frmname
- Name of the form to retrieve, must refer to a form that doesn't require a qualifying database, e.g. a search form- Throws:
TdbException
-
get
Retrieve the content of the current form.This method causes network I/O.
- Throws:
TdbException
-
export
Export a format definition to a named file.This method causes network I/O.
- Parameters:
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 associated- Throws:
TdbException
-
export
Export a format definition to a named file.This method causes network I/O.
- Parameters:
filename
- The name of the file to which the definition should be writtenfrmname
- The name of the format to export- Throws:
TdbException
-
export
Export the current format definition to a named file.This method causes network I/O.
- Parameters:
filename
- The name of the file to which the definition should be written- Throws:
TdbException
-
put
Store a potentially updated output format -- in order to make the commit stick, you must have called one of the setXxx() methods first.This method causes network I/O.
- Throws:
TdbException
-
importUpdate
Update a format with a definition read from a named fileThis method causes network I/O.
- Parameters:
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 associated- Throws:
TdbException
-
importUpdate
Update a format with a definition read from a named fileThis method causes network I/O.
- Parameters:
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 name- Throws:
TdbException
-
importUpdate
Updates the current format with a definition read from a named fileThis method causes network I/O.
- Parameters:
filename
- The name of the file from which to read the updated format definition- Throws:
TdbException
-
copy
Copy the current format to a new database and new name.This method causes network I/O.
- Parameters:
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 form- Throws:
TdbException
-
rename
Rename the format to the newly specified nameThis method causes network I/O.
- Parameters:
newname
- The name for the format- Throws:
TdbException
-