com.tivoli.twg.engine
Class TWGFilterParms

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGFilterParms
All Implemented Interfaces:
java.io.Serializable

public class TWGFilterParms
extends java.lang.Object
implements java.io.Serializable

The TWGFilterParms class contains the parameters to create a dynamic database group (filter), static filters, and task filters.

See Also:
TWGFilter, Serialized Form

Field 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

REPLACE_IDS

public static final int REPLACE_IDS
See Also:
Constant Field Values

ADD_IDS

public static final int ADD_IDS
See Also:
Constant Field Values
Constructor Detail

TWGFilterParms

public TWGFilterParms()
Default constructor


TWGFilterParms

public TWGFilterParms(java.lang.String filterName)
               throws TWGFilterException
TWGFilterParms constructor for a dynamic functional database filter

Parameters:
filterName - - the displayable name for the filter, or the bundle key to use to search the resource bundle for to find the name
Throws:
TWGFilterException - for parameter errors

TWGFilterParms

public TWGFilterParms(java.lang.String filterName,
                      TWGFilterConstraints con)
               throws TWGFilterException
TWGFilterParms constructor for a dynamic functional database filter that has a predefined set of constraints.

Parameters:
filterName - - the displayable name for the filter, or the bundle key to use to search the resource bundle for to find the name
Throws:
TWGFilterException - for parameter errors
See Also:
TWGFilterConstraints

TWGFilterParms

public TWGFilterParms(java.lang.String filterName,
                      IntValueSet object_ids)
               throws TWGFilterException
TWGFilterParms constructor for a static filter. The set of managed object ids will replace the existing set if the filter is already defined.

Parameters:
filterName - - the displayable name for the filter, or the bundle key to use to search the resource bundle for to find the name
object_ids - - an IntValueSet of managed object ids
Throws:
TWGFilterException - for parameter errors

TWGFilterParms

public TWGFilterParms(java.lang.String filterName,
                      IntValueSet object_ids,
                      int object_ids_disp)
               throws TWGFilterException
TWGFilterParms constructor for a static filter

Parameters:
filterName - - the displayable name for the filter, or the bundle key to use to search the resource bundle for to find the name
object_ids - - an IntValueSet of managed object ids
object_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.
Throws:
TWGFilterException - for parameter errors

TWGFilterParms

public TWGFilterParms(java.lang.String filterName,
                      StringValueSet taskIDs,
                      int combo_code)
               throws TWGFilterException
TWGFilterParms constructor for a task filter. The set of task ids will replace the existing set if the filter is already defined.

Parameters:
filterName - - the displayable name for the filter, or the bundle key to use to search the resource bundle for to find the name
taskIDs - - a StringValueSet of task ids
combo_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)
Throws:
TWGFilterException - for parameter errors
Method Detail

isStatic

public boolean isStatic()
Are these parameters for a static filter?

Returns:
- true if parameters are for a static filter

isTaskFilter

public boolean isTaskFilter()
Are these parameters for a task filter?

Returns:
- true if parameters are for a task filter

isFunctional

public boolean isFunctional()
Are these parameters for a functional filter?

Returns:
- true if parameters are for a functional filter

setBundleName

public void setBundleName(java.lang.String bundle)
Set the resource bundle name for the filter

Parameters:
bundle - - the bundle name in which to search for the filter name

setIDString

public void setIDString(java.lang.String id)
Set id string for the filter. This is used to uniquely identify the filter


setReadOnly

public void setReadOnly(boolean read)
Set the read-only flag


setConsoleDeletable

public void setConsoleDeletable(boolean deletable)
Set the console deletable flag

Parameters:
deletable - - true if the filter can be deleted from the console, otherwise false

setConsoleHidden

public void setConsoleHidden(boolean hidden)
Set the console hidden

Parameters:
hidden - - true if the filter is hidden from the console, otherwise false

getConstraints

public TWGFilterConstraints getConstraints()
Get the filter constraints

Returns:
- the constraints

getName

public java.lang.String getName()
Get the displayable name for the filter

Returns:
- the displayable name or the key for searching the resource bundle

getBundleName

public java.lang.String getBundleName()
Get the name of the resource bundle for the filter

Returns:
- the resource bundle name

getIDString

public java.lang.String getIDString()
Get the id string for the filter

Returns:
- the id string

isReadOnly

public boolean isReadOnly()
Is the filter read only

Returns:
- true if read only, otherwise false

isConsoleDeletable

public boolean isConsoleDeletable()
Is the filter deletable from the console

Returns:
- true if deletable from the console, otherwise false

isConsoleHidden

public boolean isConsoleHidden()
Is the filter hidden from the console

Returns:
- true if hidden from the console, otherwise false

getTaskIDs

public StringValueSet getTaskIDs()
Get the task ids for the task filter

Returns:
- an StringValueSet of task ids, or null if these parameter are not for a task filter.

getManagedObjectIds

public IntValueSet getManagedObjectIds()
Get the managed object ids for the static filter

Returns:
- an IntValueSet of managed object ids, or null if these parameter are not for a static filter.

getManagedObjectIdsDisp

public int getManagedObjectIdsDisp()
Get the managed object ids disposition

Returns:
- the managed object ids disposition

getTaskComboCode

public int getTaskComboCode()
Get the combination code for task filters

Returns:
- the combination code (TASK_FILTER_MUST_HAVE_ALL, TASK_FILTER_CAN_HAVE_ANY)

setTaskComboCode

public void setTaskComboCode(int cc)
Set the combination code for task filters

Parameters:
cc - - the combination code (TASK_FILTER_MUST_HAVE_ALL, TASK_FILTER_CAN_HAVE_ANY)

addConstraint

public void addConstraint(TWGFilterConstraint con)
                   throws TWGFilterException
Add a constraint for the filter.

Parameters:
con - - a TWGFilterConstraint object
Throws:
TWGFilterException

toString

public java.lang.String toString()
Convert object to String for debug

Returns:
String with a textual description of this object