com.sas.workspace.plugins
Class ArchiveInfo

java.lang.Object
  com.sas.workspace.plugins.ArchiveInfo

public class ArchiveInfo
extends java.lang.Object

The ArchiveInfo object is used to represent a single archive created by the Version Control Plugin's archive process.

Field Summary

java.util.List<PathUrl>	containedObjects the contents of the archive
java.util.Date	date the date the archive was created
java.lang.String	description a description of the archive
java.lang.String	name the name of the archive
java.lang.String	userID the user who created the archive
java.lang.String	version the version of the archive

Constructor Summary

ArchiveInfo()
Creates a new ArchiveInfo object but leaves all fields uninitialized.

ArchiveInfo(java.lang.String name, java.lang.String description, java.lang.String userID, java.util.Date date, java.lang.String version, java.util.List<PathUrl> containedObjects)
Creates a new ArchiveInfo object and initializes all fields.

Method Summary

java.util.List<PathUrl>	getContainedObjects() Returns a list of PathUrl objects, each representing one metadata object contained by this ArchiveInfo object.
java.util.Date	getDate() Gets the Date that the archive represented by this ArchiveInfo object was created.
java.lang.String	getDescription() Gets the description of this ArchiveInfo.
java.lang.String	getName() Gets the name of the archive, originally specified by the user during the archive process.
java.lang.String	getUserID() Gets the String representing the user who initially created the archive.
java.lang.String	getVersion() Gets the version of this ArchiveInfo.
void	setContainedObjects(java.util.List<PathUrl> containedObjects) Sets the list of PathUrl objects that represent the location (in metadata) of the objects contained within this ArchiveInfo.
void	setDate(java.util.Date date) Sets the Date that the archive represented by this ArchiveInfo object was created.
void	setDescription(java.lang.String description) Sets the description of this ArchiveInfo.
void	setName(java.lang.String name) Sets the name of the archive, originally specified by the user during the archive process.
void	setUserID(java.lang.String userID) Sets the String representing the user who initially created the archive.
void	setVersion(java.lang.String version) Sets the version of this ArchiveInfo.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

name

public java.lang.String name

the name of the archive

description

public java.lang.String description

a description of the archive

userID

public java.lang.String userID

the user who created the archive

date

public java.util.Date date

the date the archive was created

version

public java.lang.String version

the version of the archive

containedObjects

public java.util.List<PathUrl> containedObjects

the contents of the archive

Constructor Detail

ArchiveInfo

public ArchiveInfo()

Creates a new ArchiveInfo object but leaves all fields uninitialized.

ArchiveInfo

public ArchiveInfo(java.lang.String name,
                   java.lang.String description,
                   java.lang.String userID,
                   java.util.Date date,
                   java.lang.String version,
                   java.util.List<PathUrl> containedObjects)

Creates a new ArchiveInfo object and initializes all fields.

Parameters:

name - the name of the archive

description - a description of the archive

userID - the user who created the archive

date - the date the archive was created

version - the version of the archive

containedObjects - the contents of the archive

Method Detail

getName

public java.lang.String getName()

Gets the name of the archive, originally specified by the user during the archive process.

Returns:

the name of the archive

setName

public void setName(java.lang.String name)

Sets the name of the archive, originally specified by the user during the archive process.

Parameters:

name - the name of the archive

getDescription

public java.lang.String getDescription()

Gets the description of this ArchiveInfo. This may include information about the contents, the author, or any other information the user feels is pertinent.

Returns:

a String describing the contents of this ArchiveInfo.

setDescription

public void setDescription(java.lang.String description)

Sets the description of this ArchiveInfo. This may include information about the contents, the author, or any other information the user feels is pertinent.

Parameters:

description - a String describing the contents of this ArchiveInfo.

getUserID

public java.lang.String getUserID()

Gets the String representing the user who initially created the archive.

Returns:

a String that is a unique representation of the user who created the archive.

setUserID

public void setUserID(java.lang.String userID)

Sets the String representing the user who initially created the archive.

Parameters:

userID - a String that is a unique representation of the user who created the archive.

getDate

public java.util.Date getDate()

Gets the Date that the archive represented by this ArchiveInfo object was created.

Returns:

the Date this ArchiveInfo was originally created.

setDate

public void setDate(java.util.Date date)

Sets the Date that the archive represented by this ArchiveInfo object was created.

Parameters:

date - the Date this ArchiveInfo was originally created.

getVersion

public java.lang.String getVersion()

Gets the version of this ArchiveInfo. This information typically comes from, and is controlled by, the version control system.

Returns:

a String representation of the version of this archive. This may or may not be numeric data, depending on the specific version control system.

setVersion

public void setVersion(java.lang.String version)

Sets the version of this ArchiveInfo. This information typically comes from, and is controlled by, the version control system.

Parameters:

version - a String representation of the version of this archive. This may or may not be numeric data, depending on the specific version control system.

getContainedObjects

public java.util.List<PathUrl> getContainedObjects()

Returns a list of PathUrl objects, each representing one metadata object contained by this ArchiveInfo object. This will be a list of PathUrl objects that point to the location (at the time of export) of the objects in the metadata. These paths can change if the user moves objects around in metadata, so this list will not be completely accurate if the structure has changed since the archive was made.

Returns:

A list of PathUrl objects where each PathUrl is the location (in metadata) of an object in this ArchiveInfo.

setContainedObjects

public void setContainedObjects(java.util.List<PathUrl> containedObjects)

Sets the list of PathUrl objects that represent the location (in metadata) of the objects contained within this ArchiveInfo.

Parameters:

containedObjects - the list of PathUrl objects, where each PathUrl is the location (in metadata) of an object in this ArchiveInfo