org.nuxeo.ecm.core.api

Class InstanceRef

java.lang.Object

org.nuxeo.ecm.core.api.InstanceRef

All Implemented Interfaces:

Serializable, DocumentRef

public class InstanceRef
extends Object
implements DocumentRef

Document repository reference including the principal owner of the session.

Since:

7.10

Author:

Stephane Lacoin at Nuxeo (aka matic)

See Also:

Serialized Form

Field Summary

Fields inherited from interface org.nuxeo.ecm.core.api.DocumentRef

ID, INSTANCE, PATH

Constructor Summary

Constructors

Constructor and Description
InstanceRef(DocumentModel doc, Principal principal)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
Object	reference() Gets the reference value.
int	type() Gets the type of the reference.

Methods inherited from class java.lang.Object

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

Constructor Detail

InstanceRef

public InstanceRef(DocumentModel doc,
                   Principal principal)

Method Detail

type

public int type()

Description copied from interface: DocumentRef

Gets the type of the reference.

Specified by:

type in interface DocumentRef

Returns:

the type of the reference

reference

public Object reference()

Description copied from interface: DocumentRef

Gets the reference value.

For an ID reference, this is the document UUID.

For a PATH reference, this is the document path.

For an INSTANCE reference this is the document itself.

Specified by:

reference in interface DocumentRef

Returns:

the reference value

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object