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

Class RootOidDefault

java.lang.Object

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

All Implemented Interfaces:

Serializable, Encodable, Oid, RootOid, TypedOid

public final class RootOidDefault
extends Object
implements Serializable, RootOid

See Also:

Serialized Form

Nested Class Summary

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

RootOid.Comparison

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

Oid.Matchers, Oid.State

Constructor Summary

Constructors

Constructor and Description
RootOidDefault(DataInputExtended input)
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state)
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state, Long versionSequence)
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state, Long versionSequence, Long versionUtcTimestamp) If specify version sequence, can optionally specify utc timestamp that the oid was changed.
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state, Long versionSequence, String versionUser) If specify version sequence, can optionally specify the user that changed the object.
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state, Long versionSequence, String versionUser, Long versionUtcTimestamp) If specify version sequence, can optionally specify user and/or utc timestamp that the oid was changed.
RootOidDefault(ObjectSpecId objectSpecId, String identifier, Oid.State state, Version version)

Method Summary

Methods

Modifier and Type	Method and Description
org.apache.isis.applib.services.bookmark.Bookmark	asBookmark()
RootOidDefault	asPersistent(String identifier) Returns a new RootOid for the same TypedOid.getObjectSpecId(), but persistent and with the specified identifier.
RootOid.Comparison	compareAgainst(RootOid other)
static RootOid	create(org.apache.isis.applib.services.bookmark.Bookmark bookmark)
static RootOidDefault	create(ObjectSpecId objectSpecId, String identifier)
static RootOidDefault	create(ObjectSpecId objectSpecId, String identifier, Long versionSequence)
static RootOidDefault	create(ObjectSpecId objectSpecId, String identifier, Long versionSequence, Long versionUtcTimestamp)
static RootOidDefault	create(ObjectSpecId objectSpecId, String identifier, Long versionSequence, String versionUser)
static RootOidDefault	create(ObjectSpecId objectSpecId, String identifier, Long versionSequence, String versionUser, Long versionUtcTimestamp)
static RootOidDefault	createTransient(ObjectSpecId objectSpecId, String identifier)
static RootOidDefault	deString(String oidStr, OidMarshaller oidMarshaller)
static RootOid	deStringEncoded(String urlEncodedOidStr, OidMarshaller oidMarshaller)
void	encode(DataOutputExtended output) Returns the domain object's value as an encoded byte array via the encoder.
String	enString(OidMarshaller oidMarshaller) A string representation of this Oid.
String	enStringNoVersion(OidMarshaller oidMarshaller)
boolean	equals(Object other)
boolean	equals(RootOid other)
String	getIdentifier()
ObjectSpecId	getObjectSpecId()
Version	getVersion()
int	hashCode()
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)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state)

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state,
              Long versionSequence)

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state,
              Long versionSequence,
              String versionUser)

If specify version sequence, can optionally specify the user that changed the object. This is used for informational purposes only.

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state,
              Long versionSequence,
              Long versionUtcTimestamp)

If specify version sequence, can optionally specify utc timestamp that the oid was changed. This is used for informational purposes only.

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state,
              Long versionSequence,
              String versionUser,
              Long versionUtcTimestamp)

If specify version sequence, can optionally specify user and/or utc timestamp that the oid was changed. This is used for informational purposes only.

RootOidDefault

public RootOidDefault(ObjectSpecId objectSpecId,
              String identifier,
              Oid.State state,
              Version version)

RootOidDefault

public RootOidDefault(DataInputExtended input)
               throws IOException

Throws:

IOException

Method Detail

createTransient

public static RootOidDefault createTransient(ObjectSpecId objectSpecId,
                             String identifier)

create

public static RootOid create(org.apache.isis.applib.services.bookmark.Bookmark bookmark)

create

public static RootOidDefault create(ObjectSpecId objectSpecId,
                    String identifier)

create

public static RootOidDefault create(ObjectSpecId objectSpecId,
                    String identifier,
                    Long versionSequence)

create

public static RootOidDefault create(ObjectSpecId objectSpecId,
                    String identifier,
                    Long versionSequence,
                    String versionUser)

create

public static RootOidDefault create(ObjectSpecId objectSpecId,
                    String identifier,
                    Long versionSequence,
                    Long versionUtcTimestamp)

create

public static RootOidDefault create(ObjectSpecId objectSpecId,
                    String identifier,
                    Long versionSequence,
                    String versionUser,
                    Long versionUtcTimestamp)

encode

public void encode(DataOutputExtended output)
            throws IOException

Description copied from interface: Encodable

Returns the domain object's value as an encoded byte array via the encoder.

Specified by:

encode in interface Encodable

Throws:

IOException

deStringEncoded

public static RootOid deStringEncoded(String urlEncodedOidStr,
                      OidMarshaller oidMarshaller)

deString

public static RootOidDefault deString(String oidStr,
                      OidMarshaller oidMarshaller)

enString

public String enString(OidMarshaller oidMarshaller)

Description copied from interface: Oid

A string representation of this Oid.

Specified by:

enString in interface Oid

enStringNoVersion

public String enStringNoVersion(OidMarshaller oidMarshaller)

Specified by:

enStringNoVersion in interface Oid

getObjectSpecId

public ObjectSpecId getObjectSpecId()

Specified by:

getObjectSpecId in interface TypedOid

getIdentifier

public String getIdentifier()

Specified by:

getIdentifier in interface RootOid

isTransient

public boolean isTransient()

Description copied from interface: Oid

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.

Specified by:

isTransient in interface Oid

isViewModel

public boolean isViewModel()

Specified by:

isViewModel in interface Oid

isPersistent

public boolean isPersistent()

Specified by:

isPersistent in interface Oid

asPersistent

public RootOidDefault asPersistent(String identifier)

Description copied from interface: RootOid

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

Specified by:

asPersistent in interface RootOid

getVersion

public Version getVersion()

Specified by:

getVersion in interface Oid

setVersion

public void setVersion(Version version)

Specified by:

setVersion in interface Oid

Specified by:

setVersion in interface RootOid

compareAgainst

public RootOid.Comparison compareAgainst(RootOid other)

Specified by:

compareAgainst in interface RootOid

asBookmark

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

Specified by:

asBookmark in interface RootOid

equals

public boolean equals(Object other)

Overrides:

equals in class Object

equals

public boolean equals(RootOid other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object