com.waveset.object
Class Type.Subtype

java.lang.Object
  extended bycom.waveset.object.Type.Subtype
All Implemented Interfaces:
java.lang.Comparable
Enclosing class:
Type

public final class Type.Subtype
extends java.lang.Object
implements java.lang.Comparable

Static instances of this class enumerate the values of Attribute.SUBTYPE that a PersistentObject of a specific Type may expose.

Each subtype distinguishes a subset of objects within a type that are structurally similar (or are used for the same purpose).

For example, a User Interface that allows an administrator to select the correlation rule for a particular resource displays a list containing only correlation rules (rather than a list containing all instances of Type.RULE). This User Interface lists instances of Type.RULE that have Attribute.SUBTYPE equal to the value of Subtype.ACCOUNT_CORRELATION_RULE. Subtype.ACCOUNT_CORRELATION_RULE is registered within Type.RULE.

A subtype is meaningful only within a Type, and must therefore be registered within a Type. Nothing prevents the same value and displayName from being registered (in subtypes) within more than one type, but this contradicts the intended use of Subtype.

Short and sweet, the rules are:

For more information, refer to techdoc src/wps/doc/subtype.htm.


Field Summary
static java.lang.String code_id
           
 
Method Summary
 int compareTo(java.lang.Object y)
           
 boolean equals(java.lang.Object obj)
           
 java.lang.String getDisplayName()
           
 java.lang.String getValue()
           
 java.lang.String toString()
           
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values
Method Detail

getValue

public java.lang.String getValue()
Returns:
the value (of Attribute.SUBTYPE} that identifies (objects of) this subtype.

getDisplayName

public java.lang.String getDisplayName()
Returns:
the name of this subtype to display in the UI. By default, equivalent to #getName

toString

public java.lang.String toString()

compareTo

public int compareTo(java.lang.Object y)
Specified by:
compareTo in interface java.lang.Comparable

equals

public boolean equals(java.lang.Object obj)