com.tivoli.twg.engine
Interface AddressEntryShadow

All Known Implementing Classes:
MSCSAddressEntryShadow, TWGNativeAddressEntryShadow, TWGSNMPAddressEntryShadow

public interface AddressEntryShadow

Interface for defining address entry shadows for various families of TWGManagedObject. Each address entry shadow implements a simple initialized method (which is given a record generated by the TWGManagedObject subclass which corresponds to this address shadow). Each subclass should also provide custom accessor functions for its specific attributes. Also, each subclass must implement a default constructor ( subclass() ).


Method Summary
 java.lang.String getAddressAttribute(java.lang.String symname)
          Get string representation of attribute with given symbolic name
 java.lang.String[] getAddressAttributeIDs()
          Get symbolic names for all attributes supported
 java.lang.String getAddressAttributeLabel(java.lang.String symname, java.util.Locale loc)
          Get label for attribute with given symbolic name
 void initAddressEntry(byte[] buf, int start, int len)
          Deliver address entry record to initialize AddressEntryShadow data content
 

Method Detail

initAddressEntry

public void initAddressEntry(byte[] buf,
                             int start,
                             int len)
                      throws AddressEntryFormatException
Deliver address entry record to initialize AddressEntryShadow data content

Parameters:
buf - - buffer containing address entry record
start - - offset of start of record in buffer
len - - length of record in buffer
Throws:
AddressEntryFormatException - if improper address record

getAddressAttributeIDs

public java.lang.String[] getAddressAttributeIDs()
Get symbolic names for all attributes supported

Returns:
string array of address attribute symbol names

getAddressAttribute

public java.lang.String getAddressAttribute(java.lang.String symname)
Get string representation of attribute with given symbolic name

Parameters:
symname - - symbolic name of attribute to request
Returns:
string value of attribute

getAddressAttributeLabel

public java.lang.String getAddressAttributeLabel(java.lang.String symname,
                                                 java.util.Locale loc)
Get label for attribute with given symbolic name

Parameters:
symname - - symbolic name of attribute to get label
loc - - locale to use for label information
Returns:
label string