com.ibm.tivoli.maximo.util.mboadapter

Interface MboAdapter

All Known Implementing Classes:

ServerMboAdapter

public interface MboAdapter

Base interface for the MBO adapter classes. This is the common contract that the adapter classes must obey and translate to the specific implementations. The purpose of this is to abstract the differences between traditional (server-side) MBOs and mobile MBOs, allowing us to write code that can be executed in both frameworks. The method names have been chosen to be as close as possible to the corresponding ones in the server Mbo class. Note about exception handling Since the server-side MXException and the mobile com.mro.mobile.MobileApplicationException have no common ancestor besides Exception, all methods are declared as throwing Exception. The specific client can compensate for this loss of type-safety with a special sequence of catch statements. On the mobile side, it looks like this:

    try {
                ...
    }
    catch (MobileApplicationException me) { throw me; }
    catch (RuntimeException rte) { throw rte; }
    catch (Exception e) {
                e.printStackTrace();
                throw new MobileApplicationException("internalerror", e); 
    }
 

And on the server side:

    try {
                ...
    }
    catch (MXException mxe) { throw mxe; }
    catch (RemoteException re) { throw re; }
    catch (RuntimeException rte) { throw rte; }
    catch (Exception e) {
                throw new MXSystemException("system", "unknownerror", e); 
    }
 

The idea is that the exception types will be treated as if we had the normal method signatures:

• Application exceptions (MobileApplicationException and MXException) and RemoteExceptions are reaised until the framework handles them;
• Unexpected runtime exceptions (such as a NullPoiterException) are also raised as they would normally be;
• We also have a generic Exception catch to satisfy the compiler, but it should never execute.

Author:

Cristiano Breuel

See Also:

MboSetAdapter

Method Summary

Methods

Modifier and Type	Method and Description
boolean	getBoolean(java.lang.String attributeName) Returns the boolean value of the attribute.
java.util.Date	getDate(java.lang.String attributeName)
int	getInt(java.lang.String attributeName)
boolean	getMaxVarBoolean(java.lang.String maxvarName)
int	getMaxVarInt(java.lang.String maxvarName)
java.lang.String	getMaxVarString(java.lang.String maxvarName)
MboSetAdapter	getMboSet(java.lang.String relationshipName)
java.lang.String	getName()
java.lang.String	getString(java.lang.String attributeName)
MboSetAdapter	getThisMboSet()
boolean	isNull(java.lang.String attributeName)
boolean	isReadOnly(java.lang.String attributeName)
java.lang.Exception	newApplicationException(java.lang.String group, java.lang.String key) Builds a new Application Exception of the appropriate type for the platform (server or mobile).
java.lang.Exception	newApplicationException(java.lang.String group, java.lang.String key, java.lang.Object[] params) Builds a new Application Exception of the appropriate type for the platform (server or mobile).
void	setReadOnly(java.lang.String attributeName, boolean readOnly)
void	setValue(java.lang.String attributeName, boolean value)
void	setValue(java.lang.String attributeName, boolean value, long flags)
void	setValue(java.lang.String attributeName, java.util.Date value)
void	setValue(java.lang.String attributeName, java.util.Date value, long flags)
void	setValue(java.lang.String attributeName, int value)
void	setValue(java.lang.String attributeName, int value, long flags)
void	setValue(java.lang.String attributeName, java.lang.String value)
void	setValue(java.lang.String attributeName, java.lang.String value, long flags)
void	setValueIfDifferent(java.lang.String attributeName, boolean value)
void	setValueIfDifferent(java.lang.String attributeName, boolean value, long flags)
boolean	toBeDeleted() Whether this MBO is marked for deletion.

Method Detail

getMboSet

MboSetAdapter getMboSet(java.lang.String relationshipName)
                        throws java.lang.Exception

Throws:

java.lang.Exception

getThisMboSet

MboSetAdapter getThisMboSet()
                            throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            java.lang.String value)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            java.lang.String value,
            long flags)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            boolean value)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            boolean value,
            long flags)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValueIfDifferent

void setValueIfDifferent(java.lang.String attributeName,
                       boolean value)
                         throws java.lang.Exception

Throws:

java.lang.Exception

setValueIfDifferent

void setValueIfDifferent(java.lang.String attributeName,
                       boolean value,
                       long flags)
                         throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            int value)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            int value,
            long flags)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            java.util.Date value)
              throws java.lang.Exception

Throws:

java.lang.Exception

setValue

void setValue(java.lang.String attributeName,
            java.util.Date value,
            long flags)
              throws java.lang.Exception

Throws:

java.lang.Exception

getString

java.lang.String getString(java.lang.String attributeName)
                           throws java.lang.Exception

Throws:

java.lang.Exception

getBoolean

boolean getBoolean(java.lang.String attributeName)
                   throws java.lang.Exception

Returns the boolean value of the attribute. If it is null, returns false.

Throws:

java.lang.Exception

getInt

int getInt(java.lang.String attributeName)
           throws java.lang.Exception

Throws:

java.lang.Exception

getDate

java.util.Date getDate(java.lang.String attributeName)
                       throws java.lang.Exception

Throws:

java.lang.Exception

isNull

boolean isNull(java.lang.String attributeName)
               throws java.lang.Exception

Throws:

java.lang.Exception

isReadOnly

boolean isReadOnly(java.lang.String attributeName)
                   throws java.lang.Exception

Throws:

java.lang.Exception

setReadOnly

void setReadOnly(java.lang.String attributeName,
               boolean readOnly)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getName

java.lang.String getName()
                         throws java.lang.Exception

Throws:

java.lang.Exception

newApplicationException

java.lang.Exception newApplicationException(java.lang.String group,
                                          java.lang.String key,
                                          java.lang.Object[] params)

Builds a new Application Exception of the appropriate type for the platform (server or mobile). Important: for Mobile, the group and key are concatenated with an underscore to form the message key, e.g., if group is "g" and key is "k", the mobile key is "g_k".

Parameters:

group - message group id

key - message key id

params - message parameters

Returns:

new Exception with the given arguments

newApplicationException

java.lang.Exception newApplicationException(java.lang.String group,
                                          java.lang.String key)

Builds a new Application Exception of the appropriate type for the platform (server or mobile). Important: for Mobile, the group and key are concatenated with an underscore to form the message key, e.g., if group is "g" and key is "k", the mobile key is "g_k".

Parameters:

group - message group id

key - message key id

Returns:

new Exception with the given arguments

getMaxVarString

java.lang.String getMaxVarString(java.lang.String maxvarName)
                                 throws java.lang.Exception

Throws:

java.lang.Exception

getMaxVarInt

int getMaxVarInt(java.lang.String maxvarName)
                 throws java.lang.Exception

Throws:

java.lang.Exception

getMaxVarBoolean

boolean getMaxVarBoolean(java.lang.String maxvarName)
                         throws java.lang.Exception

Throws:

java.lang.Exception

toBeDeleted

boolean toBeDeleted()

Whether this MBO is marked for deletion.

See Also:

psdi.mbo.MboRemote.toBeDeleted()