com.bbn.swede.core.libraries
Class LibraryEdit

java.lang.Object
  extended bycom.bbn.swede.core.libraries.LibraryEdit

public class LibraryEdit
extends Object

This class represents a series of edits to a library. Edits can include files that were added to, or deleted from, the library, as well as metadata changes for any of the files in the library or the library itself, or indications that files should be updated from the web.

Author:
aperezlo

Field Summary
static int ADDITION
          Edit type constant indicating the addition of one or more entries.
static int CONFIGURATION
          Edit type constant indicating that the library's configuartion changed.
static int DELETION
          Edit type constant indicating the deletion of one or more entries.
static int LIBRARY_LEVEL
          Edit type constant.
static int REFRESH
          Edit type constant indicating that entries were refreshed.
 
Constructor Summary
LibraryEdit(ILibraryDescriptor library)
          Creates a library edit operation.
 
Method Summary
 void add(LibraryStructuralCompositeEdit lsce)
          Add this composite edit to this LibraryEdit.
 IStatus configure(IProgressMonitor monitor)
          Performs the configuration operations in this LibraryEdit upon the library supplied at object construction.
 IStatus perform(IProgressMonitor monitor)
          Performs the operations in this LibraryEdit upon the library supplied at object construction.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ADDITION

public static final int ADDITION
Edit type constant indicating the addition of one or more entries.

See Also:
Constant Field Values

DELETION

public static final int DELETION
Edit type constant indicating the deletion of one or more entries.

See Also:
Constant Field Values

REFRESH

public static final int REFRESH
Edit type constant indicating that entries were refreshed.

See Also:
Constant Field Values

CONFIGURATION

public static final int CONFIGURATION
Edit type constant indicating that the library's configuartion changed.

See Also:
Constant Field Values

LIBRARY_LEVEL

public static final int LIBRARY_LEVEL
Edit type constant.

See Also:
Constant Field Values
Constructor Detail

LibraryEdit

public LibraryEdit(ILibraryDescriptor library)
Creates a library edit operation.

Parameters:
library - The library with which this edit is associated
Method Detail

add

public void add(LibraryStructuralCompositeEdit lsce)
Add this composite edit to this LibraryEdit. Operations are performed in the order they were added.

Parameters:
lsce - a composite edit

perform

public IStatus perform(IProgressMonitor monitor)
Performs the operations in this LibraryEdit upon the library supplied at object construction.

This operation supports cancelation

Parameters:
monitor - an object to receive notifications of the progress of this operation
Returns:
IStatus.OK if the operation was a success, IStatus.CANCEL if it was canceled, and IStatus.ERROR otherwise

configure

public IStatus configure(IProgressMonitor monitor)
Performs the configuration operations in this LibraryEdit upon the library supplied at object construction.

This operation supports cancelation

Parameters:
monitor - an object to receive notifications of the progress of this operation
Returns:
IStatus.OK if the operation was a success, IStatus.CANCEL if it was canceled, and IStatus.ERROR otherwise


Copyright © 2004-2005 BBN Technologies. All Rights Reserved.