org.opencrx.kernel.document1.jpa3
Class DocumentFolderEntry

java.lang.Object
  extended by org.oasisopen.jdo2.Identifiable
      extended by org.w3c.jpa3.AbstractObject
          extended by org.opencrx.kernel.document1.jpa3.DocumentFolderEntry
All Implemented Interfaces:
Serializable, SecureObject, DocumentFolderEntry, AspectCapable, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

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

Class DocumentFolderEntry

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.DocumentFolderEntry
DocumentFolderEntry.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::DocumentFolderEntry
 
Constructor Summary
DocumentFolderEntry()
          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.
 String getBasedOn_Id()
           
 BasicObject getBasedOn()
          Retrieves the value for the reference basedOn.
<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.
 String getDocument_Id()
           
 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.
 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.
 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.
protected  org.w3c.jpa3.AbstractObject.Slice newDocumentFolderEntry$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 setBasedOn_Id(String basedOn)
           
 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_Id(String document)
           
 void setDocument(BasicObject document)
          Sets a new value for the reference document.
 void setFolder_Id(String folder)
           
 void setFolder(DocumentFolder folder)
          Sets a new value for the reference folder.
 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 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.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::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()
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.

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.

getBasedOn_Id

public String getBasedOn_Id()

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.

setBasedOn_Id

public void setBasedOn_Id(String basedOn)

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

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.

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.

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.

getDocument_Id

public String getDocument_Id()

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.

setDocument_Id

public void setDocument_Id(String document)

addOwningGroup

public ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)
Specified by:
addOwningGroup in interface SecureObject

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)
Specified by:
setOwningUser 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.

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.

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

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.

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.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)
Specified by:
removeOwningGroup in interface SecureObject

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

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.

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.

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

newDocumentFolderEntry$Slice

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

openmdxjdoGetClass

protected List<String> openmdxjdoGetClass()
Retrieve the model class

Returns:
the model class
See Also:
DocumentFolderEntry.CLASS

setFolder

public void setFolder(DocumentFolder folder)
Sets a new value for the reference folder.

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

setFolder_Id

public void setFolder_Id(String folder)


This software is published under the BSD license. Copyright © 2003-2009, CRIXP AG, Switzerland, All rights reserved. Use is subject to license terms.