|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.buildforge.services.common.dbo.DBObject
com.buildforge.services.common.dbo.FilterDBO
public class FilterDBO
Database information representing a filter set for processing step logs.
Field Summary | |
---|---|
static java.lang.String |
TYPE_KEY
|
Constructor Summary | |
---|---|
FilterDBO()
|
Method Summary | |
---|---|
void |
addPattern(FilterPatternDBO pattern)
Adds a pattern to this filter set at the end of the pattern list. |
void |
addPattern(FilterPatternDBO pattern,
int index)
Adds a pattern to this filter set at the specified index. |
FilterDBO |
clone()
|
FilterPatternDBO |
copyPattern(int index)
Returns a copy of the specified FilterPattern. |
void |
copyPattern(int fromIndex,
int toIndex)
Copies the specified filter pattern and inserts it at another position in the entry list. |
FilterDBO |
fromArray(java.lang.Object[] data)
Deserialize the database object's settings from a request array. |
int |
getFilterId()
|
int |
getLevel()
|
java.lang.String |
getName()
|
FilterPatternDBO |
getPattern(int index)
|
java.util.List<FilterPatternDBO> |
getPatterns()
|
java.lang.String |
getTypeKey()
Retrieve the key that should be used to look up the display name for a data type. |
boolean |
isLive()
Checks whether or not the object is live. |
void |
movePattern(int fromIndex,
int toIndex)
Moves a pattern from one 0-based index to another. |
FilterPatternDBO |
removePattern(int index)
Removes the pattern at the specified index from this filter set. |
void |
setFilterId(int newFilterId)
|
void |
setLevel(int newLevel)
|
void |
setName(java.lang.String name)
|
void |
setPatterns(java.util.List<FilterPatternDBO> newPatternList)
|
java.lang.Object[] |
toArray()
Serializes this database object as an array of objects. |
java.lang.String |
toString()
|
Methods inherited from class com.buildforge.services.common.dbo.DBObject |
---|
badId, badName, checkDead, checkLive, collision, collision |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String TYPE_KEY
Constructor Detail |
---|
public FilterDBO()
Method Detail |
---|
public java.lang.String getTypeKey()
DBObject
getTypeKey
in class DBObject
public boolean isLive()
DBObject
isLive
in class DBObject
public int getFilterId()
public int getLevel()
public java.lang.String getName()
public java.util.List<FilterPatternDBO> getPatterns()
public FilterPatternDBO getPattern(int index) throws APIException
APIException
public void setFilterId(int newFilterId)
public void setLevel(int newLevel)
public void setName(java.lang.String name)
public void setPatterns(java.util.List<FilterPatternDBO> newPatternList)
public void addPattern(FilterPatternDBO pattern)
pattern
- the filter pattern to add to this filter setpublic void addPattern(FilterPatternDBO pattern, int index)
pattern
- the filter pattern to add to this filter setindex
- the 0-based index at which to add the new
pattern to this filter set. If the value would place the
pattern past the end of the list, then the value is placed
at the end of the list.public void movePattern(int fromIndex, int toIndex) throws APIException
fromIndex
- toIndex
-
APIException
public FilterPatternDBO copyPattern(int index) throws APIException
index
- the 0-based index of the pattern to copy
APIException
public void copyPattern(int fromIndex, int toIndex) throws APIException
fromIndex
- the 0-based index of the pattern to copytoIndex
- the 0-base index of the position at which
the copy is to be inserted into the list. If this value would
place the copy beyond the end of the list, then the copy is
placed at the end of the list.
APIException
public FilterPatternDBO removePattern(int index) throws APIException
index
- the 0-based index of the pattern to remove
APIException
public java.lang.String toString()
toString
in class java.lang.Object
public FilterDBO fromArray(java.lang.Object[] data) throws APIException
DBObject
DBObject.toArray()
.
fromArray
in class DBObject
data
- the object list that renders this object
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.public java.lang.Object[] toArray()
DBObject
Protocol
, all supported
protocols transfer database objects in this form.
toArray
in class DBObject
public FilterDBO clone()
clone
in class java.lang.Object
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |