com.metamatrix.common.object
Interface ObjectDefinition

All Superinterfaces:
java.lang.Comparable, PropertiedObject
All Known Subinterfaces:
Callback, FileDefinition, FolderDefinition, PermissionDataNodeDefinition, PropertyDefinition
All Known Implementing Classes:
CallbackImpl, ComponentTypePropDefn, FileDefinitionImpl, FolderDefinitionImpl, ObjectDefinitionImpl, PermissionDataNodeDefinitionImpl, PropertyDefinitionGroup, PropertyDefinitionImpl, UserPreferenceCallback

public interface ObjectDefinition
extends java.lang.Comparable, PropertiedObject


Method Summary
 int compareTo(java.lang.Object obj)
          Compares this object to another.
 boolean equals(java.lang.Object obj)
          Returns true if the specified object is semantically equal to this instance.
 java.lang.String getDisplayName()
          Get the localized display name of this property.
 java.lang.String getName()
          Get the actual or programmatic name of this property.
 java.lang.String getPluralDisplayName()
          Get the localized display name of this property.
 java.lang.String getShortDescription()
          Get the short description of this property.
 java.lang.String getShortDisplayName()
          Get the localized display name of this property.
 java.lang.String toString()
          Returns a string representing the current state of the object.
 

Method Detail

getName

java.lang.String getName()
Get the actual or programmatic name of this property.

Returns:
the property's name (never null)

getDisplayName

java.lang.String getDisplayName()
Get the localized display name of this property.

Returns:
the displayable name for this property (never null)

getShortDisplayName

java.lang.String getShortDisplayName()
Get the localized display name of this property.

Returns:
the displayable name for this property (never null)

getPluralDisplayName

java.lang.String getPluralDisplayName()
Get the localized display name of this property.

Returns:
the displayable name for this property (never null)

getShortDescription

java.lang.String getShortDescription()
Get the short description of this property.

Returns:
the short description for this property (never null)

compareTo

int compareTo(java.lang.Object obj)
Compares this object to another. If the specified object is an instance of the MetaMatrixSessionID class, then this method compares the contents; otherwise, it throws a ClassCastException (as instances are comparable only to instances of the same class).

Note: this method is consistent with equals(), meaning that (compare(x, y)==0) == (x.equals(y)).

Specified by:
compareTo in interface java.lang.Comparable
Parameters:
obj - the object that this instance is to be compared to.
Returns:
a negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object, respectively.
Throws:
java.lang.IllegalArgumentException - if the specified object reference is null
java.lang.ClassCastException - if the specified object's type prevents it from being compared to this instance.

equals

boolean equals(java.lang.Object obj)
Returns true if the specified object is semantically equal to this instance. Note: this method is consistent with compareTo().

Overrides:
equals in class java.lang.Object
Parameters:
obj - the object that this instance is to be compared to.
Returns:
whether the object is equal to this object.

toString

java.lang.String toString()
Returns a string representing the current state of the object.

Overrides:
toString in class java.lang.Object
Returns:
the string representation of this instance.


Copyright © 2009. All Rights Reserved.