org.opencrx.kernel.document1.jpa3
Class FolderAssignment

java.lang.Object
  org.w3c.jpa3.AbstractObject
      org.opencrx.kernel.document1.jpa3.FolderAssignment

All Implemented Interfaces:

Serializable, SecureObject, DocumentFolderAssignment, FolderAssignment, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

public class FolderAssignment
extends AbstractObject
implements FolderAssignment

Class FolderAssignment

See Also:

Serialized Form

Nested Class Summary

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

AbstractObject.AbstractStateAccessor, AbstractObject.EmbeddedList<E>, AbstractObject.EmbeddedSet<E>, AbstractObject.ObjectState, AbstractObject.SlicedList<E,S>, AbstractObject.SlicedMap<E,S>, AbstractObject.SlicedSet<E,S>

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

FolderAssignment.Identity

Field Summary

Timestamp	createdAt Attribute createdAt.
String	identity Attribute identity.
Timestamp	modifiedAt Attribute modifiedAt.

Constructor Summary

FolderAssignment()
Constructor

Method Summary

ModifySecureObjectResult	addOwningGroup(ModifyOwningGroupParams in)
CheckPermissionsResult	checkPermissions(CheckPermissionsParams in)
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.
short	getAssignmentRole() Retrieves the value for the attribute assignmentRole.
Date	getCreatedAt() Retrieves the value for the attribute createdAt.
List<String>	getCreatedBy() Retrieves a list containing all the elements for the attribute createdBy.
String	getDescription() Retrieves the possibly null value for the optional attribute description.
String	getDocumentFolder_Id()
DocumentFolder	getDocumentFolder() Retrieves the value for the reference documentFolder.
String	getIdentity() Retrieves the value for the attribute identity.
Date	getModifiedAt() Retrieves the value for the attribute modifiedAt.
List<String>	getModifiedBy() Retrieves a list containing all the elements for the attribute modifiedBy.
String	getName() Retrieves the value for the attribute name.
protected String	getOpenmdxjdoIdentity() Retrieve the object's JDO identity key
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 <E extends FolderAssignment$Slice> SortedMap<Integer,E>	openmdxjdoGetSlices()
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	setAssignmentRole(short assignmentRole) Sets a new value for the attribute assignmentRole.
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(Document document) Sets a new value for the reference document.
void	setDocumentFolder_Id(String documentFolder)
void	setDocumentFolder(DocumentFolder documentFolder) Sets a new value for the reference documentFolder.
void	setName(String name) Sets a new value for the attribute name.
protected void	setOpenmdxjdoIdentity(String value) Set the object's JDO identity key
void	setOwner(String... owner) Clears owner and adds the given value(s).
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

openmdxjdoMakeDirty, openmdxjdoSetArray, openmdxjdoSetCollection, openmdxjdoToArray, openmdxjdoToArray

Methods inherited from class java.lang.Object

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

Field Detail

modifiedAt

public Timestamp modifiedAt

Attribute modifiedAt.

identity

public String identity

Attribute identity.

createdAt

public Timestamp createdAt

Attribute createdAt.

Constructor Detail

FolderAssignment

public FolderAssignment()

Constructor

Method Detail

getOpenmdxjdoIdentity

protected String getOpenmdxjdoIdentity()

Retrieve the object's JDO identity key

Specified by:

getOpenmdxjdoIdentity in class AbstractObject

Returns:

the value of the object's JDO identity key

setOpenmdxjdoIdentity

protected void setOpenmdxjdoIdentity(String value)

Set the object's JDO identity key

Specified by:

setOpenmdxjdoIdentity in class AbstractObject

openmdxjdoGetSlices

protected final <E extends FolderAssignment$Slice> SortedMap<Integer,E> openmdxjdoGetSlices()

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 List<String> getModifiedBy()

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

Specified by:

getModifiedBy in interface Modifiable

Returns:

A list 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 DocumentFolderAssignment

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 DocumentFolderAssignment

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.

getDocumentFolder

public DocumentFolder getDocumentFolder()

Retrieves the value for the reference documentFolder.

Specified by:

getDocumentFolder in interface DocumentFolderAssignment

Returns:

The – possibly null – value for this reference.

getDocumentFolder_Id

public String getDocumentFolder_Id()

setDocumentFolder

public void setDocumentFolder(DocumentFolder documentFolder)

Sets a new value for the reference documentFolder.

Specified by:

setDocumentFolder in interface DocumentFolderAssignment

Parameters:

documentFolder - The new – possibly null – value for this reference.

setDocumentFolder_Id

public void setDocumentFolder_Id(String documentFolder)

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface FolderAssignment

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 FolderAssignment

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 FolderAssignment

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 FolderAssignment

Parameters:

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

getAssignmentRole

public short getAssignmentRole()

Retrieves the value for the attribute assignmentRole.

Specified by:

getAssignmentRole in interface DocumentFolderAssignment

Returns:

The non-null value for attribute assignmentRole.

setAssignmentRole

public void setAssignmentRole(short assignmentRole)

Sets a new value for the attribute assignmentRole.

Specified by:

setAssignmentRole in interface DocumentFolderAssignment

Parameters:

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

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.

getOwningGroup_Id

public List<String> getOwningGroup_Id()

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 List<String> getCreatedBy()

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

Specified by:

getCreatedBy in interface Creatable

Returns:

A list containing all elements for this attribute.

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel in interface SecureObject

getValidFrom

public final Date getValidFrom()

Retrieves the possibly null value for the optional attribute validFrom.

Specified by:

getValidFrom in interface DocumentFolderAssignment

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 DocumentFolderAssignment

Parameters:

validFrom - The possibly null new value for attribute validFrom.

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

getOwner

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

setOwner

public void setOwner(String... owner)

Clears owner and adds the given value(s).

This method is equivalent to

   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 

Specified by:

setOwner in interface SecureObject

Parameters:

owner - value(s) to be added to owner

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 new – possibly null – value for this reference.

setOwningUser_Id

public void setOwningUser_Id(String owningUser)

isDisabled

public final Boolean isDisabled()

Retrieves the possibly null value for the optional attribute disabled.

Specified by:

isDisabled in interface DocumentFolderAssignment

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 DocumentFolderAssignment

Parameters:

disabled - The possibly null new value for attribute disabled.

setDocument

public void setDocument(Document document)

Sets a new value for the reference document.

Parameters:

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

setDocument_Id

public void setDocument_Id(String document)