|
Oracle Fusion Middleware Java API Reference for Oracle Business Rules 11g Release 1 (11.1.1) E10663-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RuleRepository
A common API to access rule dictionaries stored in repository.
Method Summary | |
---|---|
void |
close() Close the repository so that resources it holds are released. |
boolean |
exists(DictionaryFQN fqn) Determine whether a dictionary identified by the DictionaryFQN exists in the repository. |
boolean |
exists(java.lang.String pkg, java.lang.String name) Determine whether a dictionary with the specified package and name exists in the repository. |
DictionaryFinder |
getDictionaryFinder() Returns the repository's dictionary finder. |
DictionaryFQN[] |
getNames(DictionaryFQN fqn) Get the fully qualfied names of dictionaries stored in the repository that match the dictionary package and name specified in the DictionaryFQN . |
DictionaryFQN[] |
getNames(java.lang.String pkg, java.lang.String name) Get the fully qualfied names of dictionaries stored in the repository that match the specified dictionary package and name. |
RepositoryContext |
getRepositoryContext() Get the context for this repository. |
RepositoryType |
getRepositoryType() Get the rule repository type. |
void |
init(RepositoryContext ctx) Initialize the repository by passing security and configuration information. |
boolean |
isStale(DictionaryFQN fqn) Check if a newer version of a dictionary is available. |
boolean |
isStale(java.lang.String pkg, java.lang.String name) Check if a newer version of a dictionary is available. |
RuleDictionary |
load(DictionaryFQN fqn) Load a dictionary from the repository. |
RuleDictionary |
load(java.lang.String pkg, java.lang.String name) Load a dictionary from the repository. |
void |
registerChangeListener(RepositoryChangeListener dcl) Register a listener for dictionary changes. |
void |
remove(DictionaryFQN fqn) Remove the dictionary identified by its fully qualified name from repository. |
void |
remove(java.lang.String pkg, java.lang.String name) Remove the dictionary identified by the package and name from repository. |
void |
rename(DictionaryFQN fqn, DictionaryFQN newFQN, boolean overwrite) Rename a dictionary in the repository. |
void |
rename(RuleDictionary dictionary, DictionaryFQN newFQN, boolean overwrite) Rename the specified dictionary in the repository. |
void |
rename(RuleDictionary dictionary, java.lang.String newPkg, java.lang.String newName, boolean overwrite) Rename the specified dictionary in the repository. |
void |
rename(java.lang.String pkg, java.lang.String name, java.lang.String newPkg, java.lang.String newName, boolean overwrite) Rename a dictionary in the repository. |
void |
save(RuleDictionary dictionary) Save a dictionary to the repository. |
void |
saveAs(RuleDictionary dictionary, DictionaryFQN fqn, boolean overwrite) Save a dictionary to repository with a new identity. |
void |
saveAs(RuleDictionary dictionary, java.lang.String pkg, java.lang.String name, boolean overwrite) Save a dictionary to repository with a new identity. |
void |
unregisterChangeListener(RepositoryChangeListener dcl) Unregister a listener for dictionary changes. |
Method Detail |
---|
void init(RepositoryContext ctx) throws RepositoryException
ctx
- an instance of the RepositoryContext
class which contains security and repository configuration information.RepositoryException
- if error is encountered in repository initializationRepositoryContext getRepositoryContext()
RepositoryType getRepositoryType()
DictionaryFQN[] getNames(java.lang.String pkg, java.lang.String name) throws RepositoryException
pkg
- the dictionary package. A null value means "don't care" and all dictionary packages in the repository will match.name
- the dictionary name. A null value means "don't care" and all dictionary names in the repository will match.RepositoryException
- if error when accessing the repositoryDictionaryFQN[] getNames(DictionaryFQN fqn) throws RepositoryException
DictionaryFQN
.fqn
- the DictionaryFQN
that specifies the desired dictionary package and name. A null value for any of these means "don't care" and any corresponding value will match.DictionaryFQN
may be null indicating that any value may match that property. If no dictionaries in the repository match the specified DictionaryFQN
, a 0 length array is returned.RepositoryException
- if error occurs when accessing the repositoryboolean exists(java.lang.String pkg, java.lang.String name) throws RepositoryException
pkg
- the dictionary packagename
- the dictionary nameRepositoryException
- if error occurs accessing the repositoryboolean exists(DictionaryFQN fqn) throws RepositoryException
DictionaryFQN
exists in the repository.fqn
- the fully qualified name of the dictionary.RepositoryException
- if error occurs accessing the repositoryRuleDictionary load(java.lang.String pkg, java.lang.String name) throws RepositoryException, SDKException
pkg
- the dictionary packagename
- the dictionary nameRuleDictionary
for the dictionary identified by the dictionary package and name.RepositoryException
- if error when loading the dictionarySDKException
RuleDictionary load(DictionaryFQN fqn) throws RepositoryException, SDKException
fqn
- the fully qualified name of the dictionary.RuleDictionary
for the dictionary identified by the fully qualified name.RepositoryException
- if error occurred loading the dictionary from the repository.SDKException
- if error occurred creating the RuleDictionary object.void save(RuleDictionary dictionary) throws RepositoryException, SDKException
dictionary
- the rule dictionary to saveRepositoryException
- an error occured in the attempt to save the dictionary.SDKException
- if an error occured serializing the dictionary to XML.void saveAs(RuleDictionary dictionary, java.lang.String pkg, java.lang.String name, boolean overwrite) throws RepositoryException, SDKException
dictionary
- the rule dictionary to savepkg
- the new dictionary package.name
- the new dictionary name.overwrite
- a value of true will allow overwriting an existing dictionary with the name composed from pkg
and name
. Otherwise, an exception is thrown if the dictionary already exists.DictionaryAlreadyExistsException
- a dictionary with the same package and name already exists in the repository.RepositoryException
- an exception occured during the attempt to save the dictionary in the repository.SDKException
- if an error occured serializing the dictionary to XML or in the in-memory dictionary rename.void saveAs(RuleDictionary dictionary, DictionaryFQN fqn, boolean overwrite) throws RepositoryException, SDKException
dictionary
- the rule dictionary to savefqn
- the new fully qualified name for the dictionary.overwrite
- a value of true will allow overwriting an existing dictionary with the name fqn
. Otherwise, an exception is thrown if the dictionary already exists.DictionaryAlreadyExistsException
- a dictionary with the same fully qualified name already exists in the repository.RepositoryException
- an exception occured during the attempt to save the dictionary in the repository.SDKException
- if an error occured serializing the dictionary to XML or in the in-memory dictionary rename.void remove(java.lang.String pkg, java.lang.String name) throws RepositoryException
pkg
- the dictionary packagename
- the dictionary nameRepositoryException
- an exception occured attempting to remove the dictionaryvoid remove(DictionaryFQN fqn) throws RepositoryException
fqn
- the fully qualified nameRepositoryException
- an exception occured attempting to remove the dictionaryvoid rename(java.lang.String pkg, java.lang.String name, java.lang.String newPkg, java.lang.String newName, boolean overwrite) throws SDKException
pkg
- the dictionary packagename
- name of the dictionary to renamenewPkg
- the new dictionary packagenewName
- the new name of the dictionaryoverwrite
- a value of true will allow overwriting an existing dictionary with the name composed from newPkg
and newName
. Otherwise, an exception is thrown if the dictionary exists.DictionaryNotFoundException
- a dictionary with the package oldPkg
and name oldName
does not exist in the repository.DictionaryAlreadyExistsException
- a dictionary with the package newPkg
and name newName
already exists in the repository.RepositoryException
- thrown if the dictionary can not be renamedSDKException
- if an error occured renaming the dictionary itself.void rename(DictionaryFQN fqn, DictionaryFQN newFQN, boolean overwrite) throws SDKException
fqn
- the current fully qualified name of the dictionarynewFQN
- the new fully qualified name.overwrite
- a value of true will allow overwriting an existing dictionary with the name newFQN
. Otherwise, an exception is thrown if the dictionary exists.DictionaryNotFoundException
- a dictionary with the qualified name oldFQN
does not exist in the repository.DictionaryAlreadyExistsException
- a dictionary with the qualified name newFQN
already exists in the repository.RepositoryException
- thrown if the dictionary can not be renamedSDKException
- if an error occured renaming the dictionary itself.void rename(RuleDictionary dictionary, java.lang.String newPkg, java.lang.String newName, boolean overwrite) throws SDKException
dictionary
- the dictionary to be renamed.newPkg
- the new dictionary packagenewName
- the new name of the dictionaryoverwrite
- a value of true will allow overwriting an existing dictionary with the name composed from newPkg
and newName
. Otherwise, an exception is thrown if the dictionary exists.DictionaryNotFoundException
- the specified dictionary does not exist in the repository.DictionaryAlreadyExistsException
- a dictionary with the package newPkg
and name newName
already exists in the repository.RepositoryException
- thrown if the dictionary can not be renamedSDKException
- if an error occured renaming the dictionary itself.void rename(RuleDictionary dictionary, DictionaryFQN newFQN, boolean overwrite) throws SDKException
dictionary
- the dictionary to be renamed.newFQN
- the new fully qualified name.overwrite
- a value of true will allow overwriting an existing dictionary with the name newFQN
. Otherwise, an exception is thrown if the dictionary exists.DictionaryNotFoundException
- the specified dictionary does not exist in the repository.DictionaryAlreadyExistsException
- a dictionary with the qualified name newFQN
already exists in the repository.RepositoryException
- thrown if the dictionary can not be renamedSDKException
- if an error occured renaming the dictionary itself.boolean isStale(java.lang.String pkg, java.lang.String name) throws RepositoryException
pkg
- the dictionary packagename
- the dictionary nametrue
if
false
.RepositoryException
- an error occured in the checkboolean isStale(DictionaryFQN fqn) throws RepositoryException
fqn
- the fully qualified name of the dictionarytrue
if
false
.RepositoryException
- an error occured in the checkvoid registerChangeListener(RepositoryChangeListener dcl) throws RepositoryException
RepositoryException
- an error occured in the checkvoid unregisterChangeListener(RepositoryChangeListener dcl) throws RepositoryException
RepositoryException
- an error occured in the checkvoid close() throws RepositoryException
RepositoryException
- an exception occured during closing the repositoryDictionaryFinder getDictionaryFinder()
|
Oracle Fusion Middleware Java API Reference for Oracle Business Rules 11g Release 1 (11.1.1) E10663-03 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |