com.tivoli.twg.dmi
Interface iDMIInterface

All Known Implementing Classes:
DMIInterface

public interface iDMIInterface

This interface is intended to provide all of the primitives necessary to implement the DMI V2.0 Interface. It is implemented as an asynchronous interface, where the caller is required to implement the iDMIResponse 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 iDMIResponse 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.

For a detailed description of the methods listed here that have a direct relationship to the DMI v2.0 interfaces, see the DMI V2.0 specification for operational details.

See Also:
iDMIResponse, DMIAttributeValue, DMI_MultiRow

Method Summary
 boolean DmiGetAttribute(iDMIResponse Owner, int CompID, int GroupID, int AttribID, DMIAttributeValue[] KeyList)
          This method will get the value for a single attribute as described in the DMI V2.0 specification.
 boolean DmiGetMultiple(iDMIResponse Owner, DMI_MultiRow[] Rows)
          This method will get the values for multiple attributes as described in the DMI V2.0 specification, as well as allow the listing of rows contained in tabluar groups.
 boolean DmiListAttributes(iDMIResponse Owner, boolean Next, int MaxCount, boolean GetPragma, boolean GetDescription, int CompID, int GroupID, int AttribID)
          This method will perform the attribute listing functions as described in the DMI V2.0 specification.
 boolean DmiListClassNames(iDMIResponse Owner, int MaxCount, int CompID)
          This method will list the Class Names contained by the given component as described in the DMI V2.0 specification.
 boolean DmiListComponents(iDMIResponse Owner, boolean Next, int MaxCount, boolean GetPragma, boolean GetDescription, int CompID)
          This method will perform the component listing functions as described in the DMI V2.0 specification.
 boolean DmiListComponentsByClass(iDMIResponse Owner, boolean Next, int MaxCount, boolean GetPragma, boolean GetDescription, int CompID, java.lang.String ClassName, DMIAttributeValue[] KeyList)
          This method will perform the component listing functions as described in the DMI V2.0 specification.
 boolean DmiListGroups(iDMIResponse Owner, boolean Next, int MaxCount, boolean GetPragma, boolean GetDescription, int CompID, int GroupID)
          This method will perform the group listing functions as described in the DMI V2.0 specification.
 boolean DmiListLanguages(iDMIResponse Owner, int MaxCount, int CompID)
          This method will list the Languages supported by the given component as described in the DMI V2.0 specification.
 boolean DmiSetAttribute(iDMIResponse Owner, int CompID, int GroupID, DMIAttributeValue[] KeyList, int SetMode, DMIAttributeValue Value)
          This method will set the value for a single attribute as described in the DMI V2.0 specification.
 boolean DmiSetMultiple(iDMIResponse Owner, int SetMode, DMI_MultiRow[] Rows)
          This method will set the values for multiple attributes as described in the DMI V2.0 specification.
 java.lang.String GetDescription()
          This method will return the Description of the DMI Provider on the client.
 java.lang.String GetFileTypeAsString(int x)
          This method will translate the file type id to the keyword string defined for it in the specification.
 int[] GetFileTypes()
          This method will return the FileTypes supported by DMI Provider on the client.
 java.lang.String GetSpecLevel()
          This method will return the Specification Level of the DMI Provider on the client.
 boolean isRegistered()
          This method is used to determine if the instance of iDMIInterface is "registered" with the client SP.
 void OverRideLocale(java.util.Locale Loc)
          This method will allow the user to override the Default locale used when asking the client SP for translatable strings.
 void ResetLocal()
          This method will allow the user to reset the Locale that is being used to query the client SP for translatable strings, to the default for the JVM that this instance of the interface is running in.
 

Method Detail

GetSpecLevel

public java.lang.String GetSpecLevel()
This method will return the Specification Level of the DMI Provider on the client.

Returns:
String - Specification level as returned by the SP

NOTE: this method does NOT have an asyncronous response.


GetDescription

public java.lang.String GetDescription()
This method will return the Description of the DMI Provider on the client.

Returns:
String - Description as returned by the SP

NOTE: this method does NOT have an asyncronous response.


GetFileTypes

public int[] GetFileTypes()
This method will return the FileTypes supported by DMI Provider on the client.

Returns:
int[] - Array of File Types supported on the Client SP

NOTE: this method does NOT have an asyncronous response.

See Also:
DMI_FileTypes

isRegistered

public boolean isRegistered()
This method is used to determine if the instance of iDMIInterface is "registered" with the client SP.

Returns:
boolean - true if registered

NOTE: this method does NOT have an asyncronous response.


OverRideLocale

public void OverRideLocale(java.util.Locale Loc)
This method will allow the user to override the Default locale used when asking the client SP for translatable strings. By default, the interface implementation should use the Default local for the JVM that it is running in.


ResetLocal

public void ResetLocal()
This method will allow the user to reset the Locale that is being used to query the client SP for translatable strings, to the default for the JVM that this instance of the interface is running in.

NOTE: this method does NOT have an asyncronous response.


GetFileTypeAsString

public java.lang.String GetFileTypeAsString(int x)
This method will translate the file type id to the keyword string defined for it in the specification.

Returns:
String

NOTE: this method does NOT have an asyncronous response.


DmiListComponents

public boolean DmiListComponents(iDMIResponse Owner,
                                 boolean Next,
                                 int MaxCount,
                                 boolean GetPragma,
                                 boolean GetDescription,
                                 int CompID)
This method will perform the component listing functions as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListComponent()

DmiListComponentsByClass

public boolean DmiListComponentsByClass(iDMIResponse Owner,
                                        boolean Next,
                                        int MaxCount,
                                        boolean GetPragma,
                                        boolean GetDescription,
                                        int CompID,
                                        java.lang.String ClassName,
                                        DMIAttributeValue[] KeyList)
This method will perform the component listing functions as described in the DMI V2.0 specification. The method additionally allows for filtering based on Group ClassName, and row key list.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListComponent()

DmiListGroups

public boolean DmiListGroups(iDMIResponse Owner,
                             boolean Next,
                             int MaxCount,
                             boolean GetPragma,
                             boolean GetDescription,
                             int CompID,
                             int GroupID)
This method will perform the group listing functions as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListGroup()

DmiListAttributes

public boolean DmiListAttributes(iDMIResponse Owner,
                                 boolean Next,
                                 int MaxCount,
                                 boolean GetPragma,
                                 boolean GetDescription,
                                 int CompID,
                                 int GroupID,
                                 int AttribID)
This method will perform the attribute listing functions as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListAttribute()

DmiListLanguages

public boolean DmiListLanguages(iDMIResponse Owner,
                                int MaxCount,
                                int CompID)
This method will list the Languages supported by the given component as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListLanguage()

DmiListClassNames

public boolean DmiListClassNames(iDMIResponse Owner,
                                 int MaxCount,
                                 int CompID)
This method will list the Class Names contained by the given component as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIListClasses()

DmiGetAttribute

public boolean DmiGetAttribute(iDMIResponse Owner,
                               int CompID,
                               int GroupID,
                               int AttribID,
                               DMIAttributeValue[] KeyList)
This method will get the value for a single attribute as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIGetResponse()

DmiSetAttribute

public boolean DmiSetAttribute(iDMIResponse Owner,
                               int CompID,
                               int GroupID,
                               DMIAttributeValue[] KeyList,
                               int SetMode,
                               DMIAttributeValue Value)
This method will set the value for a single attribute as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMISetResponse()

DmiGetMultiple

public boolean DmiGetMultiple(iDMIResponse Owner,
                              DMI_MultiRow[] Rows)
This method will get the values for multiple attributes as described in the DMI V2.0 specification, as well as allow the listing of rows contained in tabluar groups.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMIGetResponse()
See Also:
DMI_MultiRow

DmiSetMultiple

public boolean DmiSetMultiple(iDMIResponse Owner,
                              int SetMode,
                              DMI_MultiRow[] Rows)
This method will set the values for multiple attributes as described in the DMI V2.0 specification.

Returns:
boolean - success or failure of this request NOTE: The caller can consider the operation complete if it returns false, or when it receives a callback at the iDMIResponse method: Owner.DMISetResponse()
See Also:
DMI_MultiRow