org.opencrx.kernel.depot1.jdo2
Class DepotReference

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.depot1.jdo2.DepotReference

All Implemented Interfaces:

Serializable, SecureObject, DepotReference, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

public class DepotReference
extends org.w3c.jdo2.AbstractObject
implements DepotReference

Class DepotReference

See Also:

Serialized Form

Nested Class Summary

static class	DepotReference.Identity The object's application identity
static class	DepotReference.Slice Slice object hold the DepotReference's multivalued attributes

Nested classes/interfaces inherited from class org.w3c.jdo2.AbstractObject

org.w3c.jdo2.AbstractObject.EmbeddedList<E>, org.w3c.jdo2.AbstractObject.EmbeddedSet<E>

Field Summary

static List<String>	BASE_CLASS Define this class as base class
static List<String>	CLASS Define the model class org::opencrx::kernel::depot1::DepotReference

Constructor Summary

DepotReference()

Method Summary

ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
void	addToDepotReferenceHolder(DepotReferenceHolder depotReferenceHolder) Sets a new value for the reference depotReferenceHolder.
void	addToDepotReferenceHolder(DepotReferenceHolder depotReferenceHolder, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:depot1:DepotReferenceHolderContainsDepotReference.
CheckPermissionsResult	checkPermissions(String principalName)
org.openmdx.base.cci2.BasicObject	getAccessGrantedByParent() Retrieves the value for the reference accessGrantedByParent.
short	getAccessLevelBrowse() Retrieves the value for the attribute accessLevelBrowse.
short	getAccessLevelDelete() Retrieves the value for the attribute accessLevelDelete.
short	getAccessLevelUpdate() Retrieves the value for the attribute accessLevelUpdate.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
Depot	getDepot() Retrieves the value for the reference depot.
short	getDepotUsage() Retrieves the value for the attribute depotUsage.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
String	getIdentity() Retrieves the value for the attribute identity.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
Set<String>	getModifiedBy() Retrieves a set containing all the elements for the attribute modifiedBy.
String	getName() Retrieves the value for the attribute name.
List<String>	getOwner() Retrieves a list containing all the elements for the attribute owner.
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
User	getOwningUser() Retrieves the value for the reference owningUser.
<T extends org.openmdx.compatibility.view1.cci2.View> Collection<T>	getView() Retrieves a set containing all the elements for the reference view.
org.openmdx.compatibility.view1.cci2.View	getView(boolean namespaceIsPersistent, String namespace) Retrieves the value for the reference view for the specified qualifier attribute value.
boolean	isHolderQualifiesPosition() Retrieves the value for the attribute holderQualifiesPosition.
static DepotReference.Identity	newIdentity(org.oasisopen.cci2.Identity depotReferenceHolder, boolean idIsPersistent, String id)
protected org.w3c.jdo2.AbstractObject.Slice	newSlice(int index)
protected List<String>	openmdxjdoGetClass() Retrieve the model class
protected String	openmdxjdoGetObjectId() Retrieve the object's JDO identity key
static CloseableCollection<DepotReference>	openmdxjdoGetObjectsByParent(DepotReferenceHolder depotReferenceHolder) Navigate through an object's composite association
protected int	openmdxjdoGetSize(int field)
protected <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
static DepotReference.Identity	openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(short mode)
ModifySecureObjectResult	removeOwningGroup(PrincipalGroup group, short mode)
ModifySecureObjectResult	setAccessLevel(short accessLevelBrowse, short accessLevelDelete, short accessLevelUpdate, short mode)
void	setAccessLevelBrowse(short accessLevelBrowse) Sets a new value for the attribute accessLevelBrowse.
void	setAccessLevelDelete(short accessLevelDelete) Sets a new value for the attribute accessLevelDelete.
void	setAccessLevelUpdate(short accessLevelUpdate) Sets a new value for the attribute accessLevelUpdate.
void	setDepot(Depot depot) Sets a new value for the reference depot.
void	setDepotUsage(short depotUsage) Sets a new value for the attribute depotUsage.
void	setDescription(String description) Sets a new value for the attribute description.
void	setHolderQualifiesPosition(boolean holderQualifiesPosition) Sets a new value for the attribute holderQualifiesPosition.
void	setName(String name) Sets a new value for the attribute name.
ModifySecureObjectResult	setOwningUser(short mode, User user)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.

Methods inherited from class org.w3c.jdo2.AbstractObject

openmdxjdoClassName, openmdxjdoGetIdentityBuilder, openmdxjdoGetList, openmdxjdoGetObjectsByParent, openmdxjdoGetSet, openmdxjdoGetSparseArray, openmdxjdoNewSlice, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray, openmdxjdoValidateElement

Methods inherited from class org.oasisopen.jdo2.Identifiable

openmdxjdoGetObject, openmdxjdoGetObjectById, openmdxjdoGetObjectId, openmdxjdoGetObjectSet, openmdxjdoNewObjectId, openmdxjdoNewObjectId

Methods inherited from class java.lang.Object

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

Field Detail

CLASS

public static final List<String> CLASS

Define the model class org::opencrx::kernel::depot1::DepotReference

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

DepotReference.CLASS

Constructor Detail

DepotReference

public DepotReference()

Method Detail

openmdxjdoGetObjectId

protected String openmdxjdoGetObjectId()

Retrieve the object's JDO identity key

Specified by:

openmdxjdoGetObjectId in class org.oasisopen.jdo2.Identifiable

Returns:

the value of the object's JDO identity key

openmdxjdoGetSlices

protected final <E extends org.w3c.jdo2.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jdo2.AbstractObject

getAccessLevelDelete

public short getAccessLevelDelete()

Retrieves the value for the attribute accessLevelDelete.

Specified by:

getAccessLevelDelete in interface SecureObject

Returns:

The non-null value for attribute accessLevelDelete.

setAccessLevelDelete

public void setAccessLevelDelete(short accessLevelDelete)

Sets a new value for the attribute accessLevelDelete.

Specified by:

setAccessLevelDelete in interface SecureObject

Parameters:

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

getModifiedAt

public Date getModifiedAt()

Retrieves the value for the attribute modifiedAt.

Specified by:

getModifiedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute modifiedAt.

getModifiedBy

public final Set<String> getModifiedBy()

Retrieves a set containing all the elements for the attribute modifiedBy.

Specified by:

getModifiedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getAccessLevelBrowse

public short getAccessLevelBrowse()

Retrieves the value for the attribute accessLevelBrowse.

Specified by:

getAccessLevelBrowse in interface SecureObject

Returns:

The non-null value for attribute accessLevelBrowse.

setAccessLevelBrowse

public void setAccessLevelBrowse(short accessLevelBrowse)

Sets a new value for the attribute accessLevelBrowse.

Specified by:

setAccessLevelBrowse in interface SecureObject

Parameters:

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

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface org.openmdx.base.cci2.ExtentCapable

Returns:

The non-null value for attribute identity.

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface org.openmdx.base.cci2.BasicObject

Returns:

The non-null value for attribute createdAt.

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface DepotReference

Returns:

The possibly null value for attribute description.

setDescription

public void setDescription(String description)

Sets a new value for the attribute description.

Specified by:

setDescription in interface DepotReference

Parameters:

description - The possibly null new value for attribute description.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(short mode)

Specified by:

removeAllOwningGroup in interface SecureObject

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface DepotReference

Returns:

The non-null value for attribute name.

setName

public void setName(String name)

Sets a new value for the attribute name.

Specified by:

setName in interface DepotReference

Parameters:

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

getDepot

public Depot getDepot()

Retrieves the value for the reference depot.

Specified by:

getDepot in interface DepotReference

Returns:

The – possibly null – value for this reference.

setDepot

public void setDepot(Depot depot)

Sets a new value for the reference depot.

Specified by:

setDepot in interface DepotReference

Parameters:

depot - The non-null new value for this reference.

isHolderQualifiesPosition

public boolean isHolderQualifiesPosition()

Retrieves the value for the attribute holderQualifiesPosition.

Specified by:

isHolderQualifiesPosition in interface DepotReference

Returns:

The non-null value for attribute holderQualifiesPosition.

setHolderQualifiesPosition

public void setHolderQualifiesPosition(boolean holderQualifiesPosition)

Sets a new value for the attribute holderQualifiesPosition.

Specified by:

setHolderQualifiesPosition in interface DepotReference

Parameters:

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

setOwningUser

public ModifySecureObjectResult setOwningUser(short mode,
                                              User user)

Specified by:

setOwningUser in interface SecureObject

getOwningGroup

public <T extends PrincipalGroup> List<T> getOwningGroup()

Retrieves the Collection of objects referenced by owningGroup.

Specified by:

getOwningGroup in interface SecureObject

Returns:

The Collection of referenced objects.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(PrincipalGroup group,
                                               short mode)

Specified by:

addOwningGroup in interface SecureObject

checkPermissions

public CheckPermissionsResult checkPermissions(String principalName)

Specified by:

checkPermissions in interface SecureObject

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)

Specified by:

removeOwningGroup in interface SecureObject

getAccessLevelUpdate

public short getAccessLevelUpdate()

Retrieves the value for the attribute accessLevelUpdate.

Specified by:

getAccessLevelUpdate in interface SecureObject

Returns:

The non-null value for attribute accessLevelUpdate.

setAccessLevelUpdate

public void setAccessLevelUpdate(short accessLevelUpdate)

Sets a new value for the attribute accessLevelUpdate.

Specified by:

setAccessLevelUpdate in interface SecureObject

Parameters:

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

getCreatedBy

public final Set<String> getCreatedBy()

Retrieves a set containing all the elements for the attribute createdBy.

Specified by:

getCreatedBy in interface org.openmdx.base.cci2.BasicObject

Returns:

A set containing all elements for this attribute.

getDepotUsage

public short getDepotUsage()

Retrieves the value for the attribute depotUsage.

Specified by:

getDepotUsage in interface DepotReference

Returns:

The non-null value for attribute depotUsage.

setDepotUsage

public void setDepotUsage(short depotUsage)

Sets a new value for the attribute depotUsage.

Specified by:

setDepotUsage in interface DepotReference

Parameters:

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

getAccessGrantedByParent

public org.openmdx.base.cci2.BasicObject getAccessGrantedByParent()

Retrieves the value for the reference accessGrantedByParent.

Specified by:

getAccessGrantedByParent in interface SecureObject

Returns:

The – possibly null – value for this reference.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(short accessLevelBrowse,
                                               short accessLevelDelete,
                                               short accessLevelUpdate,
                                               short mode)

Specified by:

setAccessLevel in interface SecureObject

getOwner

public final List<String> getOwner()

Retrieves a list containing all the elements for the attribute owner.

Specified by:

getOwner in interface SecureObject

Returns:

A list containing all elements for this attribute.

getView

public <T extends org.openmdx.compatibility.view1.cci2.View> Collection<T> getView()

Retrieves a set containing all the elements for the reference view.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Returns:

A set containing all the elements for this reference.

getView

public org.openmdx.compatibility.view1.cci2.View getView(boolean namespaceIsPersistent,
                                                         String namespace)

Retrieves the value for the reference view for the specified qualifier attribute value.

Specified by:

getView in interface org.openmdx.compatibility.view1.cci2.ViewCapable

Parameters:

namespaceIsPersistent - Defines whether value for the qualifier is persistent or not

namespace - The value for the qualifier attribute that qualifies this reference.

Returns:

The possibly null value for this qualifier

getOwningUser

public User getOwningUser()

Retrieves the value for the reference owningUser.

Specified by:

getOwningUser in interface SecureObject

Returns:

The – possibly null – value for this reference.

setOwningUser

public void setOwningUser(User owningUser)

Sets a new value for the reference owningUser.

Specified by:

setOwningUser in interface SecureObject

Parameters:

owningUser - The non-null new value for this reference.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jdo2.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jdo2.AbstractObject

newSlice

protected org.w3c.jdo2.AbstractObject.Slice newSlice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

DepotReference.CLASS

addToDepotReferenceHolder

public void addToDepotReferenceHolder(DepotReferenceHolder depotReferenceHolder)

Sets a new value for the reference depotReferenceHolder.

Parameters:

depotReferenceHolder - The non-null new value for this reference.

openmdxjdoGetObjectsByParent

public static CloseableCollection<DepotReference> openmdxjdoGetObjectsByParent(DepotReferenceHolder depotReferenceHolder)

Navigate through an object's composite association

addToDepotReferenceHolder

public void addToDepotReferenceHolder(DepotReferenceHolder depotReferenceHolder,
                                      boolean idIsPersistent,
                                      String id)

Set the object's composite association org:opencrx:kernel:depot1:DepotReferenceHolderContainsDepotReference.

Parameters:

depotReferenceHolder - The non-null new value for this object's composite owner.

idIsPersistent - Defines whether the id is persistent.

id - The non-null new value for this object's qualifier.

newIdentity

public static DepotReference.Identity newIdentity(org.oasisopen.cci2.Identity depotReferenceHolder,
                                                  boolean idIsPersistent,
                                                  String id)

openmdxjdoToIdentity

public static DepotReference.Identity openmdxjdoToIdentity(org.oasisopen.spi2.ObjectId objectId)