|
Oracle Business Rules Java API Reference 10g (10.1.3.1.0) B28966-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.rules.sdk.store.AbstractRepositoryConnection
Provides a partial implementation of the RepositoryConnection
interface. All implementations of the RepositoryConnection
interface should extend this class.
Field Summary |
Fields inherited from interface oracle.rules.sdk.store.RepositoryConnection |
CREATION_METADATA, LAST_MODIFIED_METADATA, REVISION_CONTROL_OPTION, REVISION_METADATA, TAG_METADATA, TAGS_OPTION |
Constructor Summary | |
AbstractRepositoryConnection() |
Method Summary | |
boolean |
cachesModifications() Returns true if the underlying implementation caches repository modifications. |
abstract void |
createDocument(DocumentID id, org.w3c.dom.Document document) Creates a new document in the repository, identified by the specified Document with the specified initial content. |
DocumentID |
createDocumentID() Creates an empty DocumentID for use with this RepositoryConnection . |
DocumentID |
createDocumentID(DocumentID id) Creates a DocumentID for use with this RepositoryConnection from the specified DocumentID. |
DocumentID |
createDocumentID(java.lang.String dictionaryName, java.lang.String documentType, java.lang.String documentName, java.lang.String marker, java.lang.String revision, java.lang.String tag) Creates a DocumentID for use with this RepositoryConnection from the individual components. |
abstract void |
deleteDocument(DocumentID id) Deletes the document identified by the specified DocumentID from the repository. |
void |
flush() Flushes repository modifications to the underlying repository. |
abstract org.w3c.dom.Document |
getDocument(DocumentID id) Gets the document identified by the specified DocumentID . |
abstract java.util.Map |
getDocumentMetadata(DocumentID id) Gets the metadata for the document identified by the specified DocumentID . |
java.util.ResourceBundle |
getResourceBundle() Gets the ResourceBundle for messages for this package. |
void |
init(java.security.Principal principal, java.util.Locale locale, SensitiveDataCallback callback, java.util.Properties properties) Common initialization for a repository connection. |
boolean |
isOptionSupported(java.lang.String option) Tests if the specified option is supported. |
abstract DocumentID[] |
listDocuments(DocumentID id) Returns a list of DocumentID 's that match the specified DocumentID . |
abstract void |
markDocuments(java.lang.String marker, DocumentID[] ids) Associates the marker with the documents identified by the array of DocumentID s. |
abstract void |
release() Releases this repository connection. |
abstract void |
updateDocument(DocumentID id, org.w3c.dom.Document document) Updates a document identified by the specified DocumentID with the specified content. |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
public AbstractRepositoryConnection()
Method Detail |
public void init(java.security.Principal principal, java.util.Locale locale, SensitiveDataCallback callback, java.util.Properties properties) throws StoreException
init
method of the class that extends this class.init
in interface RepositoryConnection
principal
- the identity to be used for authorization purposes.locale
- the Locale to be used. May be null.callback
- the callback object for retrieving sensitive dataproperties
- initialization parameters required by a specific implementation of this interface.StoreException
- if an error was encountered initializing this session.public abstract void release() throws StoreException
release
in interface RepositoryConnection
StoreException
- if an error was encountered releasing this session.public abstract void createDocument(DocumentID id, org.w3c.dom.Document document) throws DocumentExistsException, DocumentIDException, DocumentException, StoreException
Document
with the specified initial content. The DocumentID
must not specify a tag nor a revision.createDocument
in interface RepositoryConnection
id
- a DocumentID
that identifies the document to be created. The ID should be validated prior to invoking this method.document
- the initial content of the document.DocumentException
- if an error is encountered processing the documentDocumentExistsException
- if a document corresponding to DocumentID
already exists.DocumentIDException
- if the DocumentID
is not validStoreException
- if an error was encountered creating the document or if a document associated with the specified DocumentID
already exists.public abstract void deleteDocument(DocumentID id) throws DocumentNotFoundException, DocumentIDException, StoreException
DocumentID
from the repository. The DocumentID
must not specify a tag nor a revision.deleteDocument
in interface RepositoryConnection
id
- a DocumentID
that identifies the document to be deleted. The ID should be validated prior to invoking this method.DocumentNotFoundException
- if a document corresponding to the specified DocumentID
does not exist.DocumentIDException
- if the DocumentID
is not validStoreException
- if an error was encountered deleting the document.public abstract org.w3c.dom.Document getDocument(DocumentID id) throws DocumentNotFoundException, DocumentIDException, StoreException
DocumentID
.getDocument
in interface RepositoryConnection
id
- a DocumentID
that identifies the document. The ID should be validated prior to invoking this method.DocumentNotFoundException
- if a document corresponding to the specified DocumentID
does not exist.DocumentIDException
- if the DocumentID
is not validStoreException
- if an error occurs retrieving the document.public abstract void updateDocument(DocumentID id, org.w3c.dom.Document document) throws DocumentNotFoundException, DocumentIDException, DocumentException, StoreException
DocumentID
with the specified content. The DocumentID
must not specify a tag nor a revision. The new document content overwrites the previous content.updateDocument
in interface RepositoryConnection
id
- a DocumentID
that identifies the document. The ID should be validated prior to invoking this method.document
- the new content of the document.DocumentException
- if an error is encountered processing the documentDocumentNotFoundException
- if a document corresponding to the specified DocumentID
does not exist.DocumentIDException
- if the DocumentID
is not validStoreException
- if document update failspublic abstract java.util.Map getDocumentMetadata(DocumentID id) throws DocumentNotFoundException, DocumentIDException, StoreException
DocumentID
.getDocumentMetadata
in interface RepositoryConnection
id
- a DocumentID
that identifies the document. The ID should be validated prior to invoking this method.DocumentNotFoundException
- if a document corresponding to the specified DocumentID
does not exist.DocumentIDException
- if the DocumentID
is not validStoreException
- if metadata retrieval fails for the documentpublic abstract DocumentID[] listDocuments(DocumentID id) throws DocumentIDException, StoreException
DocumentID
's that match the specified DocumentID
. The specified id may contain wildcards.listDocuments
in interface RepositoryConnection
id
- a DocumentID that may contain wildcards. The ID should be validated prior to invoking this method.DocumentID
's. The list is empty if no documents match.DocumentIDException
- if the DocumentID
is not validStoreException
- if an error is encountered.public boolean cachesModifications()
true
if the underlying implementation caches repository modifications. flush
must be invoked to flush the modifications to the repository.cachesModifications
in interface RepositoryConnection
true
if repository modifications are cached.public void flush() throws StoreException
cachesModifications
returns false, the behavior of this method is undefined.flush
in interface RepositoryConnection
StoreException
- if an error was encountered flushing the modifications.public boolean isOptionSupported(java.lang.String option)
isOptionSupported
in interface RepositoryConnection
option
- the name of the option.true
if the specified option is supported.public DocumentID createDocumentID()
DocumentID
for use with this RepositoryConnection
. Once created and populated, it must be validated for use by invoking the validation method appropriate for the intended use.createDocumentID
in interface RepositoryConnection
public DocumentID createDocumentID(java.lang.String dictionaryName, java.lang.String documentType, java.lang.String documentName, java.lang.String marker, java.lang.String revision, java.lang.String tag)
DocumentID
for use with this RepositoryConnection
from the individual components. Once created, it must be validated for use by invoking the validation method appropriate for the intended use.createDocumentID
in interface RepositoryConnection
dictionaryName
- the name of the dictionarydocumentType
- the type of documentdocumentName
- the name of the documentmarker
- an optional marker associated with the documentrevision
- a document revision string. It may be null
.tag
- a tag string. It may be null
.public DocumentID createDocumentID(DocumentID id)
DocumentID
for use with this RepositoryConnection
from the specified DocumentID. Once created, it must be validated for use by invoking the validation method appropriate for the intended use.createDocumentID
in interface RepositoryConnection
id
- the DocumentID the new ID is populated from.public abstract void markDocuments(java.lang.String marker, DocumentID[] ids) throws StoreException, DocumentNotFoundException, DocumentIDException
DocumentID
s.markDocuments
in interface RepositoryConnection
marker
- the marker.ids
- an array of DocumentID
s which identify the documents to be associated with the marker. Each DocumentID
should be validated prior to invoking this method.StoreException
- if an error was encountered marking the documents.DocumentNotFoundException
- if no document exists for any DocumentID
in the array.DocumentIDException
- if any of the DocumentID
s in the array are invalidpublic java.util.ResourceBundle getResourceBundle()
|
Oracle Business Rules Java API Reference 10g (10.1.3.1.0) B28966-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |