class: TocItemVO

public class: TocItemVO
Author: Markus Haarlaender (initial creation)
Project: Phase: 1.0; Status: Proposed; Version: $Revision: 1951 $ $LastChangedDate: 2009-05-07 10:; Complexity: 1
Dates: Created: 16.07.2009 15:14:18; Modified: 16.07.2009 15:14:18;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {7CDD4906-2475-4126-BB61-DB42735C1D7D}
Object representing a Toc Item (http://www.escidoc.de/schemas/toc/0.6)
 

Goto: Custom Properties, Fields, Methods

Extends: ValueObject

See also: ContextRO, TocItemRO, TocItemRO, LockStatus, AccountUserRO, State, TocVO, TocItemRO, ValueObject

Appears in: valueobjects

Connections
 
Custom Properties
 
TocItemVO Attributes
Attribute Details
private String
  contentModel
private ContextRO
  contextRO
private java.util.Date
  creationDate
private TocItemRO
  latestRelease
Initial: new TocItemRO()
Notes: Version information of the latest release of this toc.
private TocItemRO
  latestVersion
Initial: new TocItemRO()
Notes: Version information of the latest version of this toc.
private ItemVO.LockStatus
  lockStatus
private java.util.ArrayList
  metadataSets
Initial: new java.util.ArrayList()
private AccountUserRO
  owner
private String
  pid
Notes: The persistent identifier of the released toc.
private ItemVO.State
  publicStatus
private String
  publicStatusComment
private java.util.ArrayList
  relations
Initial: new java.util.ArrayList()
private TocVO
  tocVO
private TocItemRO
  version
Initial: new TocItemRO()
Notes: Version information of this toc version.
 
TocItemVO 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.
@return true, if this item already has a version object.
public
clone():Object
Sequential
Tags: annotations=@Override
Notes: {@inheritDoc}
@author Thomas Diebaecker
public
getContentModel():String
Sequential
public
getContext():ContextRO
Sequential
Notes: Delivers the reference of the collection the item is contained in.
public
getCreationDate():java.util.Date
Sequential
Notes: Delivers the date when the item was created.
public
getLatestRelease():TocItemRO
Sequential
public
getLatestVersion():TocItemRO
Sequential
public
getLockStatus():ItemVO.LockStatus
Sequential
Notes: Delivers the lock status of the item.
public
getMetadataSets():List
Sequential
Notes: Delivers the metadata sets of the item.
public
getModificationDate():Date
Sequential
Notes: Delivers the comment which has to be given when an item is withdrawn.
public
getOwner():AccountUserRO
Sequential
Notes: Delivers the owner of the item.
public
getPid():String
Sequential
Notes: Delivers the persistent identifier of the item.
public
getPublicStatus():ItemVO.State
Sequential
public
getPublicStatusComment():String
Sequential
public
getRelations():java.util.List
Sequential
Notes: Delivers the list of relations in this item.
public
getTocVO():TocVO
Sequential
public
getVersion():TocItemRO
Sequential
Notes: Delivers the reference of the item.
public
getWithdrawalComment():String
Sequential
Notes: Delivers the comment which has to be given when an item is withdrawn.
package
hasPID():boolean
Sequential
Notes: Helper method for JiBX transformations.
package
hasRelations():boolean
Sequential
Notes: Helper method for JiBX transformations. This method helps JiBX to determine if a "relations" XML structure has to be created during marshalling.
public
setContentModel(
   String contentModel):void
Sequential
public
setContext(
   ContextRO newVal):void
Sequential
Notes: Sets the reference of the collection the item is contained in.
public
setCreationDate(
   java.util.Date newVal):void
Sequential
Notes: Sets the date when the item was created.
public
setLatestRelease(
   TocItemRO latestRelease):void
Sequential
public
setLatestVersion(
   TocItemRO latestVersion):void
Sequential
public
setLockStatus(
   ItemVO.LockStatus newVal):void
Sequential
Notes: Sets the lock status of the item.
public
setOwner(
   AccountUserRO newVal):void
Sequential
Notes: Sets the owner of the item.
public
setPid(
   String newVal):void
Sequential
Notes: Sets the persistent identifier of the item.
public
setPublicStatus(
   ItemVO.State publicStatus):void
Sequential
public
setPublicStatusComment(
   String publicStatusComment):void
Sequential
public
setTocVO(
   TocVO tocVO):void
Sequential
public
setVersion(
   TocItemRO newVal):void
Sequential
Notes: Sets the reference of the item.
public
TocItemVO():
Sequential
Notes: Public constructor.
public
TocItemVO(
   TocItemVO other):
Sequential
Notes: Copy constructor.
@author Thomas Diebaecker