com.sssw.rts.adminapi
Interface AgiAdmElementBase

All Known Subinterfaces:

AgiAdmCluster, AgiAdmClusterServer, AgiAdmContainer, AgiAdmDatabase, AgiAdmDesignElement, AgiAdmDirectory, AgiAdmEjbJar, AgiAdmElement, AgiAdmGroup, AgiAdmLBClusterEnv, AgiAdmLBContainer, AgiAdmLBElement, AgiAdmServer, AgiAdmStatContainer, AgiAdmStatElement, AgiAdmUser, AgiAdmUserReference, AgiDatabase, AgiServer

public interface AgiAdmElementBase

The base of the element hierarchy.

See Also:

AgiAdmLBElement

Method Summary

void	delete() Delete the element.
String	getName() Return the name of the element.
String	getType() Return the type of the element.

Method Detail

getName

public String getName()

Return the name of the element.

Parameters:

none -

Example:

 // Enumerate all the forms residing in the Forms directory and
 // print out their names.
 Enumeration e = formsDir.getChildren(AgiAdmContainer.GET_CHILDREN_SORTED);
 while(e.hasMoreElements())
 {
 	AgiAdmDesignElement form = (AgiAdmDesignElement)e.nextElement();
 	String name = form.getName();
 	System.out.println("Form " + name);
 }
 

getType

public String getType()

Return the type of the element.

Parameters:

none -

Usage:

Refer to the following list for a description of return values.

• SERVER is the server type of element AgiAdmServer
• DATABASE is the database type of element AgiAdmDatabase
• Design Element Types: AgiAdmDesignElement
• Directory Element Types: AgiAdmDirectory
• Group Element Types: AgiAdmGroup
• User Element Types: AgiAdmUser
• USER_REFERENCE is the User Reference (group member) type of element AgiAdmUserReference
• CLUSTER_ENV is the Cluster Environment type of a Load Balancing Container AgiAdmLBClusterEnv
• Load Balancing Element Types: AgiAdmLBElement
• Load Balancing Container Element Types: AgiAdmLBContainer

Example:

 AgiAdmElement el = ...
 String type = el.getType();
 

delete

public void delete()
            throws AgoUnrecoverableSystemException,
                   AgoSecurityException

Delete the element.

Example:

 // delete a particular SilverGroup
 AgiAdmGroup group = (AgiAdmGroup)server.getElement(
 	"myGroup", AgiAdmGroup.SILVERGROUP, null);
 group.delete();