eu.geclipse.core.model
Interface IVirtualOrganization

All Superinterfaces:

IGridContainer, IGridElement, IStorableElement

All Known Implementing Classes:

AbstractVirtualOrganization, GenericVirtualOrganization

public interface IVirtualOrganization
extends IGridContainer, IStorableElement

This is the base interface that all implementations of virtual organizations have to implement. It is basically a combination of IGridContainer since it may hold other elements (i.e. services) and IStorableElement since it is a persistent element that is stored as a preference.

Method Summary

IGridApplicationManager	getApplicationManager() Returns the IGridApplicationManager associated to this VO.
IGridResource[]	getAvailableResources(IGridResourceCategory category, boolean exclusive, IProgressMonitor monitor) Gets all available resources of the specified resource category.
java.lang.String	getId() Returns a unique identifier for the type of this VO.
IGridInfoService	getInfoService() Gets the info service of this VO.
IGridJobService[]	getJobSubmissionServices(IProgressMonitor monitor) Gets a list of all job submission services that are available for this virtual organization.
IGridResourceCategory[]	getSupportedCategories() Gets the resource categories that are supported by this VO.
java.lang.String	getTypeName() Returns a user-friendly string denoting the type of this VO.
java.lang.String	getWizardId() Returns the ID of the wizard which should be used to edit VOs of this type.
void	refreshResources(IGridResourceCategory category, IProgressMonitor monitor) Reload the resources of the specified category without taking any caching into account.

Methods inherited from interface eu.geclipse.core.model.IGridContainer

canContain, contains, create, delete, deleteAll, findChild, findChildWithResource, getChildCount, getChildren, hasChildren, isDirty, isLazy, refresh, setDirty

Methods inherited from interface eu.geclipse.core.model.IGridElement

dispose, getFileStore, getName, getParent, getPath, getProject, getResource, isHidden, isLocal, isVirtual

Methods inherited from interface eu.geclipse.core.model.IStorableElement

load, save

Methods inherited from interface eu.geclipse.core.model.IGridElement

dispose, getFileStore, getName, getParent, getPath, getProject, getResource, isHidden, isLocal, isVirtual

Method Detail

getSupportedCategories

IGridResourceCategory[] getSupportedCategories()

Gets the resource categories that are supported by this VO.

Returns:

The IGridResourceCategory instances supported by this VO.

getAvailableResources

IGridResource[] getAvailableResources(IGridResourceCategory category,
                                      boolean exclusive,
                                      IProgressMonitor monitor)
                                      throws ProblemException

Gets all available resources of the specified resource category.

Parameters:

category - The resource category.

exclusive - If true only resources are returned that directly match the specified category. Otherwise also resource are returned that match any child category of the specified resource category.

monitor - Use to monitor the progress.

Returns:

An array of available resources.

Throws:

ProblemException - If for any reason the resources could not be fetched from the underlying information service.

See Also:

IGridInfoService.fetchResources(IGridContainer, IVirtualOrganization, IGridResourceCategory, IProgressMonitor)

getInfoService

IGridInfoService getInfoService()
                                throws ProblemException

Gets the info service of this VO.

Returns:

The info service that can be queried for VO related information.

Throws:

ProblemException - If an error occurs while the service is fetched.

getJobSubmissionServices

IGridJobService[] getJobSubmissionServices(IProgressMonitor monitor)
                                           throws ProblemException

Gets a list of all job submission services that are available for this virtual organization.

Parameters:

monitor - Used to monitor the progress.

Returns:

A list of all currently available job submission services.

Throws:

ProblemException - If an error occurs while retrieving the services.

getApplicationManager

IGridApplicationManager getApplicationManager()

Returns the IGridApplicationManager associated to this VO.

Returns:

An IGridApplicationManager or null if this VO does not support application deployment.

getTypeName

java.lang.String getTypeName()

Returns a user-friendly string denoting the type of this VO. This string has to be a singleton for each implementation. So each object of a specific implementation has to return the same type name.

Returns:

An implementation-specific type name.

See Also:

getId()

getWizardId

java.lang.String getWizardId()

Returns the ID of the wizard which should be used to edit VOs of this type.

Returns:

ID of the wizard to edit the VO.

getId

java.lang.String getId()

Returns a unique identifier for the type of this VO.

Returns:

The name of the class implementing this interface.

See Also:

getTypeName()

refreshResources

void refreshResources(IGridResourceCategory category,
                      IProgressMonitor monitor)
                      throws ProblemException

Reload the resources of the specified category without taking any caching into account.

Parameters:

category - The resource category to be refreshed.

monitor - Used to monitor the progress.

Throws:

ProblemException - If an error occurs while refreshing the resources.