com.sap.netweaver.kmc.expimp

Interface IExportPackage

All Superinterfaces:

IPackage

public interface IExportPackage
extends IPackage

Defines specific methods that only apply for export packages.

These methods offer modifications of information like

• Resource trees: resources trees specified by corresponding root RID
• Filter: several settings that filter resources in the resource trees

Additionally, an export package can be attached to a OTO/CTS transport.

Copyright 2007 SAP AG

Nested Class Summary

Nested classes/interfaces inherited from interface com.sap.netweaver.kmc.expimp.IPackage

IPackage.State

Method Summary

boolean	addRid(RID rid) Adds a new resource tree by specifying its root resource.
void	enableConstantIdExport(boolean enable) Enables/disables the export of constant IDs of KM resources.
ArchivePartIterator	getArchiveParts() Gets the parts of the generated archive containing the exported KM content.
String	getCTSNote() Gets the note that will be attached to the OTO/CTS transport.
com.sap.tc.di.draft.ts.TransportRequest	getCTSTransport() Gets the OTO/CTS transport this export package will be added to.
void	setCTSNote(String note) Sets the note that will be attached to the OTO/CTS transport.
void	setCTSTransport(com.sap.tc.di.draft.ts.TransportRequest request) Sets the OTO/CTS transport this export package will be added to.
void	setMaxCreationDate(long maxCreated) Sets the maximum creation date of a resource.
void	setMaxDepth(int maxDepth) Sets the maximum depth for the recursion into collections.
void	setMaxModificationDate(long maxModified) Sets the maximum modification date of a resource.
void	setMaxSize(int maxSize) Sets the maximum size of a resource.
void	setMinCreationDate(long minCreated) Sets the minimum creation date of a resource.
void	setMinModificationDate(long minModified) Sets the minimum modification date of a resource.
void	setMinSize(int minSize) Sets the minimum size of a resource.
void	setNameFilter(String nameFilter) Sets the name filter defined as comma-separated wildcard expressions (e.g.

Methods inherited from interface com.sap.netweaver.kmc.expimp.IPackage

getID, getMaxCreationDate, getMaxDepth, getMaxModificationDate, getMaxSize, getMinCreationDate, getMinModificationDate, getMinSize, getName, getNameFilter, getRIDs, getState, isConstantIdExport

Method Detail

addRid

boolean addRid(RID rid)

Adds a new resource tree by specifying its root resource.

Parameters:

rid - the RID of root resource

Returns:

true if rid could be successfully added, false if it is already included in this export package

See Also:

IPackage.getRIDs()

enableConstantIdExport

void enableConstantIdExport(boolean enable)

Enables/disables the export of constant IDs of KM resources.

Parameters:

enable - true if constant IDs have to be exported, false otherwise

See Also:

IPackage.isConstantIdExport()

setNameFilter

void setNameFilter(String nameFilter)

Sets the name filter defined as comma-separated wildcard expressions (e.g. *doc,*.txt) that are applied on resource identifiers.

Parameters:

nameFilter - the name filter (or null for unlimited)

See Also:

IPackage.getNameFilter()

setMaxDepth

void setMaxDepth(int maxDepth)

Sets the maximum depth for the recursion into collections.

Parameters:

maxDepth - the maximum depth (or -1 for unlimited)

See Also:

IPackage.getMaxDepth()

setMinSize

void setMinSize(int minSize)

Sets the minimum size of a resource.

Parameters:

minSize - the minimum size (or -1 for unlimited)

See Also:

IPackage.getMinSize()

setMaxSize

void setMaxSize(int maxSize)

Sets the maximum size of a resource.

Parameters:

maxSize - the maximum size (or -1 for unlimited)

See Also:

IPackage.getMaxSize()

setMinCreationDate

void setMinCreationDate(long minCreated)

Sets the minimum creation date of a resource.

Parameters:

minCreated - the minimum creation date (or -1 for unlimited)

See Also:

IPackage.getMinCreationDate()

setMaxCreationDate

void setMaxCreationDate(long maxCreated)

Sets the maximum creation date of a resource.

Parameters:

maxCreated - the maximum creation date (or -1 for unlimited)

See Also:

IPackage.getMaxCreationDate()

setMinModificationDate

void setMinModificationDate(long minModified)

Sets the minimum modification date of a resource.

Parameters:

minModified - the minimum modification date (or -1 for unlimited)

See Also:

IPackage.getMinModificationDate()

setMaxModificationDate

void setMaxModificationDate(long maxModified)

Sets the maximum modification date of a resource.

Parameters:

maxModified - the maximum modification date (or -1 for unlimited)

See Also:

IPackage.getMaxModificationDate()

getCTSTransport

com.sap.tc.di.draft.ts.TransportRequest getCTSTransport()

Gets the OTO/CTS transport this export package will be added to.

Returns:

the OTO/CTS transport (or null)

setCTSTransport

void setCTSTransport(com.sap.tc.di.draft.ts.TransportRequest request)

Sets the OTO/CTS transport this export package will be added to.

If the parameter request is set to null, this export will not be added to a OTO/CTS transport.

Parameters:

request - the OTO/CTS transport (or null)

getCTSNote

String getCTSNote()

Gets the note that will be attached to the OTO/CTS transport.

Returns:

the note (or null if non is available)

setCTSNote

void setCTSNote(String note)

Sets the note that will be attached to the OTO/CTS transport.

Parameters:

note - the note to be attached (or null if no note should be attached)

getArchiveParts

ArchivePartIterator getArchiveParts()

Gets the parts of the generated archive containing the exported KM content.
Due to size limitations the archive may have been split into several parts.

Returns:

an iterator providing the archive parts

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] KMC-CM	[sap.com] tc/km/frwk	api	EP-KM-CM
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM