com.tivoli.twg.engine
Class TWGConFilter

java.lang.Object
  extended bycom.tivoli.twg.engine.TWGConObject
      extended bycom.tivoli.twg.engine.TWGConFilter

public class TWGConFilter
extends TWGConObject

Console object used to shadow the state of a TWGFilter object in the Director Server.


Field Summary
static int FILTER_TYPE_FUNCTIONAL
          Filter type = functional
static int FILTER_TYPE_STATIC
          Filter type = static
static int FILTER_TYPE_TASK
          Filter type = task-based
static int FLT_IMAGE_DETAILVIEW
          Image flags for filter : detail view icon requested
static int FLT_IMAGE_ICONVIEW
          Image flags for filter : icon view icon requested
 
Fields inherited from class com.tivoli.twg.engine.TWGConObject
INVALID_OBJECT_ID
 
Constructor Summary
TWGConFilter(long obj_id)
          Constructor for TWGConFilter with given object ID
 
Method Summary
 javax.swing.ImageIcon getCurrentImage(int flags)
          Get current image for object, for given mode.
 java.lang.String getIDString()
          Get ID string
 java.lang.String getName()
          Get name of filter
 int getType()
          Get type of filter
 boolean isConsoleDeletable()
          Test if object is console deletable
 boolean isConsoleHidden()
          Test if object is console hidden
 boolean isDefault()
          Test if filter is global default ('all') filter
 boolean isFunctional()
          Test if object is a functional filter
 boolean isMOClass()
          Test if object is a Managed Object class based filter
 boolean isReadOnly()
          Test if filter is read-only
 boolean isStatic()
          Test if object is a static filter
 boolean isTask()
          Test if object is a task filter
 java.lang.String toString()
          Generate string representation of object
 void UpdateUsingShadowRecord(byte[] rec, int rec_off, int rec_len)
          Update object using shadow record created by the the engine object which is matched with this class.
 
Methods inherited from class com.tivoli.twg.engine.TWGConObject
AllObjects, AllObjects, Delete, DeleteObjects, DeregisterListener, FindObject, getBaseClassName, LookUpShadowClass, ObjectID, ProcessUpdateRequest, RegisterListener, SetObjectID
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FILTER_TYPE_FUNCTIONAL

public static final int FILTER_TYPE_FUNCTIONAL
Filter type = functional

See Also:
Constant Field Values

FILTER_TYPE_STATIC

public static final int FILTER_TYPE_STATIC
Filter type = static

See Also:
Constant Field Values

FILTER_TYPE_TASK

public static final int FILTER_TYPE_TASK
Filter type = task-based

See Also:
Constant Field Values

FLT_IMAGE_DETAILVIEW

public static final int FLT_IMAGE_DETAILVIEW
Image flags for filter : detail view icon requested

See Also:
Constant Field Values

FLT_IMAGE_ICONVIEW

public static final int FLT_IMAGE_ICONVIEW
Image flags for filter : icon view icon requested

See Also:
Constant Field Values
Constructor Detail

TWGConFilter

public TWGConFilter(long obj_id)
             throws DuplicateObjectIDException
Constructor for TWGConFilter with given object ID

Parameters:
obj_id - - object ID of console object
Throws:
DuplicateObjectIDException - if ID is duplicate of existing object ID
Method Detail

UpdateUsingShadowRecord

public void UpdateUsingShadowRecord(byte[] rec,
                                    int rec_off,
                                    int rec_len)
Update object using shadow record created by the the engine object which is matched with this class.

Specified by:
UpdateUsingShadowRecord in class TWGConObject
Parameters:
rec - - byte array containing opaque representation of shadowed attributes
rec_off - - offset of shadow record in byte array
rec_len - - length of shadow record in byte array

toString

public java.lang.String toString()
Generate string representation of object

Overrides:
toString in class TWGConObject
Returns:
string representation

getName

public java.lang.String getName()
Get name of filter

Returns:
filter name

getType

public int getType()
Get type of filter

Returns:
filter type

isReadOnly

public boolean isReadOnly()
Test if filter is read-only

Returns:
true if read-only, false if read-write

isDefault

public boolean isDefault()
Test if filter is global default ('all') filter

Returns:
true if is default, false if not

isConsoleDeletable

public boolean isConsoleDeletable()
Test if object is console deletable

Returns:
true if object is console deletable

isStatic

public boolean isStatic()
Test if object is a static filter

Returns:
true if object is a static filter, false if not

isFunctional

public boolean isFunctional()
Test if object is a functional filter

Returns:
true if object is a functional filter, false if not

isMOClass

public boolean isMOClass()
Test if object is a Managed Object class based filter

Returns:
true if object is a Managed Object class based filter, false if not

isTask

public boolean isTask()
Test if object is a task filter

Returns:
true if object is a task filter, false if not

isConsoleHidden

public boolean isConsoleHidden()
Test if object is console hidden

Returns:
true if object is console hidden

getCurrentImage

public javax.swing.ImageIcon getCurrentImage(int flags)
Get current image for object, for given mode.

Parameters:
flags - - image selection flags
Returns:
image icon

getIDString

public java.lang.String getIDString()
Get ID string

Returns:
ID string, null if not set