org.apache.isis.core.metamodel.adapter

Interface ObjectAdapter

All Superinterfaces:

Instance, org.apache.isis.applib.annotation.When.Persistable

public interface ObjectAdapter
extends Instance, org.apache.isis.applib.annotation.When.Persistable

Adapters to domain objects, where the application is written in terms of domain objects and those objects are represented within the NOF through these adapter, and not directly.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ObjectAdapter.Functions
static class	ObjectAdapter.Util

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canTransitionToResolving()
void	changeState(ResolveState newState) Changes the 'lazy loaded' state of the domain object.
void	checkLock(Version version) Checks the version of this adapter to make sure that it does not differ from the specified version.
void	fireChangedEvent()
ObjectAdapter	getAggregateRoot() Either the aggregate root (either itself or, if parented, then its parent adapter).
ObjectSpecification	getElementSpecification() For (stand-alone) collections, returns the element type.
String	getIconName() Returns the name of an icon to use if this object is to be displayed graphically.
Instance	getInstance(Specification specification) Return an Instance of the specified Specification with respect to this ObjectAdapter.
Object	getObject() Returns the adapted domain object, the POJO, that this adapter represents with the framework.
Oid	getOid() The object's unique Oid.
ResolveState	getResolveState() Determines what 'lazy loaded' state the domain object is in.
ObjectSpecification	getSpecification() Refines Instance.getSpecification().
Version	getVersion()
boolean	isAggregated() Whether this is an aggregated Oid.
boolean	isDestroyed()
boolean	isGhost()
boolean	isNew()
boolean	isParented() Whether this instance belongs to another object (meaning its getOid() will be ParentedOid, either an AggregatedOid or a CollectionOid).
boolean	isResolved()
boolean	isResolving()
boolean	isTitleAvailable()
boolean	isTransient()
boolean	isUpdating()
boolean	isValue() Whether this is a value (standalone, has no oid).
void	markAsResolvedIfPossible()
void	replaceOid(Oid persistedOid) Since Oids are now immutable, it is the reference from the ObjectAdapter to its Oid that must now be updated.
void	replacePojo(Object pojo) Sometimes it is necessary to manage the replacement of the underlying domain object (by another component such as an object store).
boolean	representsPersistent() Whether the object is persisted.
boolean	respondToChangesInPersistentObjects()
void	setElementSpecificationProvider(ElementSpecificationProvider elementSpecificationProvider) For (stand-alone) collections, returns the element type.
void	setVersion(Version version)
String	titleString() Deprecated. - use titleString(ObjectAdapter)
String	titleString(ObjectAdapter contextAdapter) Returns the title to display this object with, rendered within the context of some other adapter.

Method Detail

getSpecification

ObjectSpecification getSpecification()

Refines Instance.getSpecification().

Specified by:

getSpecification in interface Instance

getObject

Object getObject()

Returns the adapted domain object, the POJO, that this adapter represents with the framework.

titleString

@Deprecated
String titleString()

Deprecated. - use titleString(ObjectAdapter)

Returns the title to display this object with, usually obtained from the wrapped domain object.

titleString

String titleString(ObjectAdapter contextAdapter)

Returns the title to display this object with, rendered within the context of some other adapter.

See Also:

TitleFacet.title(ObjectAdapter, ObjectAdapter, org.apache.isis.applib.profiles.Localization)

getInstance

Instance getInstance(Specification specification)

Return an Instance of the specified Specification with respect to this ObjectAdapter.

If called with ObjectSpecification, then just returns this). If called for other subinterfaces, then should provide an appropriate Instance implementation.

Designed to be called in a double-dispatch design from Specification.getInstance(ObjectAdapter).

Note: this method will throw an UnsupportedOperationException unless the extended PojoAdapterXFactory is configured. (That is, only PojoAdapterX provides support for this; the regular PojoAdapter does not currently.

Parameters:

adapter -

Returns:

replacePojo

void replacePojo(Object pojo)

Sometimes it is necessary to manage the replacement of the underlying domain object (by another component such as an object store). This method allows the adapter to be kept while the domain object is replaced.

getElementSpecification

ObjectSpecification getElementSpecification()

For (stand-alone) collections, returns the element type.

For owned (aggregated) collections, the element type can be determined from the TypeOfFacet associated with the ObjectAssociation representing the collection.

See Also:

setElementSpecificationProvider(ElementSpecificationProvider)

setElementSpecificationProvider

void setElementSpecificationProvider(ElementSpecificationProvider elementSpecificationProvider)

For (stand-alone) collections, returns the element type.

See Also:

getElementSpecification()

getIconName

String getIconName()

Returns the name of an icon to use if this object is to be displayed graphically.

May return null if no icon is specified.

changeState

void changeState(ResolveState newState)

Changes the 'lazy loaded' state of the domain object.

See Also:

ResolveState

checkLock

void checkLock(Version version)

Checks the version of this adapter to make sure that it does not differ from the specified version.

Throws:

ConcurrencyException - if the specified version differs from the version held this adapter.

getOid

Oid getOid()

The object's unique Oid.

This id allows the object to added to, stored by, and retrieved from the object store. Objects can be looked up by their Oid from the AdapterManager.

Note that standalone value objects ("foobar", or 5, or a date), are not mapped and have a null oid.

replaceOid

void replaceOid(Oid persistedOid)

Since Oids are now immutable, it is the reference from the ObjectAdapter to its Oid that must now be updated.

getResolveState

ResolveState getResolveState()

Determines what 'lazy loaded' state the domain object is in.

See Also:

ResolveState

representsPersistent

boolean representsPersistent()

Whether the object is persisted.

Note: not necessarily the reciprocal of isTransient(); standalone adapters (with ResolveState.VALUE) report as neither persistent or transient.

isNew

boolean isNew()

isTransient

boolean isTransient()

Specified by:

isTransient in interface org.apache.isis.applib.annotation.When.Persistable

isGhost

boolean isGhost()

isResolved

boolean isResolved()

isResolving

boolean isResolving()

isUpdating

boolean isUpdating()

isDestroyed

boolean isDestroyed()

canTransitionToResolving

boolean canTransitionToResolving()

isTitleAvailable

boolean isTitleAvailable()

markAsResolvedIfPossible

void markAsResolvedIfPossible()

getVersion

Version getVersion()

setVersion

void setVersion(Version version)

fireChangedEvent

void fireChangedEvent()

isParented

boolean isParented()

Whether this instance belongs to another object (meaning its getOid() will be ParentedOid, either an AggregatedOid or a CollectionOid).

isAggregated

boolean isAggregated()

Whether this is an aggregated Oid.

isValue

boolean isValue()

Whether this is a value (standalone, has no oid).

getAggregateRoot

ObjectAdapter getAggregateRoot()

Either the aggregate root (either itself or, if parented, then its parent adapter). TODO: should this be recursive, to support root->aggregate->aggregate etc.

respondToChangesInPersistentObjects

boolean respondToChangesInPersistentObjects()