com.siviam.bobup.businessobjects
Interface IBusinessObjectDescriptor

All Superinterfaces:

IBackupLocation

All Known Implementing Classes:

JarBusinessObjectDescriptor

public interface IBusinessObjectDescriptor

extends IBackupLocation

The business object descriptor is an object describing the business object. It contains, among other things, an object identifier, a user friendly display name.

There should be only one instance of a business object descriptor within the backup part list, though this is not strictly enforced. If there are multiple descriptors, later descriptors will replace previous ones.

Author:

vishnu

Field Summary

static java.lang.String	BUSINESS_OBJECT_DESCRIPTION
static java.lang.String	BUSINESS_OBJECT_ID
static java.lang.String	BUSINESS_OBJECT_NAME

Method Summary

void	addBackupPartDescription(java.util.Properties properties) Adds the description of the backup part in the form of name/value properties.
java.util.Properties[]	getBackupPartDescriptions() Obtains an array of backup part descriptions.
void	removeBackupPartDescription(java.util.Properties properties) Removes the description of the backup part given a properties instance.

Methods inherited from interface com.siviam.bobup.location.IBackupLocation

create, exists, getBackupWindow, getInputStream, getLastModified, getLocation, getOutputStream, listContents

Field Detail

BUSINESS_OBJECT_ID

public static final java.lang.String BUSINESS_OBJECT_ID

See Also:

Constant Field Values

BUSINESS_OBJECT_NAME

public static final java.lang.String BUSINESS_OBJECT_NAME

See Also:

Constant Field Values

BUSINESS_OBJECT_DESCRIPTION

public static final java.lang.String BUSINESS_OBJECT_DESCRIPTION

See Also:

Constant Field Values

Method Detail

addBackupPartDescription

public void addBackupPartDescription(java.util.Properties properties)
                              throws java.lang.Exception

Adds the description of the backup part in the form of name/value properties.

Parameters:

properties -

Throws:

java.lang.Exception

removeBackupPartDescription

public void removeBackupPartDescription(java.util.Properties properties)
                                 throws java.lang.Exception

Removes the description of the backup part given a properties instance.

Parameters:

properties -

Throws:

java.lang.Exception

getBackupPartDescriptions

public java.util.Properties[] getBackupPartDescriptions()
                                                 throws java.lang.Exception

Obtains an array of backup part descriptions. Use and addXXX() method to add properties first. All these properties will be recorded to the backup. There is one-one correlation between an element in this array and a backup part.

Returns:

Throws:

java.lang.Exception