com.sap.netweaver.bc.rf.common.property

Class PropertyFlags

java.lang.Object
  extended by com.sap.netweaver.bc.rf.common.property.PropertyFlags

public final class PropertyFlags
extends Object

Class implementing the internal system attributes of a property. They are mapped into a bit array hold by the flags field in the property class for greater performance and less memory consumption.


Field Summary
static int HIDDEN_BIT_MASK
          Bit mask for the internal system attribute named "hidden".
static int LIVE_BIT_MASK
          Bit mask for the internal system attribute named "live".
static int READONLY_BIT_MASK
          Bit mask for the internal system attribute named "read only".
static int REQUIRED_BIT_MASK
          Bit mask for the internal system attribute named "required".
 
Constructor Summary
PropertyFlags()
           
 
Method Summary
static int constructFlags(boolean required, boolean live, boolean readOnly, boolean hidden)
          Construct property flags based on given explicit internal system attributes.
static boolean isHidden(int flags)
          Returns true if these property flags indicate that its holding property has the internal system attribute "hidden".
static boolean isLive(int flags)
          Returns true if these property flags indicate that its holding property has the internal system attribute "live".
static boolean isReadOnly(int flags)
          Returns true if these property flags indicate that its holding property has the internal system attribute "read only".
static boolean isRequired(int flags)
          Returns true if these property flags indicate that its holding property has the internal system attribute "required".
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

REQUIRED_BIT_MASK

public static final int REQUIRED_BIT_MASK
Bit mask for the internal system attribute named "required".

See Also:
Constant Field Values

LIVE_BIT_MASK

public static final int LIVE_BIT_MASK
Bit mask for the internal system attribute named "live".

See Also:
Constant Field Values

READONLY_BIT_MASK

public static final int READONLY_BIT_MASK
Bit mask for the internal system attribute named "read only".

See Also:
Constant Field Values

HIDDEN_BIT_MASK

public static final int HIDDEN_BIT_MASK
Bit mask for the internal system attribute named "hidden".

See Also:
Constant Field Values
Constructor Detail

PropertyFlags

public PropertyFlags()
Method Detail

constructFlags

public static final int constructFlags(boolean required,
                                       boolean live,
                                       boolean readOnly,
                                       boolean hidden)
Construct property flags based on given explicit internal system attributes.

Parameters:
required - true if this property should be required
live - true if this property should be live
readOnly - true if this property should be read only
hidden - true if this property should be hidden
Returns:
property flags

isRequired

public static final boolean isRequired(int flags)
Returns true if these property flags indicate that its holding property has the internal system attribute "required".

Parameters:
flags - bit array holding internal system attributes according to PropertyFlags bit mask fields
Returns:
true if this property is required

isLive

public static final boolean isLive(int flags)
Returns true if these property flags indicate that its holding property has the internal system attribute "live".

Parameters:
flags - bit array holding internal system attributes according to PropertyFlags bit mask fields
Returns:
true if this property is live

isReadOnly

public static final boolean isReadOnly(int flags)
Returns true if these property flags indicate that its holding property has the internal system attribute "read only".

Parameters:
flags - bit array holding internal system attributes according to PropertyFlags bit mask fields
Returns:
true if this property is read only

isHidden

public static final boolean isHidden(int flags)
Returns true if these property flags indicate that its holding property has the internal system attribute "hidden".

Parameters:
flags - bit array holding internal system attributes according to PropertyFlags bit mask fields
Returns:
true if this property is hidden
Access Rights

This class can be accessed from:


SC DC Public Part ACH
[sap.com] KMC-WPC [sap.com] tc/kmc/wpc/wpcfacade api EP-PIN-WPC-WCM
[sap.com] KMC-CM [sap.com] tc/km/frwk api EP-KM-CM


Copyright 2012 SAP AG Complete Copyright Notice