org.opencrx.kernel.document1.jpa3
Class DocumentFolder

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

All Implemented Interfaces:

Serializable, Auditee, Indexed, SecureObject, DocumentFolder, PropertySetHolder, AspectCapable, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

public class DocumentFolder
extends org.w3c.jpa3.AbstractObject
implements DocumentFolder

Class DocumentFolder

See Also:

Serialized Form

Nested Class Summary

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

org.w3c.jpa3.AbstractObject.EmbeddedList<E>, org.w3c.jpa3.AbstractObject.EmbeddedSet<E>, org.w3c.jpa3.AbstractObject.Slice

Nested classes/interfaces inherited from interface org.opencrx.kernel.document1.cci2.DocumentFolder

DocumentFolder.Identity

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::DocumentFolder

Constructor Summary

DocumentFolder()
Constructor

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
String	getAccessGrantedByParent_Id()
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.
<T extends AuditEntry> AuditeeHasAuditEntries.Audit<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
<T extends Context> Map<String,T>	getContext() Retrieves the Map 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.
<T extends DocumentFolder> FolderContainsFolder.Folder<T>	getFolder() Retrieves a set containing all the elements for the reference folder.
<T extends DocumentFolderEntry> FolderContainsDocument.FolderEntry<T>	getFolderEntry() Retrieves a set containing all the elements for the reference folderEntry.
String	getIdentity() Retrieves the value for the attribute identity.
<T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
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.
List<String>	getOwningGroup_Id()
<T extends PrincipalGroup> List<T>	getOwningGroup() Retrieves the Collection of objects referenced by owningGroup.
String	getOwningUser_Id()
User	getOwningUser() Retrieves the value for the reference owningUser.
String	getParent_Id()
DocumentFolder	getParent() Retrieves the value for the reference parent.
<T extends PropertySet> DocumentContainsPropertySet.PropertySet<T>	getPropertySet() Retrieves a set containing all the elements for the reference propertySet.
Boolean	isDisabled() Retrieves the possibly null value for the optional attribute disabled.
protected org.w3c.jpa3.AbstractObject.Slice	newDocumentFolder$Slice(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.jpa3.AbstractObject.Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
protected void	openmdxjdoSetSize(int field, int size)
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	setDescription(String description) Sets a new value for the attribute description.
void	setDisabled(Boolean disabled) Sets a new value for the attribute disabled.
void	setName(String name) Sets a new value for the attribute name.
void	setOwningUser_Id(String owningUser)
ModifySecureObjectResult	setOwningUser(SetOwningUserParams in)
void	setOwningUser(User owningUser) Sets a new value for the reference owningUser.
void	setParent_Id(String parent)
void	setParent(DocumentFolder parent) Sets a new value for the reference parent.
void	setSegment_Id(String segment)
void	setSegment(Segment segment) Sets a new value for the reference segment.
UpdateIndexResult	updateIndex()

Methods inherited from class org.w3c.jpa3.AbstractObject

openmdxjdoClassName, 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

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::DocumentFolder

BASE_CLASS

public static final List<String> BASE_CLASS

Define this class as base class

See Also:

DocumentFolder.CLASS

Constructor Detail

DocumentFolder

public DocumentFolder()

Constructor

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.jpa3.AbstractObject.Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

Overrides:

openmdxjdoGetSlices in class org.w3c.jpa3.AbstractObject

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.

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.

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

getPropertySet

public <T extends PropertySet> DocumentContainsPropertySet.PropertySet<T> getPropertySet()

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

Specified by:

getPropertySet in interface PropertySetHolder

Returns:

A set containing all the elements for this reference.

getFolder

public <T extends DocumentFolder> FolderContainsFolder.Folder<T> getFolder()

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

Specified by:

getFolder in interface DocumentFolder

Returns:

A set containing all the elements for this reference.

getContext

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

Retrieves the Map of objects referenced by context.

Specified by:

getContext in interface ContextCapable

Returns:

The Map of referenced objects.

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)

Specified by:

addOwningGroup in interface SecureObject

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

updateIndex

public UpdateIndexResult updateIndex()

Specified by:

updateIndex in interface Indexed

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface DocumentFolder

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 DocumentFolder

Parameters:

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

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.

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.

getOwningUser_Id

public String getOwningUser_Id()

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.

setOwningUser_Id

public void setOwningUser_Id(String owningUser)

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions 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.

isDisabled

public final Boolean isDisabled()

Retrieves the possibly null value for the optional attribute disabled.

Specified by:

isDisabled in interface DocumentFolder

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 DocumentFolder

Parameters:

disabled - The possibly null new value for attribute disabled.

getAudit

public <T extends AuditEntry> AuditeeHasAuditEntries.Audit<T> getAudit()

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

Specified by:

getAudit in interface Auditee

Returns:

A set containing all the elements for this reference.

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.

getOwningGroup_Id

public List<String> getOwningGroup_Id()

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.

getAccessGrantedByParent_Id

public String getAccessGrantedByParent_Id()

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.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

getIndexEntry

public <T extends IndexEntry> IndexedHasIndexEntry.IndexEntry<T> getIndexEntry()

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

Specified by:

getIndexEntry in interface Indexed

Returns:

A set containing all the elements for this reference.

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.

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface DocumentFolder

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 DocumentFolder

Parameters:

description - The possibly null new value for attribute description.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

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.

getParent

public DocumentFolder getParent()

Retrieves the value for the reference parent.

Specified by:

getParent in interface DocumentFolder

Returns:

The – possibly null – value for this reference.

getParent_Id

public String getParent_Id()

setParent

public void setParent(DocumentFolder parent)

Sets a new value for the reference parent.

Specified by:

setParent in interface DocumentFolder

Parameters:

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

setParent_Id

public void setParent_Id(String parent)

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.

getFolderEntry

public <T extends DocumentFolderEntry> FolderContainsDocument.FolderEntry<T> getFolderEntry()

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

Specified by:

getFolderEntry in interface DocumentFolder

Returns:

A set containing all the elements for this reference.

openmdxjdoGetSize

protected int openmdxjdoGetSize(int field)

Overrides:

openmdxjdoGetSize in class org.w3c.jpa3.AbstractObject

openmdxjdoSetSize

protected void openmdxjdoSetSize(int field,
                                 int size)

Overrides:

openmdxjdoSetSize in class org.w3c.jpa3.AbstractObject

newDocumentFolder$Slice

protected org.w3c.jpa3.AbstractObject.Slice newDocumentFolder$Slice(int index)

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()

Retrieve the model class

Returns:

the model class

See Also:

DocumentFolder.CLASS

setSegment

public void setSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

setSegment_Id

public void setSegment_Id(String segment)