org.opencrx.kernel.document1.cci2

Interface DocumentReference

All Superinterfaces:

org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.Creatable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.base.cci2.Modifiable, SecureObject

All Known Subinterfaces:

DocumentReference

public interface DocumentReference
extends SecureObject, org.openmdx.base.cci2.BasicObject

Class DocumentReference

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	DocumentReference.Identity Object Identity

Method Summary

Modifier and Type	Method and Description
org.openmdx.base.cci2.BasicObject	getBasedOn() Retrieves the value for the reference basedOn.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
String	getName() Retrieves the value for the attribute name.
org.openmdx.base.cci2.BasicObject	getObject() Retrieves the value for the reference object.
void	setDescription(String description) Sets a new value for the attribute description.
void	setName(String name) Sets a new value for the attribute name.

Methods inherited from interface org.opencrx.kernel.base.cci2.SecureObject

addOwningGroup, checkPermissions, getAccessLevelBrowse, getAccessLevelDelete, getAccessLevelUpdate, getOwner, getOwningGroup, getOwningUser, removeAllOwningGroup, removeOwningGroup, replaceOwningGroup, setAccessLevel, setAccessLevelBrowse, setAccessLevelDelete, setAccessLevelUpdate, setOwner, setOwningUser, setOwningUser

Methods inherited from interface org.openmdx.base.cci2.Creatable

getCreatedAt, getCreatedBy

Methods inherited from interface org.openmdx.base.cci2.ExtentCapable

getIdentity

Methods inherited from interface org.openmdx.base.cci2.Modifiable

getModifiedAt, getModifiedBy

Method Detail

getBasedOn

org.openmdx.base.cci2.BasicObject getBasedOn()

Retrieves the value for the reference basedOn.

Returns:

The – possibly null – value for this reference.

getDescription

String getDescription()

Retrieves the possibly null value for the optional attribute description.

Returns:

The possibly null value for attribute description.

setDescription

void setDescription(String description)

Sets a new value for the attribute description.

Parameters:

description - The possibly null new value for attribute description.

getName

String getName()

Retrieves the value for the attribute name.

Returns:

The non-null value for attribute name.

setName

void setName(String name)

Sets a new value for the attribute name.

This attribute is not changeable, i.e. its value can be set as long as the object is TRANSIENT or NEW

Parameters:

name - The non-null new value for attribute name.

getObject

org.openmdx.base.cci2.BasicObject getObject()

Retrieves the value for the reference object.

Returns:

The – possibly null – value for this reference.