org.apache.isis.core.metamodel.adapter.oid

Interface RootOid

All Superinterfaces:

Encodable, Oid, TypedOid

All Known Implementing Classes:

RootOidDefault

public interface RootOid
extends TypedOid

Defines a subtype of Oid specific to a root adapter.

The root adapter/pojo can be recreated with no further information; the TypedOid.getObjectSpecId() can be used to fetch the corresponding ObjectSpecification using SpecificationLoaderSpi#lookupBySpecId(String).

As such, is directly akin to the DSP's oid that is of the form CUS|1234567A, where the overall form is a simple string and also identifies the type of the object.

In addition, can be directly encoded/decoded into strings. The Oid.enString(OidMarshaller) interface is defined in the interface; implementations must also provide a static deString(String) factory method.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RootOid.Comparison The result of performing a comparison.

Nested classes/interfaces inherited from interface org.apache.isis.core.metamodel.adapter.oid.Oid

Oid.Matchers, Oid.State

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.isis.applib.services.bookmark.Bookmark	asBookmark()
RootOid	asPersistent(String identifier) Returns a new RootOid for the same TypedOid.getObjectSpecId(), but persistent and with the specified identifier.
RootOid.Comparison	compareAgainst(RootOid oid2)
String	getIdentifier()
void	setVersion(Version version)

Methods inherited from interface org.apache.isis.core.metamodel.adapter.oid.TypedOid

getObjectSpecId

Methods inherited from interface org.apache.isis.core.metamodel.adapter.oid.Oid

enString, enStringNoVersion, getVersion, isPersistent, isTransient, isViewModel

Methods inherited from interface org.apache.isis.core.commons.encoding.Encodable

encode

Method Detail

getIdentifier

String getIdentifier()

setVersion

void setVersion(Version version)

Specified by:

setVersion in interface Oid

asPersistent

RootOid asPersistent(String identifier)

Returns a new RootOid for the same TypedOid.getObjectSpecId(), but persistent and with the specified identifier.

compareAgainst

RootOid.Comparison compareAgainst(RootOid oid2)

asBookmark

org.apache.isis.applib.services.bookmark.Bookmark asBookmark()