com.sap.netweaver.kmc.expimp

Interface IPackage

All Known Subinterfaces:

IExportPackage, IImportPackage

public interface IPackage

Defines methods for accessing common properties of instances of IExportPackage and IImportPackage.
Methods for modifying these properties are contained in the corresponding sub interfaces.

These packages describe KM content as set of hierarchical resource trees each specified by its corresponding root RID.
Additionally, they contain some meta data like

• ID: uniquely identifies the package
• Name: display name, e.g for presentation in UIs
• Filter: several settings that filter resources in the resource trees

If several filter settings are specified, they are linked with boolean AND operator.

Copyright 2007 SAP AG

Nested Class Summary

static class

IPackage.State Enumeration of available states of a transport package.

Method Summary

String	getID() Returns the unique identifier of this transport package.
long	getMaxCreationDate() Gets the maximum creation date of a resource.
int	getMaxDepth() Gets the maximum depth for the recursion into collections.
long	getMaxModificationDate() Gets the maximum modification date of a resource.
int	getMaxSize() Gets the maximum size of a resource in KB.
long	getMinCreationDate() Gets the minimum creation date of a resource.
long	getMinModificationDate() Gets the minimum modification date of a resource.
int	getMinSize() Gets the minimum size of a resource in KB.
String	getName() Returns the name of this transport package.
String	getNameFilter() Gets the name filter defined as comma-separated wildcard expressions (e.g.
IRidIterator	getRIDs() Returns all root RIDs of the contained resource trees.
IPackage.State	getState() Gets the current processing state of this transport package.
boolean	isConstantIdExport() Returns if this package includes the constant IDs of KM resources.

Method Detail

getID

String getID()

Returns the unique identifier of this transport package.

Returns:

the unique identifier

getName

String getName()

Returns the name of this transport package.

Returns:

the name

getState

IPackage.State getState()

Gets the current processing state of this transport package.

Returns:

one of the constants in class IPackage.State

getRIDs

IRidIterator getRIDs()

Returns all root RIDs of the contained resource trees.
The resource trees are limited by the filter settings.

Returns:

an iterator returning all root RIDs

isConstantIdExport

boolean isConstantIdExport()

Returns if this package includes the constant IDs of KM resources.

Returns:

true if constant IDs are included, false otherwise

getNameFilter

String getNameFilter()

Gets the name filter defined as comma-separated wildcard expressions (e.g. *doc,*.txt) that are applied on resource identifiers.
Resources that do NOT match the name filter will be skipped.
Several wildcard expressions are linked with boolean OR operator.

NOTE: This filter is NOT applied on collections.

Returns:

the name filter (or null for unlimited)

getMaxDepth

int getMaxDepth()

Gets the maximum depth for the recursion into collections.
Level 0 contains only the collection resource itself, level 1 includes also direct children and so forth.

NOTE: This filter is only relevant for collections.

Returns:

the maximum depth (or -1 for unlimited)

getMinSize

int getMinSize()

Gets the minimum size of a resource in KB.
Resources that are smaller will be skipped.

NOTE: Not relevant for collections. Links are assumed to be of size zero.

Returns:

the minimum size (or -1 for unlimited)

getMaxSize

int getMaxSize()

Gets the maximum size of a resource in KB.
Resources that are bigger will be skipped.

NOTE: Not relevant for collections. Links are assumed to be of size zero.

Returns:

the maximum size (or -1 for unlimited)

getMinCreationDate

long getMinCreationDate()

Gets the minimum creation date of a resource.
Resources that have been created before this date will be skipped.

NOTE: Not relevant for collections.

Returns:

the minimum creation date (or -1 for unlimited)

getMaxCreationDate

long getMaxCreationDate()

Gets the maximum creation date of a resource.
Resources that have been created after this date will be skipped.

NOTE: Not relevant for collections.

Returns:

the maximum creation date (or -1 for unlimited)

getMinModificationDate

long getMinModificationDate()

Gets the minimum modification date of a resource.
Resources that have been modified before this date will be skipped.

NOTE: Not relevant for collections.

Returns:

the minimum modification date (or -1 for unlimited)

getMaxModificationDate

long getMaxModificationDate()

Gets the maximum modification date of a resource.
Resources that have been modified after this date will be skipped.

NOTE: Not relevant for collections.

Returns:

the maximum modification date (or -1 for unlimited)

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