org.opencrx.kernel.document1.jdo2
Class DocumentFolderEntry

java.lang.Object
  org.oasisopen.jdo2.Identifiable
      org.w3c.jdo2.AbstractObject
          org.opencrx.kernel.document1.jdo2.DocumentFolderEntry

All Implemented Interfaces:

Serializable, SecureObject, DocumentFolderEntry, AspectCapable, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

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

Class DocumentFolderEntry

See Also:

Serialized Form

Nested Class Summary

static class	DocumentFolderEntry.Identity The object's application identity
static class	DocumentFolderEntry.Slice Slice object hold the DocumentFolderEntry'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::document1::DocumentFolderEntry

Constructor Summary

DocumentFolderEntry()

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
void	addToFolder(DocumentFolder folder) Sets a new value for the reference folder.
void	addToFolder(DocumentFolder folder, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:document1:FolderContainsDocument.
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
ContextCapable	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.
BasicObject	getBasedOn() Retrieves the value for the reference basedOn.
<T extends Context> Map<String,T>	getContext() Retrieves the Mao of objects referenced by context.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
Set<String>	getCreatedBy() Retrieves a set containing all the elements for the attribute createdBy.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
BasicObject	getDocument() Retrieves the value for the reference document.
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.
Date	getValidFrom() Retrieves the possibly null value for the optional attribute validFrom.
Date	getValidTo() Retrieves the possibly null value for the optional attribute validTo.
Boolean	isDisabled() Retrieves the possibly null value for the optional attribute disabled.
static DocumentFolderEntry.Identity	newIdentity(DocumentFolder.Identity folder, QualifierType idType, 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
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 DocumentFolderEntry.Identity	openmdxjdoToIdentity(ObjectId objectId)
ModifySecureObjectResult	removeAllOwningGroup(RemoveAllOwningGroupParams in)
ModifySecureObjectResult	removeOwningGroup(ModifyOwningGroupParams in)
ModifySecureObjectResult	replaceOwningGroup(ModifyOwningGroupsParams in)
ModifySecureObjectResult	setAccessLevel(SetAccessLevelParams in)
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	setBasedOn(BasicObject basedOn) Sets a new value for the reference basedOn.
void	setDescription(String description) Sets a new value for the attribute description.
void	setDisabled(Boolean disabled) Sets a new value for the attribute disabled.
void	setDocument(BasicObject document) Sets a new value for the reference document.
void	setName(String name) Sets a new value for the attribute name.
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setValidFrom(Date validFrom) Sets a new value for the attribute validFrom.
void	setValidTo(Date validTo) Sets a new value for the attribute validTo.

Methods inherited from class org.w3c.jdo2.AbstractObject

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

Methods inherited from class org.oasisopen.jdo2.Identifiable

jdoClass, modelClasses, 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::document1::DocumentFolderEntry

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

DocumentFolderEntry.CLASS

Constructor Detail

DocumentFolderEntry

public DocumentFolderEntry()

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 Modifiable

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 Modifiable

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.

getValidTo

public final Date getValidTo()

Retrieves the possibly null value for the optional attribute validTo.

Specified by:

getValidTo in interface DocumentFolderEntry

Returns:

The possibly null value for attribute validTo.

setValidTo

public void setValidTo(Date validTo)

Sets a new value for the attribute validTo.

Specified by:

setValidTo in interface DocumentFolderEntry

Parameters:

validTo - The possibly null new value for attribute validTo.

getIdentity

public String getIdentity()

Retrieves the value for the attribute identity.

Specified by:

getIdentity in interface ExtentCapable

Returns:

The non-null value for attribute identity.

getDocument

public BasicObject getDocument()

Retrieves the value for the reference document.

Specified by:

getDocument in interface DocumentFolderEntry

Returns:

The – possibly null – value for this reference.

setDocument

public void setDocument(BasicObject document)

Sets a new value for the reference document.

Specified by:

setDocument in interface DocumentFolderEntry

Parameters:

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

getBasedOn

public BasicObject getBasedOn()

Retrieves the value for the reference basedOn.

Specified by:

getBasedOn in interface DocumentFolderEntry

Returns:

The – possibly null – value for this reference.

setBasedOn

public void setBasedOn(BasicObject basedOn)

Sets a new value for the reference basedOn.

Specified by:

setBasedOn in interface DocumentFolderEntry

Parameters:

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

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface DocumentFolderEntry

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 DocumentFolderEntry

Parameters:

description - The possibly null new value for attribute description.

getCreatedAt

public Date getCreatedAt()

Retrieves the value for the attribute createdAt.

Specified by:

getCreatedAt in interface Creatable

Returns:

The non-null value for attribute createdAt.

removeAllOwningGroup

public ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)

Specified by:

removeAllOwningGroup in interface SecureObject

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface DocumentFolderEntry

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 DocumentFolderEntry

Parameters:

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

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

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(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

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 Creatable

Returns:

A set containing all elements for this attribute.

getAccessGrantedByParent

public ContextCapable 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(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getContext

public <T extends Context> Map<String,T> getContext()

Retrieves the Mao of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Map of referenced objects.

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.

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getValidFrom

public final Date getValidFrom()

Retrieves the possibly null value for the optional attribute validFrom.

Specified by:

getValidFrom in interface DocumentFolderEntry

Returns:

The possibly null value for attribute validFrom.

setValidFrom

public void setValidFrom(Date validFrom)

Sets a new value for the attribute validFrom.

Specified by:

setValidFrom in interface DocumentFolderEntry

Parameters:

validFrom - The possibly null new value for attribute validFrom.

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.

isDisabled

public final Boolean isDisabled()

Retrieves the possibly null value for the optional attribute disabled.

Specified by:

isDisabled in interface DocumentFolderEntry

Returns:

The possibly null value for attribute disabled.

setDisabled

public void setDisabled(Boolean disabled)

Sets a new value for the attribute disabled.

Specified by:

setDisabled in interface DocumentFolderEntry

Parameters:

disabled - The possibly null new value for attribute disabled.

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:

DocumentFolderEntry.CLASS

addToFolder

public void addToFolder(DocumentFolder folder)

Sets a new value for the reference folder.

Parameters:

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

addToFolder

public void addToFolder(DocumentFolder folder,
                        boolean idIsPersistent,
                        String id)

Set the object's composite association org:opencrx:kernel:document1:FolderContainsDocument.

Parameters:

folder - 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 DocumentFolderEntry.Identity newIdentity(DocumentFolder.Identity folder,
                                                       QualifierType idType,
                                                       String id)

openmdxjdoToIdentity

public static DocumentFolderEntry.Identity openmdxjdoToIdentity(ObjectId objectId)