IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

com.ibm.btt.base.types
Class DSEElementState

java.lang.Object
  extended by com.ibm.btt.base.types.DSEElementState
All Implemented Interfaces:
ElementState, java.io.Externalizable, java.io.Serializable

public class DSEElementState
extends java.lang.Object
implements ElementState, java.io.Externalizable

This class implements the ElementState interface as a 32 bits mask of state flags. This class only uses the first five bits as the flags named mandatory, hidden, readOnly, disabled, and omitted.

See Also:
Serialized Form

Field Summary
protected static int amended
           
protected static int disabled
           
protected static int hidden
           
protected static int mandatory
           
protected  int mask
           
protected static int omitted
           
protected static int ones
           
protected static int readOnly
           
 
Constructor Summary
DSEElementState()
          This constructor creates a DSEElementState object with all flags not activated.
DSEElementState(int aMask)
          This constructor creates a new DSEElementState with a given mask.
 
Method Summary
 java.lang.Object clone()
          Clones the DSEElementState.
 boolean get(java.lang.String flagName)
          Gets the flag state whose name is flagName.
 boolean isAmended()
          Returns true if the amended flag is activated.
 boolean isDisabled()
          Returns true if the disabled flag is activated.
 boolean isHidden()
          Returns true if the hidden flag is activated.
 boolean isMandatory()
          Returns true if the mandatory flag is activated.
 boolean isOmitted()
          Returns true if the omitted flag is activated.
 boolean isReadOnly()
          Returns true if the readOnly flag is activated.
 void readExternal(java.io.ObjectInput s)
          Invokes the object creation from an ObjectInput.
 void set(java.lang.String flagName, boolean aValue)
          Sets a flag state to aValue
 void setAmended(boolean aValue)
          Sets the amended flag to aValue.
 void setDisabled(boolean aValue)
          Sets the disabled flag to aValue.
 void setHidden(boolean aValue)
          Sets the hidden flag to aValue.
 void setMandatory(boolean aValue)
          Sets the mandatory flag to aValue.
 void setOmitted(boolean aValue)
          Sets the omitted flag to aValue.
 void setReadOnly(boolean aValue)
          Sets the readOnly flag to aValue.
 void writeExternal(java.io.ObjectOutput s)
          Provides concrete serialization handling for DSEElementState.
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

mask

protected int mask

mandatory

protected static int mandatory

hidden

protected static int hidden

readOnly

protected static int readOnly

disabled

protected static int disabled

omitted

protected static int omitted

amended

protected static int amended

ones

protected static int ones
Constructor Detail

DSEElementState

public DSEElementState()
This constructor creates a DSEElementState object with all flags not activated.


DSEElementState

public DSEElementState(int aMask)
This constructor creates a new DSEElementState with a given mask.

Parameters:
aMask - int
Method Detail

clone

public java.lang.Object clone()
Clones the DSEElementState.

Specified by:
clone in interface ElementState
Overrides:
clone in class java.lang.Object
Returns:
Object - The copy

get

public boolean get(java.lang.String flagName)
            throws DSEInvalidArgumentException
Gets the flag state whose name is flagName.

Specified by:
get in interface ElementState
Parameters:
flagName - java.lang.String - The name of the flag
Returns:
boolean - The value of the specified flag
Throws:
DSEInvalidArgumentException - flagName is invalid.

isAmended

public boolean isAmended()
Returns true if the amended flag is activated.

Specified by:
isAmended in interface ElementState
Returns:
boolean

isDisabled

public boolean isDisabled()
Returns true if the disabled flag is activated.

Specified by:
isDisabled in interface ElementState
Returns:
boolean

isHidden

public boolean isHidden()
Returns true if the hidden flag is activated.

Specified by:
isHidden in interface ElementState
Returns:
boolean

isMandatory

public boolean isMandatory()
Returns true if the mandatory flag is activated.

Specified by:
isMandatory in interface ElementState
Returns:
boolean

isOmitted

public boolean isOmitted()
Returns true if the omitted flag is activated.

Specified by:
isOmitted in interface ElementState
Returns:
boolean

isReadOnly

public boolean isReadOnly()
Returns true if the readOnly flag is activated.

Specified by:
isReadOnly in interface ElementState
Returns:
boolean

readExternal

public void readExternal(java.io.ObjectInput s)
                  throws java.io.IOException,
                         java.lang.ClassNotFoundException
Invokes the object creation from an ObjectInput.

Specified by:
readExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectInput
Throws:
java.io.IOException.
java.lang.ClassNotFoundException.
java.io.IOException
java.lang.ClassNotFoundException

set

public void set(java.lang.String flagName,
                boolean aValue)
         throws DSEInvalidArgumentException
Sets a flag state to aValue

Specified by:
set in interface ElementState
Parameters:
flagName - java.lang.String - The flag to set
aValue - boolean - The new value for the flag
Throws:
DSEInvalidArgumentException - - FlagName is invalid

setAmended

public void setAmended(boolean aValue)
Sets the amended flag to aValue.

Specified by:
setAmended in interface ElementState
Parameters:
aValue - boolean

setDisabled

public void setDisabled(boolean aValue)
Sets the disabled flag to aValue.

Specified by:
setDisabled in interface ElementState
Parameters:
aValue - boolean

setHidden

public void setHidden(boolean aValue)
Sets the hidden flag to aValue.

Specified by:
setHidden in interface ElementState
Parameters:
aValue - boolean

setMandatory

public void setMandatory(boolean aValue)
Sets the mandatory flag to aValue.

Specified by:
setMandatory in interface ElementState
Parameters:
aValue - boolean

setOmitted

public void setOmitted(boolean aValue)
Sets the omitted flag to aValue.

Specified by:
setOmitted in interface ElementState
Parameters:
aValue - boolean

setReadOnly

public void setReadOnly(boolean aValue)
Sets the readOnly flag to aValue.

Specified by:
setReadOnly in interface ElementState
Parameters:
aValue - boolean

writeExternal

public void writeExternal(java.io.ObjectOutput s)
                   throws java.io.IOException
Provides concrete serialization handling for DSEElementState.

Specified by:
writeExternal in interface java.io.Externalizable
Parameters:
s - java.io.ObjectOutput
Throws:
java.io.IOException.
java.io.IOException

IBM WebSphere Multichannel Bank Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2009