org.okiproject.serviceapi.rules
Interface Predicate

All Superinterfaces:
java.io.Serializable

public interface Predicate
extends java.io.Serializable

Copyright (c) 2001 Massachusetts Institute of Technology

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See Also:
Predicates, PredicateType,

$Source: /cvs/oki/org/okiproject/serviceapi/doc/rules/org/okiproject/serviceapi/rules/Predicate.html,v $


Method Summary
 void addLink(Predicate parent)
          Adds a parent-child relationship between two existing predicates in the Rules DB.
 void delete()
          Deletes an existing predicate in the Roles DB.
 void deleteLink()
          Deletes a parent-child relationship between two existing predicates in the Rules DB.
 java.lang.Boolean getHasChild()
          Method getHasChild
 java.lang.Object getId()
          Method getId
 PredicateType getPredicateType()
          Method getPredicateType
 java.util.Properties getProperties()
          Method getProperties
 java.lang.Boolean isFoundInRules()
          Determines if this Predicate has a matching Predicate in the Rules DB.
 void moveLink(Predicate oldParent, Predicate newParent)
          For an existing predicate, moves the parent link from one existing predicate to another.
 void refresh()
          Refreshes properties from a changing Rules DB.
 void setId(java.lang.Object id)
          Method setId
 void setPredicateType(PredicateType predicateType)
          Method setPredicateType
 void update(PredicateType newPredicateType)
          Updates one or more fields in an existing predicate in the Rules DB.
 

Method Detail

getId

public java.lang.Object getId()
Method getId
Returns:
 

getPredicateType

public PredicateType getPredicateType()
Method getPredicateType
Returns:
 

getHasChild

public java.lang.Boolean getHasChild()
Method getHasChild
Returns:
 

getProperties

public java.util.Properties getProperties()
Method getProperties
Returns:
 

setId

public void setId(java.lang.Object id)
Method setId
Parameters:
id -  

setPredicateType

public void setPredicateType(PredicateType predicateType)
Method setPredicateType
Parameters:
predicateType -  

delete

public void delete()
            throws java.lang.Exception
Deletes an existing predicate in the Roles DB.

isFoundInRules

public java.lang.Boolean isFoundInRules()
                                 throws java.lang.Exception
Determines if this Predicate has a matching Predicate in the Rules DB.
Returns:
true indicates Predicate is in the Rules DB as are its properties.

refresh

public void refresh()
             throws java.lang.Exception
Refreshes properties from a changing Rules DB.

update

public void update(PredicateType newPredicateType)
            throws java.lang.Exception
Updates one or more fields in an existing predicate in the Rules DB.

addLink

public void addLink(Predicate parent)
             throws java.lang.Exception
Adds a parent-child relationship between two existing predicates in the Rules DB.

deleteLink

public void deleteLink()
                throws java.lang.Exception
Deletes a parent-child relationship between two existing predicates in the Rules DB.

moveLink

public void moveLink(Predicate oldParent,
                     Predicate newParent)
              throws java.lang.Exception
For an existing predicate, moves the parent link from one existing predicate to another.