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

Interface Oid

All Superinterfaces:

Encodable

All Known Subinterfaces:

RootOid, TypedOid

All Known Implementing Classes:

AggregatedOid, CollectionOid, ParentedOid, RootOidDefault

public interface Oid
extends Encodable

An immutable identifier for either a root object (subtype RootOid) or an aggregated object (subtype AggregatedOid).

Note that value objects (strings, ints, Values etc) do not have an Oid.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Oid.Matchers
static class	Oid.State

Method Summary

Methods

Modifier and Type	Method and Description
String	enString(OidMarshaller oidMarshaller) A string representation of this Oid.
String	enStringNoVersion(OidMarshaller oidMarshaller)
Version	getVersion()
boolean	isPersistent()
boolean	isTransient() Flags whether this OID is for a transient (not-yet-persisted) object, or a view model object, or for a persistent object.
boolean	isViewModel()
void	setVersion(Version version)

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

encode

Method Detail

enString

String enString(OidMarshaller oidMarshaller)

A string representation of this Oid.

enStringNoVersion

String enStringNoVersion(OidMarshaller oidMarshaller)

getVersion

Version getVersion()

setVersion

void setVersion(Version version)

isTransient

boolean isTransient()

Flags whether this OID is for a transient (not-yet-persisted) object, or a view model object, or for a persistent object.

In the case of an AggregatedOid, is determined by the state of its parent's state.

isViewModel

boolean isViewModel()

isPersistent

boolean isPersistent()