|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.opends.server.admin.RelationDefinition<C,S>
C
- The type of client managed object configuration that this
relation definition refers to.S
- The type of server managed object configuration that this
relation definition refers to.public abstract class RelationDefinition<C extends ConfigurationClient,S extends Configuration>
Relation definitions define relationships between types of managed objects. In addition they define the ownership model:
Within the server, listeners can choose to request notification of managed objects being added or removed from relations.
In LDAP, compositions are represented as follows:
Nested Class Summary | |
---|---|
protected static class |
RelationDefinition.AbstractBuilder<C extends ConfigurationClient,S extends Configuration,D extends RelationDefinition<C,S>>
An interface for incrementally constructing relation definitions. |
protected static class |
RelationDefinition.Common<C extends ConfigurationClient,S extends Configuration>
Opaque structure containing fields common to all relation definition types. |
Constructor Summary | |
---|---|
protected |
RelationDefinition(RelationDefinition.Common<C,S> common)
Create a new managed object relation definition with the specified common fields. |
Method Summary | ||
---|---|---|
abstract
|
accept(RelationDefinitionVisitor<R,P> v,
P p)
Apply a visitor to this relation definition. |
|
AbstractManagedObjectDefinition<C,S> |
getChildDefinition()
Get the definition of the child managed object. |
|
Message |
getDescription()
Gets the optional description of this relation definition in the default locale. |
|
Message |
getDescription(java.util.Locale locale)
Gets the optional description of this relation definition in the specified locale. |
|
java.lang.String |
getName()
Get the name of the relation. |
|
AbstractManagedObjectDefinition<?,?> |
getParentDefinition()
Get the definition of the parent managed object. |
|
Message |
getSynopsis()
Gets the synopsis of this relation definition in the default locale. |
|
Message |
getSynopsis(java.util.Locale locale)
Gets the synopsis of this relation definition in the specified locale. |
|
Message |
getUserFriendlyName()
Gets the user friendly name of this relation definition in the default locale. |
|
Message |
getUserFriendlyName(java.util.Locale locale)
Gets the user friendly name of this relation definition in the specified locale. |
|
boolean |
hasOption(RelationOption option)
Check if the specified option is set for this relation definition. |
|
protected void |
initialize()
Performs any run-time initialization required by this relation definition. |
|
java.lang.String |
toString()
|
|
abstract void |
toString(java.lang.StringBuilder builder)
Append a string representation of the managed object relation to the provided string builder. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
protected RelationDefinition(RelationDefinition.Common<C,S> common)
common
- The common fields of the new relation definition.Method Detail |
---|
public abstract <R,P> R accept(RelationDefinitionVisitor<R,P> v, P p)
R
- The return type of the visitor's methods.P
- The type of the additional parameters to the visitor's
methods.v
- The relation definition visitor.p
- Optional additional visitor parameter.
public final AbstractManagedObjectDefinition<C,S> getChildDefinition()
public final Message getDescription()
null
if there is no
description.public final Message getDescription(java.util.Locale locale)
locale
- The locale.
null
if there is
no description.public final java.lang.String getName()
public final AbstractManagedObjectDefinition<?,?> getParentDefinition()
public final Message getSynopsis()
public final Message getSynopsis(java.util.Locale locale)
locale
- The locale.
public final Message getUserFriendlyName()
public final Message getUserFriendlyName(java.util.Locale locale)
locale
- The locale.
public final boolean hasOption(RelationOption option)
option
- The option to test.
true
if the option is set, or
false
otherwise.public final java.lang.String toString()
toString
in class java.lang.Object
public abstract void toString(java.lang.StringBuilder builder)
builder
- The string builder where the string representation
should be appended.protected void initialize() throws java.lang.Exception
java.lang.Exception
- If this relation definition could not be initialized.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |