public interface TNonXMLObjectAccessor extends TAccessor
Modifier and Type | Method and Description |
---|---|
TResponse |
delete(TNonXMLObject nonXMLObject)
Deletes the non-XML document represented by the TNonXMLObject in the Tamino database.
|
TResponse |
delete(TQuery query)
Deletes the non-XML document the specified by the query expression.
|
TResponse |
insert(TNonXMLObject nonXmlObject)
Inserts the non-XML document represented by the TNonXMLObject instance
into the Tamino database.
|
TResponse |
query(TQuery query)
Queries a set of non-XML documents that satisfy the query expression.
|
TNonXMLObject |
retrieve(TNonXMLObject nonXMLObject)
Retrieves a single non-XML document from Tamino.
|
TStreamHeader |
retrieveHeader(TNonXMLObject nonXMLObject)
Just retrieves the ´meta´ data of a single document from Tamino.
|
TResponse |
update(TNonXMLObject nonXMLObject)
Updates the non-XML document represented by the TNonXMLObject instance in
the Tamino database.
|
TResponse |
xquery(TXQuery xquery)
Queries a set of non-XML documents that satisfy the xquery expression.
|
cancelRequests, getAccessLocation, getApplicationName, getCanBeCancelled, getLockMode, getLockwaitMode, getMaximumRequestDuration, setAccessLocation, setApplicationName, setCanBeCancelled, setLockMode, setLockwaitMode, setMaximumRequestDuration
invalidate
TResponse insert(TNonXMLObject nonXmlObject) throws TInsertException
The following characterizes this behavior:
!nonXMLObject.hasDocname() | Insert. |
nonXMLObject.hasDocname() | Insert, if a document with the given ino:docname does not exist. |
nonXMLObject.hasDocname() | Update, if a document with the given ino:docname already exists. |
nonXmlObject
- is the representation of the non XML document to be stored in Tamino.TInsertException
- signals an error while attempting the insert operation.TResponse update(TNonXMLObject nonXMLObject) throws TUpdateException
If an update is done based on an id and the non-XML object being updated had a docname, the docname is deleted, i.e. the non-XML object no longer has a docname after the update operation.
If the TNonXMLObject instance carries no id and no non-XML object exists with the same docname a new object will be inserted, otherwise the object will be replaced.
The following characterizes this behavior:
nonXMLObject.hasId() && !nonXMLObject.hasDocname() | Update, if the document with the given id exists, otherwise TUpdateException will be thrown. |
!xmlObject.hasId() && nonXMLObject.hasDocname() | Update, if the document with the given docname exists, otherwise Insert. |
xmlObject.hasId() && nonXMLObject.hasDocname() | Update, if the document with the given docname does exist, otherwise Insert. |
nonXMLObject
- is the representation of the non-XML document to
be updated in Tamino.TUpdateException
- signals an error while attempting the update operation.TResponse delete(TNonXMLObject nonXMLObject) throws TDeleteException
nonXmlObject
- is the representation of the non-XML document to be deleted from Tamino.TDeleteException
- signals an error while attempting the delete operation.TResponse delete(TQuery query) throws TDeleteException
query
- query expression which specifies a set of non-XML documents to be
deleted.TDeleteException
- signals an error while attempting the delete operation.TResponse query(TQuery query) throws TQueryException
query
- query expression which specifies a set of non-XML documents to be retrieved.TQueryException
- signals an error while attempting the query operation.TResponse xquery(TXQuery xquery) throws TXQueryException
This feature requires Tamino 4.1
xquery
- query expression which specifies a set of non-XML documents to be retrieved.TXQueryException
- signals an error while attempting the query operation.TNonXMLObject retrieve(TNonXMLObject nonXMLObject) throws TRetrieveException
Retrieves a single non-XML document from Tamino. The document is retrieved by its docname or id as set in the TNonXMLObject instance passed as input parameter and not by a query expression. If both docname and id are present in the TNonXMLObject instance, the docname is used.
nonXMLObject
- a TNonXMLObject instance specifying by its doctype, id or docname information
which non-XML document to retrieve from Tamino.TRetrieveException
- signals an error while attempting the retrieve operation.TStreamHeader retrieveHeader(TNonXMLObject nonXMLObject) throws TRetrieveException
Just retrieves the ´meta´ data of a single document from Tamino. This data is retrieved by its docname or id as set in the TNonXMLObject instance passed as input parameter and not by a query expression. If both docname and id are present in the TNonXMLObject instance, the docname is used.
This method behaves like the retrieve()
method except that
it does not retieve the whole document but only its ´meta´ data, which is
contained in the TStreamHeader
.
xmlObject
- a TNonXMLObject instance specifying by its doctype, id or docname information
which document to retrieve from Tamino.TRetrieveException
- signals an error while attempting the retrieve operation.com.softwareag.tamino.db.api.accessor.TStreamAccessor#retrieve(TNonXMLObject)
Copyright (c) 2017 Software AG. All Rights Reserved.