com.tivoli.twg.cim
Interface iCIMEnumeration

All Known Implementing Classes:
CIMEnumeration

public interface iCIMEnumeration

This interface is intended to provide all of the primitives necessary to implement the enumeration functions required for CIM. It is implemented as an asynchronous interface, where the caller is required to implement the iCIMEnumerationResponse interface. All primitives, except where specified otherwise, will be considered complete when either the method returns false, or the method returns true and the proper method in the iCIMEnumerationResponse interface is called.

This interface is intended to be implementation neutral, leaving specific environmental concerns as an exercise for the implementor. It is the intention of this design, that any such implementation specific details be kept hidden from the user, and the integrity of this interface be preserved.

See Also:
iCIMEnumerationResponse, aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

Field Summary
static int ENUM_TYPE_CLASS
           
static int ENUM_TYPE_INSTANCE
           
static int ENUM_TYPE_METHOD
           
static int ENUM_TYPE_NAMESPACE
           
static int ENUM_TYPE_PROPERTY
           
static int ENUM_TYPE_QUALIFIER
           
 
Method Summary
 boolean createClassEnum(java.lang.String NameSpace, aCIMClass Class, boolean Deep, iCIMEnumerationResponse Owner)
          Create an enumeration of CIM Classes that begin within the specified name space.
 boolean createInstanceAssocEnum(java.lang.String NameSpace, java.lang.String Instance, java.lang.String AssocClass, java.lang.String ResultClass, java.lang.String Role, java.lang.String ResultRole, iCIMEnumerationResponse Owner)
          Create an enumeration of instances of a result of this association operation.
 boolean createInstanceEnum(aCIMClass Class, boolean Deep, iCIMEnumerationResponse Owner)
          Create an enumeration of instances of a given CIM Class.
 boolean createMethodEnum(aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Create an enumeration of methods within either a Class or an Instance.
 boolean createNameSpaceEnum(aCIMNameSpace NameSpace, boolean Deep, iCIMEnumerationResponse Owner)
          Create an enumeration of the Namespaces within the CIMOM.
 boolean createPropertyEnum(aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Create an enumeration of the properties within either a Class or an Instance.
 boolean createQualifierEnum(aCIMClass Class, aCIMProperty Property, iCIMEnumerationResponse Owner)
          Create an enumeration of the Qualifiers for either a Class or a property.
 boolean createQualifierEnum(aCIMClass Class, iCIMEnumerationResponse Owner)
          Create an enumeration of the Qualifiers for either a Class or a property.
 boolean currentElement(iCIMEnumerationResponse Owner)
          This method is used to acquire a reference to the object in the enumeration that the cursor currently points to.
 int currentPosition()
          This method will return the current zero based position of the cursor.
 boolean endEnum()
          This method is used to terminate the current enumeration.
 int enumSize()
          This method returns the total number of elements contained in this enumeration.
 boolean hasMoreElements()
          This method is used to determine if there are more elements remaining.
 boolean nextElement(iCIMEnumerationResponse Owner)
          This method is used to acquire a reference to the next object in the enumeration.
 boolean reset(iCIMEnumerationResponse Owner)
          This method is used to reset a given enumeration cursor to the beginning.
 boolean skip(int Count, iCIMEnumerationResponse Owner)
          This method is used to move the cursor ahead by the specified 'Count' elements.
 

Field Detail

ENUM_TYPE_CLASS

public static final int ENUM_TYPE_CLASS
See Also:
Constant Field Values

ENUM_TYPE_INSTANCE

public static final int ENUM_TYPE_INSTANCE
See Also:
Constant Field Values

ENUM_TYPE_METHOD

public static final int ENUM_TYPE_METHOD
See Also:
Constant Field Values

ENUM_TYPE_PROPERTY

public static final int ENUM_TYPE_PROPERTY
See Also:
Constant Field Values

ENUM_TYPE_NAMESPACE

public static final int ENUM_TYPE_NAMESPACE
See Also:
Constant Field Values

ENUM_TYPE_QUALIFIER

public static final int ENUM_TYPE_QUALIFIER
See Also:
Constant Field Values
Method Detail

createClassEnum

public boolean createClassEnum(java.lang.String NameSpace,
                               aCIMClass Class,
                               boolean Deep,
                               iCIMEnumerationResponse Owner)
Create an enumeration of CIM Classes that begin within the specified name space.

Returns:
boolean - true if successful

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createInstanceEnum

public boolean createInstanceEnum(aCIMClass Class,
                                  boolean Deep,
                                  iCIMEnumerationResponse Owner)
Create an enumeration of instances of a given CIM Class.

Returns:
boolean - true if successful

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createInstanceAssocEnum

public boolean createInstanceAssocEnum(java.lang.String NameSpace,
                                       java.lang.String Instance,
                                       java.lang.String AssocClass,
                                       java.lang.String ResultClass,
                                       java.lang.String Role,
                                       java.lang.String ResultRole,
                                       iCIMEnumerationResponse Owner)
Create an enumeration of instances of a result of this association operation.

Returns:
boolean - true if successful

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createMethodEnum

public boolean createMethodEnum(aCIMClass Class,
                                aCIMInstance Instance,
                                iCIMEnumerationResponse Owner)
Create an enumeration of methods within either a Class or an Instance.

Returns:
boolean - Returns True if the operation could be initiated.

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createPropertyEnum

public boolean createPropertyEnum(aCIMClass Class,
                                  aCIMInstance Instance,
                                  iCIMEnumerationResponse Owner)
Create an enumeration of the properties within either a Class or an Instance.

Returns:
boolean - Returns True if the operation could be initiated.

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createNameSpaceEnum

public boolean createNameSpaceEnum(aCIMNameSpace NameSpace,
                                   boolean Deep,
                                   iCIMEnumerationResponse Owner)
Create an enumeration of the Namespaces within the CIMOM.

Returns:
boolean - Returns True if the operation could be initiated.

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createQualifierEnum

public boolean createQualifierEnum(aCIMClass Class,
                                   iCIMEnumerationResponse Owner)
Create an enumeration of the Qualifiers for either a Class or a property.

Returns:
boolean - Returns True if the operation could be initiated.

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

createQualifierEnum

public boolean createQualifierEnum(aCIMClass Class,
                                   aCIMProperty Property,
                                   iCIMEnumerationResponse Owner)
Create an enumeration of the Qualifiers for either a Class or a property.

Returns:
boolean - Returns True if the operation could be initiated.

NOTE: The user can expect to be able to use this enumeration once a response is received at the Owner.enumReady() interface method.

See Also:
aCIMError

endEnum

public boolean endEnum()
This method is used to terminate the current enumeration.

Returns:
boolean - true if the operation succeeds.

NOTE: this method does NOT have an asyncronous response.


enumSize

public int enumSize()
This method returns the total number of elements contained in this enumeration.

Returns:
int - The number of elements contained in the enumeration

NOTE: this method does NOT have an asyncronous response.


currentPosition

public int currentPosition()
This method will return the current zero based position of the cursor.

Returns:
int - Current cursor index, zero based.

NOTE: this method does NOT have an asyncronous response.


hasMoreElements

public boolean hasMoreElements()
This method is used to determine if there are more elements remaining.

Returns:
boolean - True if there are more elements in this enumeration.

NOTE: this method does NOT have an asyncronous response.

NOTE: It is important to keep in mind that any of the methods used to iterate through this enumeration such as nextElement() and skip() complete asynchronously. The cursor used to determine if there are more elements to iterate through, may not be updated until one of those operations completes, that is the callback has been executed.


reset

public boolean reset(iCIMEnumerationResponse Owner)
This method is used to reset a given enumeration cursor to the beginning.

Returns:
boolean Returns 'true' if the reset request was successful, 'false' otherwise.
See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

skip

public boolean skip(int Count,
                    iCIMEnumerationResponse Owner)
This method is used to move the cursor ahead by the specified 'Count' elements. If the value of 'Count' exceeds the number of elements remaining, then the method returns false, and the cursor is NOT moved.

See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

currentElement

public boolean currentElement(iCIMEnumerationResponse Owner)
This method is used to acquire a reference to the object in the enumeration that the cursor currently points to.

See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

nextElement

public boolean nextElement(iCIMEnumerationResponse Owner)
This method is used to acquire a reference to the next object in the enumeration.

See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError