class: ContainerVO

public class: ContainerVO
Author:
Project: Phase: 1.0; Status: Proposed; Version: 1.0; Complexity: 1
Dates: Created: 16.07.2009 15:13:57; Modified: 16.07.2009 15:13:57;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {CE76DCB4-F8C4-4196-88D0-AD66EC832D30}
Container object which consists of descriptive metadata and may have zero or more members.
@revised by FrW: 10.06.2008
 

Goto: Custom Properties, Fields, Methods

Extends: ValueObject

Implements: Searchable

See also: ContainerResultVO, ContextRO, ContainerRO, ContainerRO, LockStatus, AccountUserRO, State, ContainerRO, ValueObject, Searchable

Appears in: valueobjects

Connections
 
Custom Properties
 
ContainerVO Attributes
Attribute Details
private String
  contentModel
private ContextRO
  contextRO
private java.util.Date
  creationDate
private ContainerRO
  latestRelease
Initial: new ContainerRO()
Notes: Version information of the latest release of this container.
private ContainerRO
  latestVersion
Initial: new ContainerRO()
Notes: Version information of the latest version of this container.
private ContainerVO.LockStatus
  lockStatus
private java.util.ArrayList
  members
Initial: new java.util.ArrayList()
private java.util.ArrayList
  metadataSets
Initial: new java.util.ArrayList()
private AccountUserRO
  owner
private String
  pid
Notes: The persistent identifier of the released container.
private java.util.ArrayList
  relations
Initial: new java.util.ArrayList()
Notes: This list of relations is a quickfix and cannot be found in the model yet. The reason for this is that the relations are delivered with every item retrieval from the framework, and they get deleted when they are note provided on updates. TODO MuJ or BrP: model and implement correctly, transforming too. Remove quickfix-VO ("ItemRelationVO").
private ContainerVO.State
  state
private String
  statusComment
private ContainerRO
  version
Initial: new ContainerRO()
Notes: Version information of this container version.
 
ContainerVO 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 container already has a version object.
public
clone():Object
Sequential
Tags: annotations=@Override
Notes: {@inheritDoc}
public
ContainerVO():
Sequential
Notes: Public constructor.
public
ContainerVO(
   ContainerVO other):
Sequential
Notes: Copy constructor.
public
getContentModel():String
Sequential
public
getContext():ContextRO
Sequential
Notes: Delivers the reference of the collection the container is contained in.
public
getCreationDate():java.util.Date
Sequential
Notes: Delivers the date when the container was created.
public
getLatestRelease():ContainerRO
Sequential
public
getLatestVersion():ContainerRO
Sequential
public
getLockStatus():LockStatus
Sequential
Notes: Delivers the lock status of the container.
public
getMembers():java.util.List
Sequential
Notes: Delivers the list of members in this container.
public
getMetadataSets():List
Sequential
Notes: Delivers the metadata sets of the container.
public
getModificationDate():Date
Sequential
public
getOwner():AccountUserRO
Sequential
Notes: Delivers the owner of the container.
public
getPid():String
Sequential
Notes: Delivers the persistent identifier of the container.
public
getRelations():java.util.List
Sequential
Notes: Delivers the list of relations in this container.
public
getState():ContainerVO.State
Sequential
public
getStatusComment():String
Sequential
public
getVersion():ContainerRO
Sequential
Notes: Delivers the reference of the container.
public
getWithdrawalComment():String
Sequential
Notes: Delivers the comment which has to be given when a container is withdrawn.
package
hasMembers():boolean
Sequential
Notes: Helper method for JiBX transformations. This method helps JiBX to determine if a "struct-map" XML structure has to be created during marshalling.
@return true, if the container has one or more members.
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 container is contained in.
public
setCreationDate(
   java.util.Date newVal):void
Sequential
Notes: Sets the date when the container was created.
public
setLatestRelease(
   ContainerRO latestRelease):void
Sequential
public
setLatestVersion(
   ContainerRO latestVersion):void
Sequential
public
setLockStatus(
   LockStatus newVal):void
Sequential
Notes: Sets the lock status of the container.
public
setOwner(
   AccountUserRO newVal):void
Sequential
Notes: Sets the owner of the container.
public
setPid(
   String newVal):void
Sequential
Notes: Sets the persistent identifier of the container.
public
setState(
   ContainerVO.State state):void
Sequential
public
setStatusComment(
   String statusComment):void
Sequential
public
setVersion(
   ContainerRO newVal):void
Sequential
Notes: Sets the reference of the container.