Nuxeo Enterprise Platform 5.1

org.nuxeo.ecm.platform.archive.api
Interface ArchiveRecord

All Superinterfaces:
Serializable
All Known Implementing Classes:
ArchiveRecordImpl

public interface ArchiveRecord
extends Serializable

Archive record interface.

Author:
Bogdan Tatar

Method Summary
 Date getArchiveDate()
          Returns the date when the archive record was created.
 String getDocLifeCycle()
          Return the life cycle of the document related to the archive record.
 String getDocTitle()
          Return the title of the document related to the archive record.
 String getDocUID()
          Returns the UID of the document related to the archive record.
 String getDocVersion()
          Return the version of the document related to the archive record.
 Date getEstimatedRemovalDate()
          Returns the duration of the transition between the valid and expiration stages plus de duration of conservation.
 Integer getFolios1()
           
 String getFormat1()
          Return format1 of the archive record.
 String getGatheringFolder()
          Returns the gathering folder.
 long getId()
          Returns the archive record identifier.
 Integer getMicroformNumber()
          Return the number of microform for the archive record.
 String getParentDocPath()
          Return the path of the document related to the archive record.
 String getRestMediumLoc()
           
 String getRestMediumState()
           
 String getRestMediumType()
           
 Date getRetentionMediumLastYear()
           
 String getRetentionMediumLocation()
           
 Integer getRetentionMediumMaxAge()
           
 String getRetentionMediumQuality()
           
 String getRetentionMediumState()
          Return the retention support of an archive record.
 String getRetentionMediumType()
           
 String getWritableMediumLoc()
           
 String getWritableMediumState()
           
 String getWritableMediumType()
           
 

Method Detail

getId

long getId()
Returns the archive record identifier.

Returns:
the archive record identifier

getDocUID

String getDocUID()
Returns the UID of the document related to the archive record.

Returns:
the UID of the document

getDocVersion

String getDocVersion()
Return the version of the document related to the archive record.

Returns:
the version of the document

getDocLifeCycle

String getDocLifeCycle()
Return the life cycle of the document related to the archive record.

Returns:
the life cycle of the document

getDocTitle

String getDocTitle()
Return the title of the document related to the archive record.

Returns:
the title of the document

getParentDocPath

String getParentDocPath()
Return the path of the document related to the archive record.

Returns:
the path of the document

getRetentionMediumState

String getRetentionMediumState()
Return the retention support of an archive record.

Returns:
the retention support of an archive record

getRetentionMediumQuality

String getRetentionMediumQuality()
Returns:

getRetentionMediumType

String getRetentionMediumType()
Returns:

getRetentionMediumLocation

String getRetentionMediumLocation()
Returns:

getArchiveDate

Date getArchiveDate()
Returns the date when the archive record was created.

Returns:
the date when the archive record was created

getFormat1

String getFormat1()
Return format1 of the archive record.

Returns:
format1 of the archive record

getFolios1

Integer getFolios1()
Returns:

getMicroformNumber

Integer getMicroformNumber()
Return the number of microform for the archive record.

Returns:
the number of microform

getRestMediumState

String getRestMediumState()
Returns:

getRestMediumType

String getRestMediumType()
Returns:

getRestMediumLoc

String getRestMediumLoc()
Returns:

getWritableMediumLoc

String getWritableMediumLoc()
Returns:

getWritableMediumType

String getWritableMediumType()
Returns:

getWritableMediumState

String getWritableMediumState()
Returns:

getRetentionMediumMaxAge

Integer getRetentionMediumMaxAge()
Returns:

getRetentionMediumLastYear

Date getRetentionMediumLastYear()
Returns:

getEstimatedRemovalDate

Date getEstimatedRemovalDate()
Returns the duration of the transition between the valid and expiration stages plus de duration of conservation.

Returns:

getGatheringFolder

String getGatheringFolder()
Returns the gathering folder.

Returns:
the gathering folder

Nuxeo Enterprise Platform 5.1

Copyright ? 2007 Nuxeo SAS. All Rights Reserved.