alma.asdm.HistoryRow

alma.asdm.HistoryRow Class Reference

Inherits alma.asdm.ASDMRow.

List of all members.

Detailed Description

The HistoryRow class is a row of a HistoryTable.

Generated from model's revision 1.41, branch HEAD


Public Member Functions

HistoryTable getTable ()
 Return the table to which this row belongs.
HistoryRowIDL toIDL ()
 Return this row in the form of an IDL struct.
void setFromIDL (HistoryRowIDL x) throws ConversionException
 Fill the values of this row from the IDL struct HistoryRowIDL.
String toXML () throws ConversionException
 Return this row in the form of an XML string.
void setFromXML (String rowDoc) throws ConversionException
 Fill the values of this row from an XML string that was produced by the toXML() method.
ArrayTime getTime ()
 Get time.
void setTime (ArrayTime time) throws IllegalAccessException
 Set time with the specified ArrayTime value.
String getMessage ()
 Get message.
void setMessage (String message)
 Set message with the specified String value.
String getPriority ()
 Get priority.
void setPriority (String priority)
 Set priority with the specified String value.
String getOrigin ()
 Get origin.
void setOrigin (String origin)
 Set origin with the specified String value.
String getObjectId ()
 Get objectId.
void setObjectId (String objectId)
 Set objectId with the specified String value.
String getApplication ()
 Get application.
void setApplication (String application)
 Set application with the specified String value.
String getCliCommand ()
 Get cliCommand.
void setCliCommand (String cliCommand)
 Set cliCommand with the specified String value.
String getAppParms ()
 Get appParms.
void setAppParms (String appParms)
 Set appParms with the specified String value.
Tag getExecBlockId ()
 Get execBlockId.
void setExecBlockId (Tag execBlockId) throws IllegalAccessException
 Set execBlockId with the specified Tag value.
ExecBlockRow getExecBlockUsingExecBlockId ()
 Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.
boolean compareNoAutoInc (Tag execBlockId, ArrayTime time, String message, String priority, String origin, String objectId, String application, String cliCommand, String appParms)
 Compare each attribute except the autoincrementable one of this HistoryRow with the corresponding parameters and return true if there is a match and false otherwise.
boolean equalByRequiredValue (HistoryRow x)
 Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.
boolean compareRequiredValue (String message, String priority, String origin, String objectId, String application, String cliCommand, String appParms)

Package Functions

 HistoryRow (HistoryTable table)
 Create a HistoryRow.
 HistoryRow (HistoryTable table, HistoryRow row)
 Creates a HistoryRow using a copy constructor mechanism.
void isAdded ()
Object[] getAttributesValues ()
 Returns all the attributes of an attribute of an ASDM table as an array of Object.

Constructor & Destructor Documentation

alma.asdm.HistoryRow.HistoryRow ( HistoryTable  table  )  [package]

Create a HistoryRow.

This constructor has package access because only the table can create rows. All rows know the table to which they belong.

Parameters:
table The table to which this row belongs.

alma.asdm.HistoryRow.HistoryRow ( HistoryTable  table,
HistoryRow  row 
) [package]

Creates a HistoryRow using a copy constructor mechanism.

Given a HistoryRow row and a HistoryTable table, the method creates a new HistoryRow owned by table. Each attribute of the created row is a copy (deep) of the corresponding attribute of row. The method does not add the created row to its table, its simply parents it to table, a call to the add method has to be done in order to get the row added (very likely after having modified some of its attributes). If row is null then the method returns a row with default values for its attributes.

This constructor has package access because only the table can create rows. All rows know the table to which they belong.

Parameters:
table The table to which this row belongs.
row The row which is to be copied.

Member Function Documentation

HistoryRowIDL alma.asdm.HistoryRow.toIDL (  ) 

Return this row in the form of an IDL struct.

Returns:
The values of this row as a HistoryRowIDL struct.

void alma.asdm.HistoryRow.setFromIDL ( HistoryRowIDL  x  )  throws ConversionException

Fill the values of this row from the IDL struct HistoryRowIDL.

Parameters:
x The IDL struct containing the values used to fill this row.

String alma.asdm.HistoryRow.toXML (  )  throws ConversionException

Return this row in the form of an XML string.

Returns:
The values of this row as an XML string.
Exceptions:
ConversionException. 

void alma.asdm.HistoryRow.setFromXML ( String  rowDoc  )  throws ConversionException

Fill the values of this row from an XML string that was produced by the toXML() method.

Parameters:
x The XML string being used to set the values of this row.
Exceptions:
ConversionException. 

ArrayTime alma.asdm.HistoryRow.getTime (  ) 

Get time.

Returns:
time as ArrayTime

void alma.asdm.HistoryRow.setTime ( ArrayTime  time  )  throws IllegalAccessException

Set time with the specified ArrayTime value.

Parameters:
time The ArrayTime value to which time is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

String alma.asdm.HistoryRow.getMessage (  ) 

Get message.

Returns:
message as String

void alma.asdm.HistoryRow.setMessage ( String  message  ) 

Set message with the specified String value.

Parameters:
message The String value to which message is to be set.

String alma.asdm.HistoryRow.getPriority (  ) 

Get priority.

Returns:
priority as String

void alma.asdm.HistoryRow.setPriority ( String  priority  ) 

Set priority with the specified String value.

Parameters:
priority The String value to which priority is to be set.

String alma.asdm.HistoryRow.getOrigin (  ) 

Get origin.

Returns:
origin as String

void alma.asdm.HistoryRow.setOrigin ( String  origin  ) 

Set origin with the specified String value.

Parameters:
origin The String value to which origin is to be set.

String alma.asdm.HistoryRow.getObjectId (  ) 

Get objectId.

Returns:
objectId as String

void alma.asdm.HistoryRow.setObjectId ( String  objectId  ) 

Set objectId with the specified String value.

Parameters:
objectId The String value to which objectId is to be set.

String alma.asdm.HistoryRow.getApplication (  ) 

Get application.

Returns:
application as String

void alma.asdm.HistoryRow.setApplication ( String  application  ) 

Set application with the specified String value.

Parameters:
application The String value to which application is to be set.

String alma.asdm.HistoryRow.getCliCommand (  ) 

Get cliCommand.

Returns:
cliCommand as String

void alma.asdm.HistoryRow.setCliCommand ( String  cliCommand  ) 

Set cliCommand with the specified String value.

Parameters:
cliCommand The String value to which cliCommand is to be set.

String alma.asdm.HistoryRow.getAppParms (  ) 

Get appParms.

Returns:
appParms as String

void alma.asdm.HistoryRow.setAppParms ( String  appParms  ) 

Set appParms with the specified String value.

Parameters:
appParms The String value to which appParms is to be set.

Tag alma.asdm.HistoryRow.getExecBlockId (  ) 

Get execBlockId.

Returns:
execBlockId as Tag

void alma.asdm.HistoryRow.setExecBlockId ( Tag  execBlockId  )  throws IllegalAccessException

Set execBlockId with the specified Tag value.

Parameters:
execBlockId The Tag value to which execBlockId is to be set.
Exceptions:
IllegalAccessException If an attempt is made to change this field after is has been added to the table.

ExecBlockRow alma.asdm.HistoryRow.getExecBlockUsingExecBlockId (  ) 

Returns the pointer to the row in the ExecBlock table having ExecBlock.execBlockId == execBlockId.

Returns:
a ExecBlockRow

boolean alma.asdm.HistoryRow.equalByRequiredValue ( HistoryRow  x  ) 

Return true if all required attributes of the value part are equal to their homologues in x and false otherwise.

Parameters:
x the HistoryRow whose required attributes of the value part will be compared with those of this.
Returns:
a boolean.

Object [] alma.asdm.HistoryRow.getAttributesValues (  )  [package, virtual]

Returns all the attributes of an attribute of an ASDM table as an array of Object.

Returns:
an array of Object.

Implements alma.asdm.ASDMRow.

The documentation for this class was generated from the following file:
Generated on Thu Nov 29 16:47:24 2007 for ASDM Java Implementation by  doxygen 1.5.1