org.alfresco.service.cmr.dictionary

Interface AssociationDefinition

All Superinterfaces:

ClassAttributeDefinition

All Known Subinterfaces:

ChildAssociationDefinition

public interface AssociationDefinition
extends ClassAttributeDefinition

Read-only definition of an Association.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDescription()
ModelDefinition	getModel()
QName	getName()
ClassDefinition	getSourceClass()
QName	getSourceRoleName()
ClassDefinition	getTargetClass()
QName	getTargetRoleName()
java.lang.String	getTitle()
boolean	isChild() Is this a child association?
boolean	isProtected() Is this association maintained by the Repository?
boolean	isSourceMandatory() Is the source class optional in this association?
boolean	isSourceMany() Can there be many source class instances in this association?
boolean	isTargetMandatory() Is the target class optional in this association?
boolean	isTargetMandatoryEnforced() Is the target class is mandatory, it is enforced?
boolean	isTargetMany() Can there be many target class instances in this association?

Method Detail

getModel

ModelDefinition getModel()

Specified by:

getModel in interface ClassAttributeDefinition

Returns:

defining model

getName

QName getName()

Specified by:

getName in interface ClassAttributeDefinition

Returns:

the qualified name

getTitle

java.lang.String getTitle()

Specified by:

getTitle in interface ClassAttributeDefinition

Returns:

the human-readable title

getDescription

java.lang.String getDescription()

Specified by:

getDescription in interface ClassAttributeDefinition

Returns:

the human-readable description

isChild

boolean isChild()

Is this a child association?

Returns:

true => child, false => general relationship

isProtected

boolean isProtected()

Is this association maintained by the Repository?

Specified by:

isProtected in interface ClassAttributeDefinition

Returns:

true => system maintained, false => client may maintain

getSourceClass

ClassDefinition getSourceClass()

Returns:

the source class

getSourceRoleName

QName getSourceRoleName()

Returns:

the role of the source class in this association?

isSourceMandatory

boolean isSourceMandatory()

Is the source class optional in this association?

Returns:

true => cardinality > 0

isSourceMany

boolean isSourceMany()

Can there be many source class instances in this association?

Returns:

true => cardinality > 1, false => cardinality of 0 or 1

getTargetClass

ClassDefinition getTargetClass()

Returns:

the target class

getTargetRoleName

QName getTargetRoleName()

Returns:

the role of the target class in this association?

isTargetMandatory

boolean isTargetMandatory()

Is the target class optional in this association?

Returns:

true => cardinality > 0

isTargetMandatoryEnforced

boolean isTargetMandatoryEnforced()

Is the target class is mandatory, it is enforced?

Returns:

true => enforced

isTargetMany

boolean isTargetMany()

Can there be many target class instances in this association?

Returns:

true => cardinality > 1, false => cardinality of 0 or 1