IBM Branch Transformation Toolkit Javadoc

com.ibm.btt.base.types
Interface ElementState

All Known Implementing Classes:
DSEElementState

public interface ElementState

This interface is implemented by the DSEElementState class to provide an implementation for the state property of the DataElement class and the intialState of the AbstractPropertyDescriptor.


Method Summary
 java.lang.Object clone()
          Clones the ElementState.
 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 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.
 

Method Detail

clone

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

Returns:
java.lang.Object

get

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

Parameters:
flagName - java.lang.String
Returns:
boolean
Throws:
DSEInvalidArgumentException - - FlagName is invalid

isAmended

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

Returns:
boolean

isDisabled

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

Returns:
boolean

isHidden

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

Returns:
boolean

isMandatory

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

Returns:
boolean

isOmitted

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

Returns:
boolean

isReadOnly

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

Returns:
boolean

set

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

Parameters:
flagName - java.lang.String
aValue - boolean
Throws:
DSEInvalidArgumentException - - FlagName is invalid

setAmended

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

Parameters:
aValue - boolean

setDisabled

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

Parameters:
aValue - boolean

setHidden

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

Parameters:
aValue - boolean

setMandatory

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

Parameters:
aValue - boolean

setOmitted

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

Parameters:
aValue - boolean

setReadOnly

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

Parameters:
aValue - boolean

IBM Branch Transformation Toolkit Javadoc

(c) Copyright IBM Corporation 1998, 2005