com.dtolabs.rundeck.core.common
Interface IFrameworkResourceParent

All Superinterfaces:
IFrameworkResource
All Known Subinterfaces:
IFrameworkProjectMgr
All Known Implementing Classes:
Framework, FrameworkProject, FrameworkProjectMgr, FrameworkResourceParent

public interface IFrameworkResourceParent
extends IFrameworkResource

a set of interfaces for managing child IFrameworkResource instances. Each child is keyed by its name.


Method Summary
 boolean childCouldBeLoaded(java.lang.String name)
          Return true if the child resource could be loaded from a file resource
 IFrameworkResource createChild(java.lang.String name)
          Create a new FrameworkResource child.
 boolean existsChild(java.lang.String name)
          Checks if a child by that name exists
 boolean existsChildResourceDirectory(java.lang.String name)
          Checks if a child's base dir exists
 IFrameworkResource getChild(java.lang.String name)
          Gets specified child
 void initialize()
          initialize the parent.
 java.util.Collection listChildNames()
          List all child names.
 java.util.Collection listChildren()
          List all children.
 IFrameworkResource loadChild(java.lang.String name)
          Load a specified child by name, returning null if it does not exist
 void remove(java.lang.String name)
          Remove the child's base directory
 
Methods inherited from interface com.dtolabs.rundeck.core.common.IFrameworkResource
getBaseDir, getName, getParent, isValid
 

Method Detail

createChild

IFrameworkResource createChild(java.lang.String name)
Create a new FrameworkResource child.

Parameters:
name - name of child
Returns:
new child

getChild

IFrameworkResource getChild(java.lang.String name)
Gets specified child

Parameters:
name - Name of child
Returns:
child instance

existsChild

boolean existsChild(java.lang.String name)
Checks if a child by that name exists

Parameters:
name - key to lookup child
Returns:
true if a child by that name exists

childCouldBeLoaded

boolean childCouldBeLoaded(java.lang.String name)
Return true if the child resource could be loaded from a file resource

Parameters:
name -
Returns:

loadChild

IFrameworkResource loadChild(java.lang.String name)
Load a specified child by name, returning null if it does not exist

Parameters:
name -
Returns:

listChildren

java.util.Collection listChildren()
List all children.

Returns:
A Collection of IFrameworkResource children

listChildNames

java.util.Collection listChildNames()
List all child names.

Returns:
A Collection of Strings

remove

void remove(java.lang.String name)
Remove the child's base directory

Parameters:
name - Name of child

initialize

void initialize()
initialize the parent. This may ask it to load in all children


existsChildResourceDirectory

boolean existsChildResourceDirectory(java.lang.String name)
Checks if a child's base dir exists

Parameters:
name - name of child
Returns:
true if it exists