com.evolveum.midpoint.prism

Class PrismReferenceDefinition

java.lang.Object

com.evolveum.midpoint.prism.Definition

com.evolveum.midpoint.prism.ItemDefinition

com.evolveum.midpoint.prism.PrismReferenceDefinition

All Implemented Interfaces:

DebugDumpable, Serializable

public class PrismReferenceDefinition
extends ItemDefinition

Object Reference Schema Definition. Object Reference is a property that describes reference to an object. It is used to represent association between objects. For example reference from User object to Account objects that belong to the user. The reference is a simple uni-directional link using an OID as an identifier. This type should be used for all object references so the implementations can detect them and automatically resolve them. This class represents schema definition for object reference. See Definition for more details.

Author:

Radovan Semancik

See Also:

Serialized Form

Field Summary

Fields inherited from class com.evolveum.midpoint.prism.ItemDefinition

name

Fields inherited from class com.evolveum.midpoint.prism.Definition

deprecated, displayName, displayOrder, documentation, help, ignored, inherited, isAbstract, isRuntimeSchema, prismContext, typeName

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

INDENT_STRING

Constructor Summary

Constructors

Constructor and Description
PrismReferenceDefinition(QName elementName, QName typeName, PrismContext prismContext)

Method Summary

Methods

Modifier and Type	Method and Description
PrismReferenceDefinition	clone()
protected void	copyDefinitionData(PrismReferenceDefinition clone)
ItemDelta	createEmptyDelta(ItemPath path)
protected void	extendToString(StringBuilder sb)
QName	getCompositeObjectElementName()
protected String	getDebugDumpClassName() Return a human readable name of this class suitable for logs.
String	getDocClassName() Returns human-readable name of this class suitable for documentation.
QName	getTargetTypeName() Returns valid XSD object types whose may be the targets of the reference.
PrismReference	instantiate() Create an item instance.
PrismReference	instantiate(QName name) Create an item instance.
boolean	isComposite()
boolean	isValidFor(QName elementQName, Class<? extends ItemDefinition> clazz)
void	setComposite(boolean isComposite)
void	setCompositeObjectElementName(QName compositeObjectElementName)
void	setTargetTypeName(QName targetTypeName)

Methods inherited from class com.evolveum.midpoint.prism.ItemDefinition

adoptElementDefinitionFrom, canAdd, canModify, canRead, copyDefinitionData, debugFlags, debugMultiplicity, equals, getMaxOccurs, getMinOccurs, getName, getNamespace, hashCode, isDynamic, isMandatory, isMultiValue, isOperational, isOptional, isSingleValue, setCanAdd, setCanModify, setCanRead, setDynamic, setMaxOccurs, setMinOccurs, setName, setOperational, setReadOnly, toString

Methods inherited from class com.evolveum.midpoint.prism.Definition

copyDefinitionData, debugDump, debugDump, getDisplayName, getDisplayOrder, getDocumentation, getDocumentationPreview, getHelp, getPrismContext, getSchemaRegistry, getTypeClass, getTypeClassIfKnown, getTypeName, isAbstract, isDeprecated, isIgnored, isInherited, isRuntimeSchema, setAbstract, setDeprecated, setDisplayName, setDisplayOrder, setDocumentation, setHelp, setIgnored, setInherited, setRuntimeSchema, setTypeName

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrismReferenceDefinition

public PrismReferenceDefinition(QName elementName,
                        QName typeName,
                        PrismContext prismContext)

Method Detail

getTargetTypeName

public QName getTargetTypeName()

Returns valid XSD object types whose may be the targets of the reference. Corresponds to "targetType" XSD annotation. Returns empty set if not specified. Must not return null.

Returns:

set of target type names

setTargetTypeName

public void setTargetTypeName(QName targetTypeName)

getCompositeObjectElementName

public QName getCompositeObjectElementName()

setCompositeObjectElementName

public void setCompositeObjectElementName(QName compositeObjectElementName)

isComposite

public boolean isComposite()

setComposite

public void setComposite(boolean isComposite)

isValidFor

public boolean isValidFor(QName elementQName,
                 Class<? extends ItemDefinition> clazz)

Overrides:

isValidFor in class ItemDefinition

instantiate

public PrismReference instantiate()

Description copied from class: ItemDefinition

Create an item instance. Definition name or default name will used as an element name for the instance. The instance will otherwise be empty.

Specified by:

instantiate in class ItemDefinition

Returns:

created item instance

instantiate

public PrismReference instantiate(QName name)

Description copied from class: ItemDefinition

Create an item instance. Definition name will use provided name. for the instance. The instance will otherwise be empty.

Specified by:

instantiate in class ItemDefinition

Returns:

created item instance

createEmptyDelta

public ItemDelta createEmptyDelta(ItemPath path)

Specified by:

createEmptyDelta in class ItemDefinition

clone

public PrismReferenceDefinition clone()

Specified by:

clone in class ItemDefinition

copyDefinitionData

protected void copyDefinitionData(PrismReferenceDefinition clone)

getDebugDumpClassName

protected String getDebugDumpClassName()

Return a human readable name of this class suitable for logs.

Specified by:

getDebugDumpClassName in class Definition

getDocClassName

public String getDocClassName()

Description copied from class: Definition

Returns human-readable name of this class suitable for documentation. (e.g. "property")

Specified by:

getDocClassName in class Definition

extendToString

protected void extendToString(StringBuilder sb)

Overrides:

extendToString in class ItemDefinition