com.jamasoftware.contour.service.domain.graph

Interface DomainObjectLink

All Known Implementing Classes:

DomainObjectLinkBase, IdPropertyDomainObjectLink, JobScheduleOrganizationDomainObjectLink, ObjectTypeScopedDomainObjectLink, PropertyDescriptorDomainObjectLink, PropertyEntryIdValueDomainObjectLink, ScopeRefDomainObjectLink, SidScopedDomainObjectLink

public interface DomainObjectLink

Defines a link between two DomainObjectNodes.

Method Summary

Methods

Modifier and Type	Method and Description
<R> R	accept(DomainObjectLinkVisitor<R,?> visitor) Visitor pattern for DomainObjectLinkVisitors
<R,P> R	accept(DomainObjectLinkVisitor<R,P> visitor, P p) Visitor pattern for DomainObjectLinkVisitors
String	describe() Gets a string representation of the link.
List<? extends DomainObjectBase>	findDependantsOfObject(DomainObjectBase dependency) Given a dependency, this will find all dependant objects that have this dependency.
DomainObjectNode	getDependant() Gets the DomainObjectNode that is the dependant.
DomainObjectNode	getDependency() Gets the DomainObjectNode that is the dependency
DomainObjectBase	getDependencyObject(DomainObjectBase dependant) This function will return the dependency object for a given dependant.
DomainObjectBase	getDependencyObjectIdOnly(DomainObjectBase dependant) Same as getDependencyObject(DomainObjectBase), but the returned object will only have the id set.
boolean	isWeakDependency() A weak dependency is one that isn't strictly enforced, and should be considered after non- weak dependencies.
void	setDependencyObject(DomainObjectBase dependant, DomainObjectBase dependency) This function will set the dependency object for a given dependant.
String	shortDescribe() A very short description (usually one word)

Method Detail

accept

<R> R accept(DomainObjectLinkVisitor<R,?> visitor)

Visitor pattern for DomainObjectLinkVisitors

accept

<R,P> R accept(DomainObjectLinkVisitor<R,P> visitor,
             P p)

Visitor pattern for DomainObjectLinkVisitors

getDependant

DomainObjectNode getDependant()

Gets the DomainObjectNode that is the dependant.

getDependency

DomainObjectNode getDependency()

Gets the DomainObjectNode that is the dependency

getDependencyObject

DomainObjectBase getDependencyObject(DomainObjectBase dependant)

This function will return the dependency object for a given dependant. For example, if this link is "Document.project -> Project", then given a Document, this will return the corresponding Project.

getDependencyObjectIdOnly

DomainObjectBase getDependencyObjectIdOnly(DomainObjectBase dependant)

Same as getDependencyObject(DomainObjectBase), but the returned object will only have the id set. Use this as a performance booster when you only need the id and class.

setDependencyObject

void setDependencyObject(DomainObjectBase dependant,
                       DomainObjectBase dependency)

This function will set the dependency object for a given dependant. For example, if this link is "Document.project -> Project", then given a Document dependant and Project dependency, this function will set the Project on the Document.

findDependantsOfObject

List<? extends DomainObjectBase> findDependantsOfObject(DomainObjectBase dependency)

Given a dependency, this will find all dependant objects that have this dependency. For example, if this link is "Document.project -> Project", then given a Project, this will return all the Documents associated with this Project.

isWeakDependency

boolean isWeakDependency()

A weak dependency is one that isn't strictly enforced, and should be considered after non- weak dependencies.

describe

String describe()

Gets a string representation of the link.

shortDescribe

String shortDescribe()

A very short description (usually one word)