org.sakaiproject.service.legacy.archive
Interface ArchiveService

All Known Implementing Classes:
BasicArchiveService

public interface ArchiveService

GenericArchiveService takes care of exporting and importing resources.

Version:
$Revision: 632 $
Author:
University of Michigan, CHEF Software Development Team

Field Summary
static String FROM_CT
          A tag for the input system.
static String FROM_SAKAI
           
static String FROM_WT
           
static boolean SAKAI_assign_draft_import
           
static boolean SAKAI_msg_draft_import
           
static boolean SAKAI_rsc_draft_import
           
static boolean SAKAI_schedule_draft_import
           
static String SERVICE_NAME
          This string can be used to find the service in the service manager.
 
Method Summary
 String archive(String siteId)
          Create an archive for the resources of a site.
 String merge(String archiveUrl, String siteId, String siteCreatorId)
          Read in an archived set of resources, and merge the entries into the specified site, and set site creator name
 

Field Detail

SERVICE_NAME

public static final String SERVICE_NAME
This string can be used to find the service in the service manager.


FROM_CT

public static final String FROM_CT
A tag for the input system.

See Also:
Constant Field Values

FROM_WT

public static final String FROM_WT
See Also:
Constant Field Values

FROM_SAKAI

public static final String FROM_SAKAI
See Also:
Constant Field Values

SAKAI_msg_draft_import

public static final boolean SAKAI_msg_draft_import
See Also:
Constant Field Values

SAKAI_assign_draft_import

public static final boolean SAKAI_assign_draft_import
See Also:
Constant Field Values

SAKAI_rsc_draft_import

public static final boolean SAKAI_rsc_draft_import
See Also:
Constant Field Values

SAKAI_schedule_draft_import

public static final boolean SAKAI_schedule_draft_import
See Also:
Constant Field Values
Method Detail

archive

public String archive(String siteId)
Create an archive for the resources of a site.

Parameters:
siteId - The id of the site to archive.
Returns:
A log of messages from the archive.

merge

public String merge(String archiveUrl,
                    String siteId,
                    String siteCreatorId)
Read in an archived set of resources, and merge the entries into the specified site, and set site creator name

Parameters:
archiveUrl - The archive xml file Url.
siteId - The id of the site to merge the content into.
siteCreatorId - the site creator Id
Returns:
A log of messages from the merge.