com.ibm.gre.IRMFields Class
The IRMFields class encapsulates a Fields element from a Records manager Complex Fields Collection returned by one of the TemplateControllerEJB methods. This class can be used to help get and set values for Adding, Editing and Displaying Records Manager Components.

Access: Public
Base Classes: Object
  Members Description  
    IRMFields Constructor

 
    FlPlnCmpntDefID The ID of the Component Definition type that the Fields class reprepresents.

 
    FieldsCount The number of Field objects that the class contains.

 
    DisplayCount The number of Field objects that have been specified to be displayed.

 
    getField Get the IRMField object for the specified index.

 
    getFieldByFlPlnCmpntAttrDefColNm Gets the IRMField object for the specified FlPlnCmpntAttrDefColNm.

 
    setFieldByFlPlnCmpntAttrDefColNm Set the value of the underlying Field Element for the Component Attribute specified by the FlPlnCmpntAttrDefColNm.

 
    setVisabilityByFlPlnCmpntAttrDefColNm Set the visability of a specified Field.

 
    hideSecurityFields This is a convenience method for setting the visability attribute to Security Fields, indicating they should not be displayed. Host applications that do not use Security Fields can use this method.

 
    setActiveStateByFlPlnCmpntAttrDefColNm Sets a flag indicating whether a specified field should be include in values for Add or update.

 
    inactivateSecurityFields A convenience method for in-activating security fields. Host applications that do not use security can use this method.

 
    getXMLForAdd This method returns a properly formatted XML string that can be used as input to calls to the Records Manager TemplateControllerEJB methods addNewFilePlanComponent or addNewSystemComponent. Can also be used as input to the Records Manager Component Update methods.

 
    MaxCaption This method returns the number of characters contained in the longest Caption in the Fields Collection.

 
    m_root    
    m_fields    
    m_nMaxCaptionLength    
    m_nMaxCaptionIndex    
    m_nFlPlnCmpntDefID    
    m_Profile_Options    
    m_Default_Options    
Remarks:
See the documentation for the TemplateControllerEJB interface contained in the com.ibm.gre.engine.ejb.facade package in the IBM DB2 Records Manager API Reference for examples and explanations of methods that will return or accept Complex Fields Collection XML values.