com.vinculumtech.carrierwave.plansource
Interface GraphPlanSource

All Known Implementing Classes:

ClientSessionGraphPlanSource, GraphPlanRepositorySource

public interface GraphPlanSource

Version:

$Id: //depot/carrierwave/src/shared/com/vinculumtech/carrierwave/plansource/GraphPlanSource.java#5 $

Method Summary

java.lang.Integer	getAuthorityOrder() Returns this GraphPlanSource instances authority value.
java.lang.String	getSourceDescription()
java.lang.String	getSourceName()
boolean	isReadOnly()
java.util.List	listGraphPlanNames() Returns a list of available graph plan names.
boolean	removeGraphPlan(java.lang.String graphPlanName) Removes the GraphPlan instance specified by the given graphPlanName
GraphPlan	retrieveGraphPlan(java.lang.String graphPlanName)
void	storeGraphPlan(GraphPlan graphPlan)

Method Detail

getSourceName

public java.lang.String getSourceName()

Returns:

the name of this GraphPlanSource instance

getSourceDescription

public java.lang.String getSourceDescription()

Returns:

a String describing this GraphPlanSource instance

retrieveGraphPlan

public GraphPlan retrieveGraphPlan(java.lang.String graphPlanName)
                            throws GraphPlanException

Parameters:

graphPlanName -

Returns:

the GraphPlan designaged by the given graphPlanName

Throws:

GraphPlanException

removeGraphPlan

public boolean removeGraphPlan(java.lang.String graphPlanName)
                        throws GraphPlanException

Removes the GraphPlan instance specified by the given graphPlanName

Parameters:

graphPlanName -

Returns:

true if the GraphPlan was found and removed, false otherwise

Throws:

GraphPlanException

storeGraphPlan

public void storeGraphPlan(GraphPlan graphPlan)
                    throws GraphPlanException

Parameters:

graphPlan - the GraphPlan instance to store

Throws:

GraphPlanException

listGraphPlanNames

public java.util.List listGraphPlanNames()
                                  throws GraphPlanException

Returns a list of available graph plan names.

Throws:

java.lang.UnsupportedOperationException - if this method is not implemented. Some sources may be unable to provide such functionality.

GraphPlanException

isReadOnly

public boolean isReadOnly()

Returns:

true if GraphPlan instances can not be stored or modifed in this GraphPlanSource instance

getAuthorityOrder

public java.lang.Integer getAuthorityOrder()

Returns this GraphPlanSource instances authority value. The higher the authority value, the higher in precedence a given source is queried for a given GraphPlan by name.

Returns:

the 'authority' value