com.ibm.websphere.brb.mgmt
Class _IRuleFolder_Stub

java.lang.Object
  |
  +--org.omg.CORBA.portable.ObjectImpl
        |
        +--org.omg.CORBA_2_3.portable.ObjectImpl
              |
              +--javax.rmi.CORBA.Stub
                    |
                    +--com.ibm.websphere.brb.mgmt._IRuleFolder_Stub
All Implemented Interfaces:
IRuleFolder, org.omg.CORBA.Object, java.rmi.Remote, java.io.Serializable

public class _IRuleFolder_Stub
extends javax.rmi.CORBA.Stub
implements IRuleFolder, java.rmi.Remote

See Also:
Serialized Form

Constructor Summary
_IRuleFolder_Stub()
           
 
Method Summary
 java.lang.String[] _ids()
           
 IRule createRule(int arg0, IRule arg1)
          Creates a rule into this folder initialized with the contents of the given rule.
 IRule createRule(int arg0, IRule arg1, java.lang.String arg2)
          Creates a rule into this folder initialized with the contents of the given rule and set to the given primary key.
 IRule createRule(int arg0, java.lang.String arg1)
          Creates a rule into this folder with the given name.
 IRule createRule(int arg0, java.lang.String arg1, java.lang.String arg2)
          Creates a rule into this folder with the given name and primary key.
 IRuleFolder createSubFolder(java.lang.String arg0)
          Creates a folder or hierarchy of folders as a child of this folder.
 void delete()
          Deletes this folder and all of its children.
 void deleteAllRules()
          Delete all rules contained in this folder.
 void deleteAllSubFolders()
          Delete all subfolders contained in this folder.
 IRule findRuleByPrimaryKey(java.lang.String arg0, boolean arg1, int arg2)
          Find a rule in this folder with the given primary key.
 java.util.Collection findRules(boolean arg0, int arg1)
          Gets all rules contained within this folder.
 java.util.Collection findRules(QueryNode arg0, boolean arg1, int arg2)
          Look in this folder for rules that match the given query.
 java.util.Collection findRulesByName(java.lang.String arg0, boolean arg1, int arg2)
          Look in this folder for a rule with the given name.
 java.lang.String getFullName()
          Get the fully qualified name of this folder.
 java.lang.String getName()
          Returns the name of this folder.
 IRuleFolder getParent()
          This method returns the parent folder for this folder.
 IRuleFolder getRoot()
          Returns the root IRuleFolder for this rule namespace.
 IRuleFolder getSubFolder(java.lang.String arg0)
          Gets the folder for the given relative path.
 IRuleFolder getSubFolder(java.lang.String arg0, boolean arg1)
          Gets the folder for the given relative path.
 java.util.Collection getSubFolders()
          Gets all folders directly contained within this folder.
 void move(IRuleFolder arg0)
          Move this folder into a new folder.
 void rename(java.lang.String arg0)
          Renames this folder.
 
Methods inherited from class javax.rmi.CORBA.Stub
connect, equals, hashCode, toString
 
Methods inherited from class org.omg.CORBA_2_3.portable.ObjectImpl
_get_codebase
 
Methods inherited from class org.omg.CORBA.portable.ObjectImpl
_create_request, _create_request, _duplicate, _get_delegate, _get_domain_managers, _get_interface_def, _get_policy, _hash, _invoke, _is_a, _is_equivalent, _is_local, _non_existent, _orb, _release, _releaseReply, _request, _request, _servant_postinvoke, _servant_preinvoke, _set_delegate, _set_policy_override
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

_IRuleFolder_Stub

public _IRuleFolder_Stub()
Method Detail

_ids

public java.lang.String[] _ids()
Overrides:
_ids in class org.omg.CORBA.portable.ObjectImpl

createRule

public IRule createRule(int arg0,
                        IRule arg1)
                 throws BusinessRuleBeansException,
                        java.rmi.RemoteException
Description copied from interface: IRuleFolder
Creates a rule into this folder initialized with the contents of the given rule. The new rule will be the same as the original rule, except that a new primary key is generated and the folder containing the new rule is this folder. The rule can be created as a copy (IRule.TYPE_COPY) or as a reference to the persistent rule (IRule.TYPE_REFERENCE). When creating the rule as a local copy, an instance of class IRuleCopy is returned. The persistent rule is not created on the server until method updatePersistentRule is called on the IRuleCopy. When returning a reference, the persistent rule is created on the server immediately.
Specified by:
createRule in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
ruleReturnType - indicates whether to return a local copy (IRule.TYPE_COPY) or a reference (IRule.TYPE_REFERENCE)
sourceRule - the rule whose values are copied to get the new rule
Returns:
the newly created rule
Throws:
BRBeansIllegalArgumentException - if the ruleReturnType is not valid or the sourceRule is null

createRule

public IRule createRule(int arg0,
                        IRule arg1,
                        java.lang.String arg2)
                 throws BusinessRuleBeansException,
                        java.rmi.RemoteException
Description copied from interface: IRuleFolder
Creates a rule into this folder initialized with the contents of the given rule and set to the given primary key. The new rule will be the same as the original rule, except that the primary key has the given value and the folder containing the new rule is this folder. The rule can be created as a copy (IRule.TYPE_COPY) or as a reference to the persistent rule (IRule.TYPE_REFERENCE). When creating the rule as a local copy, an instance of class IRuleCopy is returned. The persistent rule is not created on the server until method updatePersistentRule is called on the IRuleCopy. When returning a reference, the persistent rule is created on the server immediately.
Specified by:
createRule in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
ruleReturnType - indicates whether to return a local copy (IRule.TYPE_COPY) or a reference (IRule.TYPE_REFERENCE)
sourceRule - the rule whose values are copied to get the new rule
primaryKey - the primary key of the new rule
Returns:
the newly created rule
Throws:
BRBeansIllegalArgumentException - if the ruleReturnType is not valid or the sourceRule or primaryKey is null

createRule

public IRule createRule(int arg0,
                        java.lang.String arg1)
                 throws BusinessRuleBeansException,
                        java.rmi.RemoteException
Description copied from interface: IRuleFolder
Creates a rule into this folder with the given name. The rule can be created as a copy (IRule.TYPE_COPY) or as a reference to the persistent rule (IRule.TYPE_REFERENCE). When creating the rule as a local copy, an instance of class IRuleCopy is returned. The persistent rule is not created on the server until method updatePersistentRule is called on the IRuleCopy. When returning a reference, the persistent rule is created on the server immediately.
Specified by:
createRule in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
ruleReturnType - indicates whether to return a local copy (IRule.TYPE_COPY) or a reference (IRule.TYPE_REFERENCE)
name - the name of the Rule
Returns:
the newly created rule
Throws:
BRBeansIllegalArgumentException - if the ruleReturnType is not valid

createRule

public IRule createRule(int arg0,
                        java.lang.String arg1,
                        java.lang.String arg2)
                 throws BusinessRuleBeansException,
                        java.rmi.RemoteException
Description copied from interface: IRuleFolder
Creates a rule into this folder with the given name and primary key. The rule can be created as a copy (IRule.TYPE_COPY) or as a reference to the persistent rule (IRule.TYPE_REFERENCE). When creating the rule as a local copy, an instance of class IRuleCopy is returned. The persistent rule is not created on the server until method updatePersistentRule is called on the IRuleCopy. When returning a reference, the persistent rule is created on the server immediately.
Specified by:
createRule in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
ruleReturnType - indicates whether to return a copy (IRule.TYPE_COPY) or a reference (IRule.TYPE_REFERENCE)
name - the name of the rule
primaryKey - the primary key to give this rule
Returns:
the newly created rule
Throws:
BRBeansIllegalArgumentException - if the ruleReturnType is not valid or the primaryKey is null

createSubFolder

public IRuleFolder createSubFolder(java.lang.String arg0)
                            throws BusinessRuleBeansException,
                                   java.rmi.RemoteException
Description copied from interface: IRuleFolder
Creates a folder or hierarchy of folders as a child of this folder. The name passed can be either a single folder name or a relative path name. Any folders along the path that do not exist will be created. If the given path already exists a BusinessRuleBeansException is thrown. The given path must be non-null and non-empty.
Specified by:
createSubFolder in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
path - the path of the new folder
Returns:
the newly created folder
Throws:
BusinessRUleBeansException - if the folder or path already exists

delete

public void delete()
            throws BusinessRuleBeansException,
                   java.rmi.RemoteException
Description copied from interface: IRuleFolder
Deletes this folder and all of its children. All contained rules and subfolders are deleted.
Specified by:
delete in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Throws:
BusinessRUleBeansException - if this folder is the root folder

deleteAllRules

public void deleteAllRules()
                    throws BusinessRuleBeansException,
                           java.rmi.RemoteException
Description copied from interface: IRuleFolder
Delete all rules contained in this folder. Subfolders will not be removed.
Specified by:
deleteAllRules in interface IRuleFolder

deleteAllSubFolders

public void deleteAllSubFolders()
                         throws BusinessRuleBeansException,
                                java.rmi.RemoteException
Description copied from interface: IRuleFolder
Delete all subfolders contained in this folder. Any rules contained within the subfolders are also deleted.
Specified by:
deleteAllSubFolders in interface IRuleFolder

findRuleByPrimaryKey

public IRule findRuleByPrimaryKey(java.lang.String arg0,
                                  boolean arg1,
                                  int arg2)
                           throws BusinessRuleBeansException,
                                  java.rmi.RemoteException
Description copied from interface: IRuleFolder
Find a rule in this folder with the given primary key. This method will search in this folder and, optionally, subfolders of this folder. It will not find rules in folders higher in the hierarchy. To find a rule anywhere in the rule namespace, call this method on the root folder (which can be obtained by calling method getRoot). Null is returned if the rule is not found.

Parameter includeSubFolders determines whether to search subfolders. Pass true to search subfolders.

This method can return either a reference to the rule (IRule.TYPE_REFERENCE) or a local copy of the rule (IRule.TYPE_COPY).

Specified by:
findRuleByPrimaryKey in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
primaryKey - the primaryKey of the rule
includeSubFolders - indicates whether to include subfolders as well
returnType - indicates whether to return a reference to the persistent rule or a local copy of the rule
Returns:
the rule with the given primary key, or null if not found

findRules

public java.util.Collection findRules(QueryNode arg0,
                                      boolean arg1,
                                      int arg2)
                               throws BusinessRuleBeansException,
                                      java.rmi.RemoteException
Description copied from interface: IRuleFolder
Look in this folder for rules that match the given query. This allows arbitrary queries to be specified. An empty collection is returned if no rules are found that match the specified query. Parameter includeSubFolders determines whether to search subfolders. Pass true to search subfolders.

This method can return references to the rules (IRule.TYPE_REFERENCE) or local copies of the rule (IRule.TYPE_COPY). Pass this value to parameter returnType

For example, find all rules named "isEligible".

   RuleNameNode nameNode = new RuleNameNode("isEligible", AbstractStringNode.EQUALS);
   Collection rules = root.findRules(nameNode, true, IRule.TYPE_REFERENCE);
 
The following finds rules named "isEligible" with a classification of "SeniorCitizen".
   RuleNameNode nameNode = new RuleNameNode("isEligible", AbstractStringNode.EQUALS);
   ClassificationNode cNode = new ClassificationNode("SeniorCitizen", 
                                                     AbstractStringNode.EQUALS);
   AndNode andNode = new AndNode(nameNode, cNode);
   Collection rules = root.findRules(andNode, true, IRule.TYPE_REFERENCE);
 
Specified by:
findRules in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
queryNode - represents the type of query to perform
includeSubFolders - indicates whether to include subfolders as well
returnType - indicates whether to return a reference to the persistent rule or a local copy of the rule
Returns:
a collection of the rules that match the given query

findRules

public java.util.Collection findRules(boolean arg0,
                                      int arg1)
                               throws BusinessRuleBeansException,
                                      java.rmi.RemoteException
Description copied from interface: IRuleFolder
Gets all rules contained within this folder. An empty collection is returned if there are no rules in this folder or subfolders. Parameter includeSubFolders determines whether to search subfolders. Pass true to search subfolders.

This method can return either references to the rules (IRule.TYPE_REFERENCE) or local copies of the rules (IRule.TYPE_COPY).

Specified by:
findRules in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
includeSubFolders - indicates whether to include subfolders as well
returnType - indicates whether to return references to the persistent rules or local copies of the rules
Returns:
a collection containing the rules in this folder

findRulesByName

public java.util.Collection findRulesByName(java.lang.String arg0,
                                            boolean arg1,
                                            int arg2)
                                     throws BusinessRuleBeansException,
                                            java.rmi.RemoteException
Description copied from interface: IRuleFolder
Look in this folder for a rule with the given name. This method returns a Collection because there could be multiple rules with this same name. An empty collection is returned if no rule is found with this name. The parameter ruleName can specify a relative path followed by the name of the rule or may simply specify a name of the rule. If a relative path is specified, then the includeSubFolders parameter must be false. This is because a particular subfolder is already being specified by the relative path. If parameter includeSubFolders is not false and a relative path is specified, then a BRBeansIllegalArgumentException is thrown.

This method can return references to the rules (IRule.TYPE_REFERENCE) or local copies of the rule (IRule.TYPE_COPY). Pass this value to parameter returnType

For example, the following will return the rule named "isEligibleForDiscount" in folder lifeFolder.

   IRuleFolder lifeFolder = root.getSubFolder("com/acme/lifeInsurance");
   Collection rules = lifeFolder.findRules("isEligibleForDiscount",
                                           IRule.TYPE_REFERENCE);
 
The following finds a rule specifying a fully qualified name:
   Collection rules = root.findRules("com/acme/lifeInsurance/isEligibleForDiscount",
                                     IRule.TYPE_REFERENCE);
 
Specified by:
findRulesByName in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
ruleName - the name of the rule for which to search
includeSubFolders - indicates whether to include subfolders as well. true cannot be specified if a relative path is specified for the ruleName parameter.
returnType - indicates whether to return a reference to the persistent rule or a local copy of the rule
Returns:
a collection of rules with the given name

getFullName

public java.lang.String getFullName()
                             throws BusinessRuleBeansException,
                                    java.rmi.RemoteException
Description copied from interface: IRuleFolder
Get the fully qualified name of this folder.
Specified by:
getFullName in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Returns:
the fully qualified name of the folder

getName

public java.lang.String getName()
                         throws BusinessRuleBeansException,
                                java.rmi.RemoteException
Description copied from interface: IRuleFolder
Returns the name of this folder. This name does not include parent folders. Use method getFullName to get a fully qualified name.
Specified by:
getName in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Returns:
the name of the folder

getParent

public IRuleFolder getParent()
                      throws BusinessRuleBeansException,
                             java.rmi.RemoteException
Description copied from interface: IRuleFolder
This method returns the parent folder for this folder.
Specified by:
getParent in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Returns:
the parent folder for this folder.

getRoot

public IRuleFolder getRoot()
                    throws BusinessRuleBeansException,
                           java.rmi.RemoteException
Description copied from interface: IRuleFolder
Returns the root IRuleFolder for this rule namespace.
Specified by:
getRoot in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Returns:
the root IRuleFolder

getSubFolder

public IRuleFolder getSubFolder(java.lang.String arg0)
                         throws BusinessRuleBeansException,
                                java.rmi.RemoteException
Description copied from interface: IRuleFolder
Gets the folder for the given relative path. Null is returned if the folder does not exist.
Specified by:
getSubFolder in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
path - the relative path of the folder to retrieve
Returns:
the folder for the given relative path or null if not found
Throws:
BRBeansIllegalArgumentException - if the path is invalid. A valid path name must not be null or the empty string and must not start with a '/' character.

getSubFolder

public IRuleFolder getSubFolder(java.lang.String arg0,
                                boolean arg1)
                         throws BusinessRuleBeansException,
                                java.rmi.RemoteException
Description copied from interface: IRuleFolder
Gets the folder for the given relative path. The boolean createFolder determines whether to create the folders if they do not exist. Passing true will cause the folders to be created. If false is passed and the folder does not exist, null is returned.
Specified by:
getSubFolder in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
path - the relative path of the folder to retrieve
createFolder - indicates whether to create the folder if it doesn't exist
Returns:
the folder for the given relative path
Throws:
BRBeansIllegalArgumentException - if the path is invalid. A valid path name must not be null or the empty string and must not start with a '/' character.

getSubFolders

public java.util.Collection getSubFolders()
                                   throws BusinessRuleBeansException,
                                          java.rmi.RemoteException
Description copied from interface: IRuleFolder
Gets all folders directly contained within this folder. An empty collection is returned if there are no subfolders.
Specified by:
getSubFolders in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Returns:
a collection containing the sub-folders

move

public void move(IRuleFolder arg0)
          throws BusinessRuleBeansException,
                 java.rmi.RemoteException
Description copied from interface: IRuleFolder
Move this folder into a new folder. Any rules contained in this folder or subfolder are moved as well.
Specified by:
move in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
toFolder - the folder into which to move this folder

rename

public void rename(java.lang.String arg0)
            throws BusinessRuleBeansException,
                   java.rmi.RemoteException
Description copied from interface: IRuleFolder
Renames this folder. All rules and subfolders of this folder will continue to be contained in the newly named folder.
Specified by:
rename in interface IRuleFolder
Following copied from interface: com.ibm.websphere.brb.mgmt.IRuleFolder
Parameters:
newName - the new name of this folder