com.buildforge.services.common.dbo
Class FilterPatternDBO
java.lang.Object
com.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.FilterPatternDBO
public class FilterPatternDBO
- extends DBObject
Database information representing a single filter pattern entry
within a filter set.
Nested Class Summary |
static class |
FilterPatternDBO.Action
Identifies what action should be taken when a filter pattern matches. |
Field Summary |
static java.lang.String |
TYPE_KEY
|
Methods inherited from class java.lang.Object |
getClass, notify, notifyAll, wait, wait, wait |
TYPE_KEY
public static final java.lang.String TYPE_KEY
- See Also:
- Constant Field Values
FilterPatternDBO
public FilterPatternDBO()
FilterPatternDBO
public FilterPatternDBO(int newFilterId,
int newFilterOrdinal,
java.lang.String newPattern,
FilterPatternDBO.Action newAction,
int newNotificationLevel)
getTypeKey
public java.lang.String getTypeKey()
- Description copied from class:
DBObject
- Retrieve the key that should be used to look up the display name
for a data type.
- Specified by:
getTypeKey
in class DBObject
- Returns:
- the type key for this object's class
isLive
public boolean isLive()
- Description copied from class:
DBObject
- Checks whether or not the object is live. Note that this is not
valid for object types that do not have a unique identifier. Those
for which no reasonable implementation exists should always return
false.
- Specified by:
isLive
in class DBObject
- Returns:
- true iff liveness is a valid concept for this object,
and the object is live; otherwise, false is returned.
getAction
public FilterPatternDBO.Action getAction()
getFilterId
public int getFilterId()
getFilterOrdinal
public int getFilterOrdinal()
getPattern
public java.lang.String getPattern()
getNotificationLevel
public int getNotificationLevel()
setAction
public void setAction(FilterPatternDBO.Action action)
setFilterId
public void setFilterId(int filterId)
setFilterOrdinal
public void setFilterOrdinal(int newOrdinal)
setPattern
public void setPattern(java.lang.String parameterName)
setNotificationLevel
public void setNotificationLevel(int notificationLevel)
equals
public boolean equals(java.lang.Object o)
- Overrides:
equals
in class java.lang.Object
hashCode
public int hashCode()
- Overrides:
hashCode
in class java.lang.Object
fromArray
public FilterPatternDBO fromArray(java.lang.Object[] data)
throws APIException
- Description copied from class:
DBObject
- Deserialize the database object's settings from a request array.
This method is used to reconstruct a database object from the
array that was created by
DBObject.toArray()
.
- Specified by:
fromArray
in class DBObject
- Parameters:
data
- the object list that renders this object
- Returns:
- this object, for convenience
- Throws:
APIException
- if there is something wrong with the
serialized data that interferes with the reconstruction of
the object. The most obvious reason for this would be if
the serialized array contains the wrong number of fields
or otherwise does not match the serialized form for this
type of database object.
toArray
public java.lang.Object[] toArray()
- Description copied from class:
DBObject
- Serializes this database object as an array of objects. As
specified in the description for
Protocol
, all supported
protocols transfer database objects in this form.
- Specified by:
toArray
in class DBObject
sanityCheckFilterId
public static void sanityCheckFilterId(int filterId)
throws APIException
- Throws:
APIException
sanityCheckOrdinal
public static void sanityCheckOrdinal(int ordinal)
throws APIException
- Throws:
APIException
toString
public java.lang.String toString()
- Overrides:
toString
in class java.lang.Object
clone
public FilterPatternDBO clone()
- Overrides:
clone
in class java.lang.Object