org.opencrx.kernel.document1.jdo2
Class DocumentFolder

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

All Implemented Interfaces:

Serializable, Auditee, Indexed, SecureObject, DocumentFolder, org.openmdx.base.cci2.BasicObject, org.openmdx.base.cci2.ContextCapable, org.openmdx.base.cci2.ExtentCapable, org.openmdx.compatibility.view1.cci2.ViewCapable

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

Class DocumentFolder

See Also:

Serialized Form

Nested Class Summary

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

Constructor Summary

DocumentFolder()

Method Summary

ModifySecureObjectResult	addOwningGroup(PrincipalGroup group, short mode)
void	addToSegment(Segment segment) Sets a new value for the reference segment.
void	addToSegment(Segment segment, boolean idIsPersistent, String id) Set the object's composite association org:opencrx:kernel:document1:SegmentContainsFolder.
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.
<T extends AuditEntry> Collection<T>	getAudit() Retrieves a set containing all the elements for the reference audit.
AuditEntry	getAudit(boolean idIsPersistent, String id) Retrieves the value for the reference audit for the specified qualifier attribute value.
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 value for the attribute description.
<T extends Document> Collection<T>	getDocument() Retrieves a set containing all the elements for the reference document.
Document	getDocument(boolean idIsPersistent, String id) Retrieves the value for the reference document for the specified qualifier attribute value.
<T extends DocumentFolder> Collection<T>	getFolder() Retrieves a set containing all the elements for the reference folder.
DocumentFolder	getFolder(boolean idIsPersistent, String id) Retrieves the value for the reference folder for the specified qualifier attribute value.
String	getIdentity() Retrieves the value for the attribute identity.
<T extends IndexEntry> Collection<T>	getIndexEntry() Retrieves a set containing all the elements for the reference indexEntry.
IndexEntry	getIndexEntry(boolean idIsPersistent, String id) Retrieves the value for the reference indexEntry for the specified qualifier attribute value.
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.
DocumentFolder	getParent() Retrieves the value for the reference parent.
<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.
static DocumentFolder.Identity	newIdentity(org.openmdx.base.cci2.Segment.Identity segment, 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<DocumentFolder>	openmdxjdoGetObjectsByParent(Segment segment) 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 DocumentFolder.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	setDescription(String description) Sets a new value for the attribute description.
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.
void	setParent(DocumentFolder parent) Sets a new value for the reference parent.
UpdateIndexResult	updateIndex()

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::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()

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.

getDocument

public <T extends Document> Collection<T> getDocument()

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

Specified by:

getDocument in interface DocumentFolder

Returns:

A set containing all the elements for this reference.

getDocument

public Document getDocument(boolean idIsPersistent,
                            String id)

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

Specified by:

getDocument in interface DocumentFolder

Parameters:

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

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

Returns:

The possibly null value for this qualifier

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 String getDescription()

Retrieves the value for the attribute description.

Specified by:

getDescription in interface DocumentFolder

Returns:

The non-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 non-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 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.

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

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.

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.

checkPermissions

public CheckPermissionsResult checkPermissions(String principalName)

Specified by:

checkPermissions in interface SecureObject

getAudit

public <T extends AuditEntry> Collection<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.

getAudit

public AuditEntry getAudit(boolean idIsPersistent,
                           String id)

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

Specified by:

getAudit in interface Auditee

Parameters:

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

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

Returns:

The possibly null value for this qualifier

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(PrincipalGroup group,
                                                  short mode)

Specified by:

removeOwningGroup in interface SecureObject

updateIndex

public UpdateIndexResult updateIndex()

Specified by:

updateIndex in interface Indexed

getFolder

public <T extends DocumentFolder> Collection<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.

getFolder

public DocumentFolder getFolder(boolean idIsPersistent,
                                String id)

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

Specified by:

getFolder in interface DocumentFolder

Parameters:

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

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

Returns:

The possibly null value for this qualifier

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.

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.

getIndexEntry

public <T extends IndexEntry> Collection<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.

getIndexEntry

public IndexEntry getIndexEntry(boolean idIsPersistent,
                                String id)

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

Specified by:

getIndexEntry in interface Indexed

Parameters:

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

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

Returns:

The possibly null value for this qualifier

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:

DocumentFolder.CLASS

addToSegment

public void addToSegment(Segment segment)

Sets a new value for the reference segment.

Parameters:

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

openmdxjdoGetObjectsByParent

public static CloseableCollection<DocumentFolder> openmdxjdoGetObjectsByParent(Segment segment)

Navigate through an object's composite association

addToSegment

public void addToSegment(Segment segment,
                         boolean idIsPersistent,
                         String id)

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

Parameters:

segment - 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 DocumentFolder.Identity newIdentity(org.openmdx.base.cci2.Segment.Identity segment,
                                                  boolean idIsPersistent,
                                                  String id)

openmdxjdoToIdentity

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