org.eclipse.soda.sat.core.record.container.interfaces
Interface IImportServiceRecordContainer

All Superinterfaces:

IServiceRecordContainer

public interface IImportServiceRecordContainer

extends IServiceRecordContainer

The IImportServiceRecordContainer interface declares the API for import service record containers. The following responsibilities are declared:

• Acquiring the contained import service records.
• Releasing the contained import service records.
• Adding an import service record.
• Removing an import service record.
• If the container is strict notifying the container's owner when:
  • All the contained import service records have been acquired.
  • All the contained import service records have previously been acquired, and then one of the contained import service records has been released.
• If the container is non-strict notifying the container's owner when:
  • Asked to acquire all of the contained import service records.
  • Each of the contained import service records is acquired.
  • Each of the contained import service records is released.
  • Asked to release all of the contained import service records.
• Querying whether all the contained import service records are acquired.

Note: Since this abstraction is used internally by the SAT bundle this interface is typically not used directly by bundle developers. For cases where subclassing the BaseBundleActivator is not appropriate, instances of this interface can be created using the FactoryUtility class.

Method Summary

void	acquire(IImportServiceRecordContainerOwner owner) Acquire all the contained import service records.
boolean	add(IImportServiceRecord record) Add an import service record to the container.
IImportServiceRecord	getWithFilter(String name, Filter filter) Get the record from the container with the matching service name and filter.
void	release() Releases the container's import service records.
boolean	remove(IImportServiceRecord record) Remove an import service record from the container.

Methods inherited from interface org.eclipse.soda.sat.core.record.container.interfaces.IServiceRecordContainer

contains, doForEach, empty, get, get, getAll, getAll, isEmpty, removeAll, size

Method Detail

acquire

public void acquire(IImportServiceRecordContainerOwner owner)

Acquire all the contained import service records.

Parameters:

owner - The owner of the container.

add

public boolean add(IImportServiceRecord record)

Add an import service record to the container.

Parameters:

record - The import service record to add.

Returns:

True if the record was added, otherwise false.

getWithFilter

public IImportServiceRecord getWithFilter(String name,
                                          Filter filter)

Get the record from the container with the matching service name and filter.

Parameters:

name - The name of a service.

filter - An LDP filter.

Returns:

The record matching the specified service name and filter, or null if no match is found.

release

public void release()

Releases the container's import service records.

remove

public boolean remove(IImportServiceRecord record)

Remove an import service record from the container. Once removed, an acquired record is released.

Parameters:

record - The import service record to remove.

Returns:

True if the record was removed, otherwise false.