com.novell.zos.grid
Interface GridObjectInfo

All Superinterfaces:

Serializable

public interface GridObjectInfo
extends Serializable

Client interface to any Grid Object.

All 'Info' objects are serializable.

Method Summary

String	getDisplayName() Retrieve the display name of this grid object.
Fact	getEffectiveFact(String factName) Retrieve an individual (effective) fact from this grid object.
FactSet	getEffectiveFacts() Retrieve the effective fact set for this grid object.
String	getEffectiveFactsAsPythonString() Retrieve the effective fact set for this grid object in native Python format.
ID	getID() Retrieve the ID of this grid object
String	getName() Retrieve the name (aka id) of this grid object.
String	getObjectType() Retrieve the type of this grid object.
String[]	getPolicyNames() Retrieve the String id names of policies associated with this object.
String	toXmlDocument() Return a formatted XML document representing the grid object.
String	toXmlDocument(int indent) Return a formatted and indented XML document representing the grid object.

Method Detail

getID

ID getID()

Retrieve the ID of this grid object

Returns:

the full grid object id

getName

String getName()

Retrieve the name (aka id) of this grid object.

Returns:

the name

getObjectType

String getObjectType()

Retrieve the type of this grid object.

Returns:

the type

getDisplayName

String getDisplayName()

Retrieve the display name of this grid object.

Returns:

the display name

getEffectiveFacts

FactSet getEffectiveFacts()

Retrieve the effective fact set for this grid object. The effective fact set is the collection of aggregated facts which includes the object's base fact set, associated policies, and facts from group membership.

Returns:

the factset

getEffectiveFact

Fact getEffectiveFact(String factName)

Retrieve an individual (effective) fact from this grid object.

Parameters:

factName - the full name of the fact required. E.g. 'resource.id'

Returns:

the Fact object or null if it is not found

getPolicyNames

String[] getPolicyNames()

Retrieve the String id names of policies associated with this object.

Returns:

the String[] of policy names associated with this object. Array can be empty.

toXmlDocument

String toXmlDocument()

Return a formatted XML document representing the grid object.

Returns:

the XML String representing the grid object.

toXmlDocument

String toXmlDocument(int indent)

Return a formatted and indented XML document representing the grid object.

Returns:

the XML String representing the grid object.

getEffectiveFactsAsPythonString

String getEffectiveFactsAsPythonString()

Retrieve the effective fact set for this grid object in native Python format. The effective fact set is the collection of aggregated facts which includes the object's base fact set, associated policies, and facts from group membership.

Returns:

the parseable Python String