org.opencrx.kernel.document1.jpa3
Class DocumentAttachment

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

All Implemented Interfaces:

Serializable, Auditee, SecureObject, DocumentAttachment, Media, BasicObject, ContextCapable, Creatable, ExtentCapable, Modifiable

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

Class DocumentAttachment

See Also:

Serialized Form

Nested Class Summary

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

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

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

DocumentAttachment.Identity

Field Summary

Long	contentLength Attribute contentLength.
Timestamp	createdAt Attribute createdAt.
String	identity Attribute identity.
Timestamp	modifiedAt Attribute modifiedAt.

Constructor Summary

DocumentAttachment()
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.
String	getAuthor() Retrieves the possibly null value for the optional attribute author.
BinaryLargeObject	getContent() Retrieves a binary large object value for the attribute content.
Long	getContentLength() Retrieves the possibly null value for the optional attribute contentLength.
String	getContentMimeType() Retrieves the possibly null value for the optional attribute contentMimeType.
String	getContentName() Retrieves the possibly null value for the optional attribute contentName.
<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	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.
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.
String	getVersion() Retrieves the possibly null value for the optional attribute version.
protected <E extends DocumentAttachment$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	setAuthor(String author) Sets a new value for the attribute author.
void	setContent(BinaryLargeObject content) Sets a new binary value for the attribute content
void	setContentMimeType(String contentMimeType) Sets a new value for the attribute contentMimeType.
void	setContentName(String contentName) Sets a new value for the attribute contentName.
void	setDescription(String description) Sets a new value for the attribute description.
void	setDocument_Id(String document)
void	setDocument(Document document) Sets a new value for the reference document.
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	setVersion(String version) Sets a new value for the attribute version.

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.

contentLength

public Long contentLength

Attribute contentLength.

Constructor Detail

DocumentAttachment

public DocumentAttachment()

Constructor

Method Detail

getOpenmdxjdoIdentity

protected String getOpenmdxjdoIdentity()

Retrieve the object's JDO identity key

Specified by:

getOpenmdxjdoIdentity in class org.w3c.jpa3.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 org.w3c.jpa3.AbstractObject

openmdxjdoGetSlices

protected final <E extends DocumentAttachment$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 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.

getContentMimeType

public final String getContentMimeType()

Retrieves the possibly null value for the optional attribute contentMimeType.

Specified by:

getContentMimeType in interface Media

Returns:

The possibly null value for attribute contentMimeType.

setContentMimeType

public void setContentMimeType(String contentMimeType)

Sets a new value for the attribute contentMimeType.

Specified by:

setContentMimeType in interface Media

Parameters:

contentMimeType - The possibly null new value for attribute contentMimeType.

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.

getVersion

public final String getVersion()

Retrieves the possibly null value for the optional attribute version.

Specified by:

getVersion in interface DocumentAttachment

Returns:

The possibly null value for attribute version.

setVersion

public void setVersion(String version)

Sets a new value for the attribute version.

Specified by:

setVersion in interface DocumentAttachment

Parameters:

version - The possibly null new value for attribute version.

getAuthor

public final String getAuthor()

Retrieves the possibly null value for the optional attribute author.

Specified by:

getAuthor in interface DocumentAttachment

Returns:

The possibly null value for attribute author.

setAuthor

public void setAuthor(String author)

Sets a new value for the attribute author.

Specified by:

setAuthor in interface DocumentAttachment

Parameters:

author - The possibly null new value for attribute author.

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

getDescription

public final String getDescription()

Retrieves the possibly null value for the optional attribute description.

Specified by:

getDescription in interface Media

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 Media

Parameters:

description - The possibly null new value for attribute description.

getName

public String getName()

Retrieves the value for the attribute name.

Specified by:

getName in interface DocumentAttachment

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 DocumentAttachment

Parameters:

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

setOwningUser

public ModifySecureObjectResult setOwningUser(SetOwningUserParams in)

Specified by:

setOwningUser in interface SecureObject

getContentLength

public final Long getContentLength()

Retrieves the possibly null value for the optional attribute contentLength.

Specified by:

getContentLength in interface Media

Returns:

The possibly null value for attribute contentLength.

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

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.

checkPermissions

public CheckPermissionsResult checkPermissions(CheckPermissionsParams in)

Specified by:

checkPermissions in interface SecureObject

getContentName

public final String getContentName()

Retrieves the possibly null value for the optional attribute contentName.

Specified by:

getContentName in interface Media

Returns:

The possibly null value for attribute contentName.

setContentName

public void setContentName(String contentName)

Sets a new value for the attribute contentName.

Specified by:

setContentName in interface Media

Parameters:

contentName - The possibly null new value for attribute contentName.

removeOwningGroup

public ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)

Specified by:

removeOwningGroup in interface SecureObject

getContent

public BinaryLargeObject getContent()

Retrieves a binary large object value for the attribute content.

Specified by:

getContent in interface Media

setContent

public void setContent(BinaryLargeObject content)

Sets a new binary value for the attribute content

Specified by:

setContent in interface Media

Parameters:

content - A BinaryLargeObject containing the value for this attribute.

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

getAccessGrantedByParent_Id

public String getAccessGrantedByParent_Id()

setAccessLevel

public ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)

Specified by:

setAccessLevel 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

replaceOwningGroup

public ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)

Specified by:

replaceOwningGroup in interface SecureObject

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.

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)

setDocument

public void setDocument(Document document)

Sets a new value for the reference document.

Parameters:

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

setDocument_Id

public void setDocument_Id(String document)