class: FileVO

public class: FileVO
Author:
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 2004 $ $LastChangedDate: 2009-05-20 14:; Complexity: 1
Dates: Created: 16.07.2009 15:14:01; Modified: 16.07.2009 15:14:01;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {A29297E1-DBCA-4913-B7E8-A16936A07AA4}
A file that is contained in an item.
@revised by MuJ: 28.08.2007
 

Goto: Custom Properties, Fields, Methods

Extends: ValueObject

See also: ChecksumAlgorithm, AccountUserRO, FileRO, Storage, Visibility, ValueObject, DataHandlerBean

Appears in: valueobjects

Connections
 
Custom Properties
 
FileVO Attributes
Attribute Details
private String
  checksum
private ChecksumAlgorithm
  checksumAlgorithm
private String
  content
Notes: A reference to the content of the file.
private String
  contentCategory
Notes: The content type of the file.
private AccountUserRO
  createdByRO
private java.util.Date
  creationDate
Notes: This date gives the moment in time the file was created.
private String
  description
Notes: A short description of the file.
private java.util.Date
  lastModificationDate
Notes: This date is updated whenever the file is stored.
private ArrayList
  metadataSets
Initial: new ArrayList()
private String
  mimeType
Notes: The MIME-type of this format. Valid values see http://www.iana.org/assignments/media-types/
private String
  name
Notes: The name of the file including the extension.
private String
  pid
Notes: The persistent identifier of the file if the item is released.
private FileRO
  reference
private FileVO.Storage
  storage
Notes: A reference to the storage attribute of the file.
private FileVO.Visibility
  visibility
Notes: The visibility of the file for users of the system.
 
FileVO Methods
Operation Details
package
alreadyExistsInFramework():boolean
Sequential
Notes: Helper method for JiBX transformations. This method helps JiBX to determine if this is a 'create' or an 'update' transformation. (visibility restricted to package)
@return boolean true if this file already exists in the framework (creation date is already set)
public
clone():Object
Sequential
Tags: annotations=@Override
Notes: {@inheritDoc}
@author Thomas Diebaecker
public
FileVO():
Sequential
Notes: Public contructor.
@author Thomas Diebaecker
public
FileVO(
   FileVO other):
Sequential
Notes: Copy constructor.
@author Thomas Diebaecker
public
getChecksum():String
Sequential
public
getChecksumAlgorithm():ChecksumAlgorithm
Sequential
public
getContent():String
Sequential
Notes: Delivers a reference to the content of the file, i. e. to the data of the file.
public
getContentCategory():String
Sequential
Notes: Delivers the content type of the file.
public
getContentCategoryString():String
Sequential
Notes: Delivers the value of the contentCategory Enum as a String. If the Enum is not set, an empty String is returned.
public
getCreatedByRO():AccountUserRO
Sequential
public
getCreationDate():java.util.Date
Sequential
Notes: Delivers the creation date of the file.
public
getDefaultMetadata():MdsFileVO
Sequential
public
getDescription():String
Sequential
Notes: Delivers the description of the file, i. e. a short description of the file.
public
getLastModificationDate():java.util.Date
Sequential
Notes: Delivers the date of the last modification of the file.
public
getMetadataSets():List
Sequential
public
getMimeType():String
Sequential
Notes: Delivers the MIME-type of the file. For valid values see http://www.iana.org/assignments/media-types/
public
getName():String
Sequential
Notes: Delivers the name of the file including the extension.
public
getPid():String
Sequential
Notes: Delivers the persistent identifier of the file.
public
getReference():FileRO
Sequential
Notes: Delivers the files' reference.
@see de.mpg.escidoc.services.common.referenceobjects.ReferenceObject
public
getStorage():FileVO.Storage
Sequential
public
getStorageString():String
Sequential
public
getVisibility():FileVO.Visibility
Sequential
Notes: Delivers the visibility of the file.
public
getVisibilityString():String
Sequential
Notes: Delivers the value of the visibility Enum as a String. If the enum is not set, an empty String is returned.
public
setChecksum(
   String checksum):void
Sequential
public
setChecksumAlgorithm(
   ChecksumAlgorithm checksumAlgorithm):void
Sequential
public
setContent(
   String newVal):void
Sequential
Notes: Sets a reference to the content of the file, i. e. to the data of the file.
public
setContentCategory(
   String newVal):void
Sequential
Notes: Sets the content type of the file.
public
setContentCategoryString(
   String newValString):void
Sequential
Notes: Sets the value of the contentCategory Enum by a String.
public
setCreatedByRO(
   AccountUserRO createdByRO):void
Sequential
public
setCreationDate(
   java.util.Date newVal):void
Sequential
Notes: Sets the creation date of the file.
public
setDefaultMetadata(
   MdsFileVO mdsFileVO):void
Sequential
public
setDescription(
   String newVal):void
Sequential
Notes: Sets the description of the file, i. e. a short description of the file.
public
setLastModificationDate(
   java.util.Date newVal):void
Sequential
Notes: Sets the date of the last modification of the file.
public
setMimeType(
   String newVal):void
Sequential
Notes: Sets the MIME-type of the file. For valid values see http://www.iana.org/assignments/media-types/
public
setName(
   String newVal):void
Sequential
Notes: Sets the name of the file including the extension.
public
setPid(
   String newVal):void
Sequential
Notes: Sets the persistent identifier of the file.
public
setReference(
   FileRO newVal):void
Sequential
Notes: Sets the files' reference.
@see de.mpg.escidoc.services.common.referenceobjects.ReferenceObject
public
setStorage(
   FileVO.Storage storage):void
Sequential
public
setStorageString(
   String newValString):void
Sequential
public
setVisibility(
   FileVO.Visibility newVal):void
Sequential
Notes: Sets the visibility of the file.
public
setVisibilityString(
   String newValString):void
Sequential
Notes: Sets the value of the visibility Enum by a String.