com.tivoli.twg.cim
Class CIMEnumeration

java.lang.Object
  extended bycom.tivoli.twg.cim.CIMEnumeration
All Implemented Interfaces:
iCIMEnumeration

public class CIMEnumeration
extends java.lang.Object
implements iCIMEnumeration


Field Summary
 
Fields inherited from interface com.tivoli.twg.cim.iCIMEnumeration
ENUM_TYPE_CLASS, ENUM_TYPE_INSTANCE, ENUM_TYPE_METHOD, ENUM_TYPE_NAMESPACE, ENUM_TYPE_PROPERTY, ENUM_TYPE_QUALIFIER
 
Constructor Summary
CIMEnumeration()
           
 
Method Summary
protected  void CallBack(iCIMEnumerationResponse Owner, com.tivoli.twg.cim.CIMCommand cmd, java.lang.Object[] DataStore)
           
 void close()
          Force cleanup of object instead of waiting for Java Garbage collection
static CIMEnumeration createClassEnum(long MOID, java.lang.String NameSpace, aCIMClass Class, boolean Deep, iCIMEnumerationResponse Owner)
          Static method implementation of the createClassEnum call.
 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.
static CIMEnumeration createInstanceAssocEnum(long MOID, aCIMInstance Instance, java.lang.String AssocClass, java.lang.String ResultClass, java.lang.String Role, java.lang.String ResultRole, iCIMEnumerationResponse Owner)
          Static method implementation of the createInstanceEnum call.
 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.
static CIMEnumeration createInstanceEnum(long MOID, aCIMClass Class, boolean Deep, iCIMEnumerationResponse Owner)
          Static method implementation of the createInstanceEnum call.
 boolean createMethodEnum(aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Create an enumeration of methods within either a Class or an Instance.
static CIMEnumeration createMethodEnum(long MOID, aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Static method implementation of the createMethodEnum call.
 boolean createNameSpaceEnum(aCIMNameSpace NameSpace, boolean Deep, iCIMEnumerationResponse Owner)
          Create an enumeration of the Namespaces within the CIMOM.
static CIMEnumeration createNameSpaceEnum(long MOID, aCIMNameSpace NameSpace, boolean Deep, iCIMEnumerationResponse Owner)
          Static method implementation of the createNameSpaceEnum call.
 boolean createPropertyEnum(aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Create an enumeration of the properties within either a Class or an Instance.
static CIMEnumeration createPropertyEnum(long MOID, aCIMClass Class, aCIMInstance Instance, iCIMEnumerationResponse Owner)
          Static method implementation of the createInstanceEnum call.
 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.
static CIMEnumeration createQualifierEnum(long MOID, aCIMClass Class, aCIMProperty Property, iCIMEnumerationResponse Owner)
          Static method implementation of the createQualifierEnum call.
static CIMEnumeration createQualifierEnum(long MOID, aCIMClass Class, iCIMEnumerationResponse Owner)
          Static method implementation of the createQualifierEnum call.
 boolean currentElement(iCIMEnumerationResponse Owner)
          This method is used to acquire a reference to the object in the enumeration that the cursor currently points to.
protected  void currentElement(iCIMEnumerationResponse Owner, int Skip, boolean PreInc)
           
 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.
protected  void finalize()
           
 long GetMoid()
           
 boolean hasMoreElements()
          This method is used to determine if there are more elements remaining.
 boolean nextElement(iCIMEnumerationResponse Owner)
          This method is used to move the cursor ahead by the specified 'Count' elements.
 boolean reset(iCIMEnumerationResponse Owner)
          This method is used to reset a given enumeration cursor to the beginning.
 void SetMoid(long MOID)
           
 boolean skip(int Skip, iCIMEnumerationResponse Owner)
          This method is used to move the cursor ahead by the specified 'Count' elements.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CIMEnumeration

public CIMEnumeration()
Method Detail

close

public void close()
Force cleanup of object instead of waiting for Java Garbage collection


finalize

protected void finalize()
                 throws java.lang.Throwable
Throws:
java.lang.Throwable

createClassEnum

public static CIMEnumeration createClassEnum(long MOID,
                                             java.lang.String NameSpace,
                                             aCIMClass Class,
                                             boolean Deep,
                                             iCIMEnumerationResponse Owner)
Static method implementation of the createClassEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createClassEnum() for details on parameters


createInstanceEnum

public static CIMEnumeration createInstanceEnum(long MOID,
                                                aCIMClass Class,
                                                boolean Deep,
                                                iCIMEnumerationResponse Owner)
Static method implementation of the createInstanceEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createInstanceEnum() for details on parameters


createInstanceAssocEnum

public static CIMEnumeration createInstanceAssocEnum(long MOID,
                                                     aCIMInstance Instance,
                                                     java.lang.String AssocClass,
                                                     java.lang.String ResultClass,
                                                     java.lang.String Role,
                                                     java.lang.String ResultRole,
                                                     iCIMEnumerationResponse Owner)
Static method implementation of the createInstanceEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createInstanceAssocEnum() for details on parameters


createMethodEnum

public static CIMEnumeration createMethodEnum(long MOID,
                                              aCIMClass Class,
                                              aCIMInstance Instance,
                                              iCIMEnumerationResponse Owner)
Static method implementation of the createMethodEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createMethodEnum() for details on parameters


createPropertyEnum

public static CIMEnumeration createPropertyEnum(long MOID,
                                                aCIMClass Class,
                                                aCIMInstance Instance,
                                                iCIMEnumerationResponse Owner)
Static method implementation of the createInstanceEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createInstanceEnum() for details on parameters


createNameSpaceEnum

public static CIMEnumeration createNameSpaceEnum(long MOID,
                                                 aCIMNameSpace NameSpace,
                                                 boolean Deep,
                                                 iCIMEnumerationResponse Owner)
Static method implementation of the createNameSpaceEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createNameSpaceEnum() for details on parameters


createQualifierEnum

public static CIMEnumeration createQualifierEnum(long MOID,
                                                 aCIMClass Class,
                                                 iCIMEnumerationResponse Owner)
Static method implementation of the createQualifierEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createQualifierEnum() for details on parameters


createQualifierEnum

public static CIMEnumeration createQualifierEnum(long MOID,
                                                 aCIMClass Class,
                                                 aCIMProperty Property,
                                                 iCIMEnumerationResponse Owner)
Static method implementation of the createQualifierEnum call. It is provided as an ADVISED shortcut to create an instance of iCIMEnumeration.

See createQualifierEnum() for details on parameters


SetMoid

public void SetMoid(long MOID)

GetMoid

public long GetMoid()

enumSize

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

Specified by:
enumSize in interface iCIMEnumeration
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.

Specified by:
currentPosition in interface iCIMEnumeration
Returns:
int - Current cursor index, zero based.

NOTE: this method does NOT have an asyncronous response.


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.

Specified by:
currentElement in interface iCIMEnumeration
See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

currentElement

protected void currentElement(iCIMEnumerationResponse Owner,
                              int Skip,
                              boolean PreInc)

hasMoreElements

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

Specified by:
hasMoreElements in interface iCIMEnumeration
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, is NOT updated until one of those operations completes, that is the callback has been executed.


endEnum

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

Specified by:
endEnum in interface iCIMEnumeration
Returns:
boolean - true if the operation succeeds.

NOTE: this method does NOT have an asyncronous response.


reset

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

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

nextElement

public boolean nextElement(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.

Specified by:
nextElement in interface iCIMEnumeration
See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

skip

public boolean skip(int Skip,
                    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.

Specified by:
skip in interface iCIMEnumeration
See Also:
aCIMClass, aCIMInstance, aCIMMethod, aCIMProperty, aCIMError

CallBack

protected void CallBack(iCIMEnumerationResponse Owner,
                        com.tivoli.twg.cim.CIMCommand cmd,
                        java.lang.Object[] DataStore)

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.

Specified by:
createClassEnum in interface iCIMEnumeration
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

createNameSpaceEnum

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

Specified by:
createNameSpaceEnum in interface iCIMEnumeration
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

createInstanceEnum

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

Specified by:
createInstanceEnum in interface iCIMEnumeration
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.

Specified by:
createInstanceAssocEnum in interface iCIMEnumeration
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

createPropertyEnum

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

Specified by:
createPropertyEnum in interface iCIMEnumeration
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

createMethodEnum

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

Specified by:
createMethodEnum in interface iCIMEnumeration
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.

Specified by:
createQualifierEnum in interface iCIMEnumeration
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.

Specified by:
createQualifierEnum in interface iCIMEnumeration
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