com.vinculumtech.carrierwave.manager
Class GraphPlanRoot

java.lang.Object
  com.vinculumtech.carrierwave.manager.GraphPlanRoot

public final class GraphPlanRoot

extends java.lang.Object

The GraphPlanRoot class is the internal CarrierWave interface to the @{link PlanSourceRoot} class.

Version:

$Id: //depot/carrierwave/src/server/com/vinculumtech/carrierwave/manager/GraphPlanRoot.java#11 $

Method Summary

static int	getAuthorityValue()
static java.util.List	listGraphPlanNames()
static java.util.List	listGraphPlanNames(java.lang.String sourceName) Returns the names of all available GraphPlans (excluding versions) in the GraphPlanSource named sourceName.
static boolean	removeGraphPlan(java.lang.String graphPlanName) Remvoes the GraphPlan named graphPlanName from the default repository as specified by the authority value (typically 0).
static boolean	removeGraphPlan(java.lang.String sourceName, java.lang.String graphPlanName) Saves the given GraphPlan into the source with the given sourceName.
static GraphPlan	retrieveGraphPlan(java.lang.String graphPlanName) Returns a GraphPlan with the given graphPlanName from the repsoitory.
static void	setAuthorityValue(int authorityValue) Sets the current authority value.
static void	storeGraphPlan(GraphPlan graphPlan) Saves the given GraphPlan in the default repository as specified by the authority value (typically 0).
static void	storeGraphPlan(java.lang.String sourceName, GraphPlan graphPlan) Saves the given GraphPlan into the source with the given sourceName.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getAuthorityValue

public static final int getAuthorityValue()

Returns:

the current authority value

setAuthorityValue

public static final void setAuthorityValue(int authorityValue)

Sets the current authority value.

Parameters:

authorityValue -

retrieveGraphPlan

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

Returns a GraphPlan with the given graphPlanName from the repsoitory.

Parameters:

graphPlanName -

Returns:

Throws:

GraphPlanException - if GraphPlan instance could not be found

storeGraphPlan

public static final void storeGraphPlan(GraphPlan graphPlan)
                                 throws GraphPlanException

Saves the given GraphPlan in the default repository as specified by the authority value (typically 0).

Parameters:

graphPlan -

Throws:

GraphPlanException

storeGraphPlan

public static final void storeGraphPlan(java.lang.String sourceName,
                                        GraphPlan graphPlan)
                                 throws GraphPlanException

Saves the given GraphPlan into the source with the given sourceName.

Parameters:

sourceName -

graphPlan -

Throws:

GraphPlanException

removeGraphPlan

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

Remvoes the GraphPlan named graphPlanName from the default repository as specified by the authority value (typically 0).

Parameters:

graphPlanName -

Returns:

Throws:

GraphPlanException

removeGraphPlan

public static final boolean removeGraphPlan(java.lang.String sourceName,
                                            java.lang.String graphPlanName)
                                     throws GraphPlanException

Saves the given GraphPlan into the source with the given sourceName.

Parameters:

sourceName -

graphPlanName -

Returns:

Throws:

GraphPlanException

listGraphPlanNames

public static final java.util.List listGraphPlanNames(java.lang.String sourceName)
                                               throws GraphPlanException

Returns the names of all available GraphPlans (excluding versions) in the GraphPlanSource named sourceName. If sourceName is null, the authoritative source is queried.

Parameters:

sourceName -

Returns:

Throws:

GraphPlanException

listGraphPlanNames

public static final java.util.List listGraphPlanNames()
                                               throws GraphPlanException

Returns:

Throws:

GraphPlanException