com.ibm.soa.common.mbean
Interface GeneralProperties

All Superinterfaces:
com.ibm.soa.common.mbean.SettingsHelperIF
All Known Subinterfaces:
ComponentProperties, CustomProperties, Settings

public interface GeneralProperties
extends com.ibm.soa.common.mbean.SettingsHelperIF

The GeneralProperties interface defines the interface to an properties MBean. This interface currently supports choices, strings and readonly strings as the values of configured properties. This generalized interface will allow for integration into the Administration Console.

Version:
1.2.1.1

Method Summary
 java.lang.String getAttributeContext(java.lang.String name)
          Get the current attribute context string for the specified attribute.
 java.lang.String[] getAttributePossibleValues(java.lang.String name)
          Get the list of possible values for the attribute that is of type "CHOICE" or "AUTOCHOICE" or "TRANSCHOICE"
 java.lang.String getAttributeProperties(java.lang.String name)
          Get the ObjectName String for the named attribute's link.
 java.lang.String getAttributeType(java.lang.String name)
          Get the type of named attribute
 java.lang.String getContext()
          Gets the navigation context for an MBean.
 java.lang.String getDisplayName()
          If the Title or Breadcrumb for an MBean (defined in the resource bundle) contains the placeholder string ${name} then the JSP will call this method on the MBean for the display name to substitute for the placeholder.
 java.lang.String getDisplayName(java.util.Locale locale)
          If the Title or Breadcrumb for an MBean (defined in the resource bundle) contains the placeholder string ${name} then the JSP will call this method on the MBean for the display name to substitute for the placeholder.
 void setContext(java.lang.String context)
          Sets the navigation context for an MBean.
 void setDisplayName(java.lang.String name)
          Set the display Name.
 

Method Detail

getAttributeType

java.lang.String getAttributeType(java.lang.String name)
Get the type of named attribute

Parameters:
name - the name of the attribute
Returns:
"CHOICE","STRING", "READONLY", "AUTOCHOICE", "PASSWORD", "TRANSCHOICE"

getAttributePossibleValues

java.lang.String[] getAttributePossibleValues(java.lang.String name)
Get the list of possible values for the attribute that is of type "CHOICE" or "AUTOCHOICE" or "TRANSCHOICE"

Parameters:
name - the name of the attribute
Returns:
the array of possible values, return null if the name if a text field item

getAttributeProperties

java.lang.String getAttributeProperties(java.lang.String name)
Get the ObjectName String for the named attribute's link.

Parameters:
name - the name of an attribute
Returns:
the ObjectName string that links to another MBean

getAttributeContext

java.lang.String getAttributeContext(java.lang.String name)
Get the current attribute context string for the specified attribute. For example, if an AUTOCHOICE is utilized to set the key(s) or context for subsequent method access to this MBean, the getAttributeContext() method will return the currently set context that is used to uniquely identify the data accessed by getAttribute() or setAttribute(). If no AUTOCHOICE is significant, an empty string is returned.

Parameters:
name - the attribute name
Returns:
"", or current AUTOCHOICE values that define the current context of this MBean. Multiple values are generally separated with a semi-colon.

getDisplayName

java.lang.String getDisplayName()
If the Title or Breadcrumb for an MBean (defined in the resource bundle) contains the placeholder string ${name} then the JSP will call this method on the MBean for the display name to substitute for the placeholder.

Returns:
"", or the string to substitue for the placeholder.

getDisplayName

java.lang.String getDisplayName(java.util.Locale locale)
If the Title or Breadcrumb for an MBean (defined in the resource bundle) contains the placeholder string ${name} then the JSP will call this method on the MBean for the display name to substitute for the placeholder.

Parameters:
locale - the locale
Returns:
"", or the string to substitue for the placeholder.

setDisplayName

void setDisplayName(java.lang.String name)
Set the display Name.

Parameters:
name - the name

setContext

void setContext(java.lang.String context)
Sets the navigation context for an MBean. The navigation context is a name qualified with dots (i.e., 'attrib1.attrib2') that references the linking context between bean objects. This method is called by the JSP as it propagates the context during navigation.

Parameters:
context - A qualified context string. May be null

getContext

java.lang.String getContext()
Gets the navigation context for an MBean. The navigation context is a name qualified with dots (i.e., 'attrib1.attrib2') that references the linking context between bean objects. A sub-class can use this method to determine the navigation context when manipulating attribute keys.

Returns:
A qualified context string. May be null


Copyright © 2006 IBM Corp. All Rights Reserved.