|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.tivoli.twg.engine.TWGFilterParms
The TWGFilterParms class contains the parameters to create a dynamic database group (filter), static filters, and task filters.
TWGFilter
,
Serialized FormField Summary | |
---|---|
static int |
ADD_IDS
|
static int |
REPLACE_IDS
|
Constructor Summary | |
---|---|
TWGFilterParms()
Default constructor |
|
TWGFilterParms(java.lang.String filterName)
TWGFilterParms constructor for a dynamic functional database filter |
|
TWGFilterParms(java.lang.String filterName,
IntValueSet object_ids)
TWGFilterParms constructor for a static filter. |
|
TWGFilterParms(java.lang.String filterName,
IntValueSet object_ids,
int object_ids_disp)
TWGFilterParms constructor for a static filter |
|
TWGFilterParms(java.lang.String filterName,
StringValueSet taskIDs,
int combo_code)
TWGFilterParms constructor for a task filter. |
|
TWGFilterParms(java.lang.String filterName,
TWGFilterConstraints con)
TWGFilterParms constructor for a dynamic functional database filter that has a predefined set of constraints. |
Method Summary | |
---|---|
void |
addConstraint(TWGFilterConstraint con)
Add a constraint for the filter. |
java.lang.String |
getBundleName()
Get the name of the resource bundle for the filter |
TWGFilterConstraints |
getConstraints()
Get the filter constraints |
java.lang.String |
getIDString()
Get the id string for the filter |
IntValueSet |
getManagedObjectIds()
Get the managed object ids for the static filter |
int |
getManagedObjectIdsDisp()
Get the managed object ids disposition |
java.lang.String |
getName()
Get the displayable name for the filter |
int |
getTaskComboCode()
Get the combination code for task filters |
StringValueSet |
getTaskIDs()
Get the task ids for the task filter |
boolean |
isConsoleDeletable()
Is the filter deletable from the console |
boolean |
isConsoleHidden()
Is the filter hidden from the console |
boolean |
isFunctional()
Are these parameters for a functional filter? |
boolean |
isReadOnly()
Is the filter read only |
boolean |
isStatic()
Are these parameters for a static filter? |
boolean |
isTaskFilter()
Are these parameters for a task filter? |
void |
setBundleName(java.lang.String bundle)
Set the resource bundle name for the filter |
void |
setConsoleDeletable(boolean deletable)
Set the console deletable flag |
void |
setConsoleHidden(boolean hidden)
Set the console hidden |
void |
setIDString(java.lang.String id)
Set id string for the filter. |
void |
setReadOnly(boolean read)
Set the read-only flag |
void |
setTaskComboCode(int cc)
Set the combination code for task filters |
java.lang.String |
toString()
Convert object to String for debug |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
public static final int REPLACE_IDS
public static final int ADD_IDS
Constructor Detail |
public TWGFilterParms()
public TWGFilterParms(java.lang.String filterName) throws TWGFilterException
filterName
- - the displayable name for the filter, or the bundle key
to use to search the resource bundle for to find the name
TWGFilterException
- for parameter errorspublic TWGFilterParms(java.lang.String filterName, TWGFilterConstraints con) throws TWGFilterException
filterName
- - the displayable name for the filter, or the bundle key
to use to search the resource bundle for to find the name
TWGFilterException
- for parameter errorsTWGFilterConstraints
public TWGFilterParms(java.lang.String filterName, IntValueSet object_ids) throws TWGFilterException
filterName
- - the displayable name for the filter, or the bundle key
to use to search the resource bundle for to find the nameobject_ids
- - an IntValueSet of managed object ids
TWGFilterException
- for parameter errorspublic TWGFilterParms(java.lang.String filterName, IntValueSet object_ids, int object_ids_disp) throws TWGFilterException
filterName
- - the displayable name for the filter, or the bundle key
to use to search the resource bundle for to find the nameobject_ids
- - an IntValueSet of managed object idsobject_ids_disp
- - the disposition of the managed object ids. This
parameter is use for changing existing static filters.
It specifies whether the objects ids specified in this
object are to replace the existing list in the filter
or whether they are to be added to it.
TWGFilterException
- for parameter errorspublic TWGFilterParms(java.lang.String filterName, StringValueSet taskIDs, int combo_code) throws TWGFilterException
filterName
- - the displayable name for the filter, or the bundle key
to use to search the resource bundle for to find the nametaskIDs
- - a StringValueSet of task idscombo_code
- - indicates whether filter should match on objects supporting
ALL of the given tasks (TASK_FILTER_MUST_HAVE_ALL) or ANY of the given
tasks (TASK_FILTER_CAN_HAVE_ANY)
TWGFilterException
- for parameter errorsMethod Detail |
public boolean isStatic()
public boolean isTaskFilter()
public boolean isFunctional()
public void setBundleName(java.lang.String bundle)
bundle
- - the bundle name in which to search for the filter namepublic void setIDString(java.lang.String id)
public void setReadOnly(boolean read)
public void setConsoleDeletable(boolean deletable)
deletable
- - true if the filter can be deleted from the console,
otherwise falsepublic void setConsoleHidden(boolean hidden)
hidden
- - true if the filter is hidden from the console,
otherwise falsepublic TWGFilterConstraints getConstraints()
public java.lang.String getName()
public java.lang.String getBundleName()
public java.lang.String getIDString()
public boolean isReadOnly()
public boolean isConsoleDeletable()
public boolean isConsoleHidden()
public StringValueSet getTaskIDs()
public IntValueSet getManagedObjectIds()
public int getManagedObjectIdsDisp()
public int getTaskComboCode()
public void setTaskComboCode(int cc)
cc
- - the combination code (TASK_FILTER_MUST_HAVE_ALL, TASK_FILTER_CAN_HAVE_ANY)public void addConstraint(TWGFilterConstraint con) throws TWGFilterException
con
- - a TWGFilterConstraint object
TWGFilterException
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |