com.ibm.pim.interfaces.specnode
Interface SpecNode


public interface SpecNode

Read-only interface for a Node within a WPC Spec object.


Field Summary
static int BINARY_SPECNODE
           
static int CATEGORY_SPECNODE
           
static java.lang.String copyright
           
static int CURRENCY_SPECNODE
           
static int DATE_SPECNODE
           
static int FLAG_SPECNODE
           
static int GROUPING_SPECNODE
           
static int IMAGE_SPECNODE
           
static int IMAGE_URL_SPECNODE
           
static int INTEGER_SPECNODE
           
static int LONG_TEXT_SPECNODE
           
static int LOOKUP_TABLE_SPECNODE
           
static int NUMBER_ENUMERATION_SPECNODE
           
static int NUMBER_SPECNODE
           
static int PASSWORD_SPECNODE
           
static int RELATIONSHIP_SPECNODE
           
static int SEQUENCE_SPECNODE
           
static int STRING_ENUMERATION_SPECNODE
           
static int STRING_SPECNODE
           
static int THUMBNAIL_IMAGE_SPECNODE
           
static int THUMBNAIL_IMAGE_URL_SPECNODE
           
static int TIMEZONE_SPECNODE
           
static int URL_SPECNODE
           
 
Method Summary
 java.util.Map getAllDisplayNames()
          Returns display name for each of the selected Locale for the spec in form of Map
 java.util.Collection getChildren()
          Returns the children of this SpecNode
 java.lang.String getDisplayName()
          Returns the display name for this SpecNode, based on currently selected Locale for Item and Category data display.
 java.lang.String getDisplayNameForLocale(java.util.Locale locale)
          Returns displayname for particular Locale.
 int getMaxOccurrence()
          Returns the value of the MAX_OCCURRENCE attribute of this SpecNode
 int getMinOccurrence()
          Returns the value of the MIN_OCCURRENCE attribute of this SpecNode
 java.lang.String getName()
          gives name of the specnode.
 SpecNode getParent()
          Return the parent SpecNode of this SpecNode, if applicable
 java.lang.String getPath()
          Returns the complete path of this SpecNode in the format SpecName/SpecNodeName
 java.util.Collection getSpecNodeAttributes()
          Retrieve attributes of this SpecNode (both required and optional attributes)
 java.util.Collection getSpecNodeOptionalAttributes()
          Retrieve attributes of this SpecNode (optional attributes only)
 java.util.Collection getSpecNodeRequiredAttributes()
          Retrieve attributes of this SpecNode (required attributes only)
 int getType()
          Returns the type of this SpecNode.
 boolean isGrouping()
          Determine whether this is a Grouping SpecNode
 boolean isLeaf()
          Determine whether this is a leaf SpecNode
 boolean isPrimaryKey()
          Determine whether this is a PrimaryKey node
 boolean isSubSpecNode()
          Determine whether this node is part of a SubSpec rather than a top level Spec
 

Field Detail

copyright

public static final java.lang.String copyright
See Also:
Constant Field Values

BINARY_SPECNODE

public static final int BINARY_SPECNODE
See Also:
Constant Field Values

CATEGORY_SPECNODE

public static final int CATEGORY_SPECNODE
See Also:
Constant Field Values

CURRENCY_SPECNODE

public static final int CURRENCY_SPECNODE
See Also:
Constant Field Values

DATE_SPECNODE

public static final int DATE_SPECNODE
See Also:
Constant Field Values

TIMEZONE_SPECNODE

public static final int TIMEZONE_SPECNODE
See Also:
Constant Field Values

FLAG_SPECNODE

public static final int FLAG_SPECNODE
See Also:
Constant Field Values

GROUPING_SPECNODE

public static final int GROUPING_SPECNODE
See Also:
Constant Field Values

IMAGE_SPECNODE

public static final int IMAGE_SPECNODE
See Also:
Constant Field Values

IMAGE_URL_SPECNODE

public static final int IMAGE_URL_SPECNODE
See Also:
Constant Field Values

INTEGER_SPECNODE

public static final int INTEGER_SPECNODE
See Also:
Constant Field Values

LOOKUP_TABLE_SPECNODE

public static final int LOOKUP_TABLE_SPECNODE
See Also:
Constant Field Values

NUMBER_SPECNODE

public static final int NUMBER_SPECNODE
See Also:
Constant Field Values

NUMBER_ENUMERATION_SPECNODE

public static final int NUMBER_ENUMERATION_SPECNODE
See Also:
Constant Field Values

PASSWORD_SPECNODE

public static final int PASSWORD_SPECNODE
See Also:
Constant Field Values

RELATIONSHIP_SPECNODE

public static final int RELATIONSHIP_SPECNODE
See Also:
Constant Field Values

SEQUENCE_SPECNODE

public static final int SEQUENCE_SPECNODE
See Also:
Constant Field Values

STRING_SPECNODE

public static final int STRING_SPECNODE
See Also:
Constant Field Values

STRING_ENUMERATION_SPECNODE

public static final int STRING_ENUMERATION_SPECNODE
See Also:
Constant Field Values

THUMBNAIL_IMAGE_SPECNODE

public static final int THUMBNAIL_IMAGE_SPECNODE
See Also:
Constant Field Values

THUMBNAIL_IMAGE_URL_SPECNODE

public static final int THUMBNAIL_IMAGE_URL_SPECNODE
See Also:
Constant Field Values

URL_SPECNODE

public static final int URL_SPECNODE
See Also:
Constant Field Values

LONG_TEXT_SPECNODE

public static final int LONG_TEXT_SPECNODE
See Also:
Constant Field Values
Method Detail

getType

public int getType()
Returns the type of this SpecNode.

Returns:
the appropriate static constant for the type of this SpecNode

getChildren

public java.util.Collection getChildren()
Returns the children of this SpecNode

Returns:
a java.util.Collection of SpecNode objects

getParent

public SpecNode getParent()
Return the parent SpecNode of this SpecNode, if applicable

Returns:
the immediate parent SpecNode if applicable, otherwise returns null

getName

public java.lang.String getName()
gives name of the specnode.

Returns:
node name

getDisplayName

public java.lang.String getDisplayName()
Returns the display name for this SpecNode, based on currently selected Locale for Item and Category data display. If spec of this particular specnode is not localized then it will return specnode name getName()

Returns:
the display name of this SpecNode.If spec is not localized then it will return specnode name getName()

getAllDisplayNames

public java.util.Map getAllDisplayNames()
Returns display name for each of the selected Locale for the spec in form of Map

Returns:
Map containing key=Locale and value=corresponding locale value. If node is not localized it will return empty Map

getDisplayNameForLocale

public java.lang.String getDisplayNameForLocale(java.util.Locale locale)
Returns displayname for particular Locale.

Parameters:
locale - locale for which display name needs to be retrived
Returns:
displayname for particular locale. In case of spec is not localized or supplied locale is not part of selected locales for spec then it will return null.

getPath

public java.lang.String getPath()
Returns the complete path of this SpecNode in the format SpecName/SpecNodeName

Returns:
a String containing the path of this SpecNode

getMaxOccurrence

public int getMaxOccurrence()
Returns the value of the MAX_OCCURRENCE attribute of this SpecNode

Returns:
MAX_OCCURRENCE attribute value for this SpecNode

getMinOccurrence

public int getMinOccurrence()
Returns the value of the MIN_OCCURRENCE attribute of this SpecNode

Returns:
MIN_OCCURRENCE attribute value for this SpecNode

isGrouping

public boolean isGrouping()
Determine whether this is a Grouping SpecNode

Returns:
true if this SpecNode is a Grouping, false otherwise

isLeaf

public boolean isLeaf()
Determine whether this is a leaf SpecNode

Returns:
true if this node has no children, false otherwise

isPrimaryKey

public boolean isPrimaryKey()
Determine whether this is a PrimaryKey node

Returns:
true if this node is PrimaryKey node, false otherwise

isSubSpecNode

public boolean isSubSpecNode()
Determine whether this node is part of a SubSpec rather than a top level Spec

Returns:
true if this node is part of a SubSpec rather than a top level Spec

getSpecNodeAttributes

public java.util.Collection getSpecNodeAttributes()
Retrieve attributes of this SpecNode (both required and optional attributes)

Returns:
a java.util.Collection of SpecNodeAttribute objects

getSpecNodeRequiredAttributes

public java.util.Collection getSpecNodeRequiredAttributes()
Retrieve attributes of this SpecNode (required attributes only)

Returns:
a java.util.Collection of SpecNodeAttribute objects

getSpecNodeOptionalAttributes

public java.util.Collection getSpecNodeOptionalAttributes()
Retrieve attributes of this SpecNode (optional attributes only)

Returns:
a java.util.Collection of SpecNodeAttribute objects