com.sage.swt.client.sdata
Class DataRequestEvent

java.lang.Object
  extended by java.util.EventObject
      extended by com.sage.swt.client.sdata.DataRequestEvent
All Implemented Interfaces:
java.io.Serializable

public final class DataRequestEvent
extends java.util.EventObject

Event fired when making requests on a DataSource or similar.

See Also:
Serialized Form

Field Summary
 
Fields inherited from class java.util.EventObject
source
 
Constructor Summary
DataRequestEvent(java.lang.Object source)
          Constructs a DataRequestEvent.
DataRequestEvent(java.lang.Object source, EntityData entity, SDataDiagnosisList diagnoses)
          Constructs a DataRequestEvent.
DataRequestEvent(java.lang.Object source, java.util.List<EntityData> entities)
          Constructs a DataRequestEvent.
DataRequestEvent(java.lang.Object source, java.util.List<EntityData> entities, SDataDiagnosisList diagnoses)
          Constructs a DataRequestEvent.
DataRequestEvent(java.lang.Object source, SDataDiagnosisList diagnoses)
          Constructs a DataRequestEvent.
 
Method Summary
 java.util.List<SDataDiagnosis> getDiagnoses()
          Gets the errors, warnings and other informational messages associated with the request.
 java.util.List<EntityData> getEntities()
          Gets the entities associated with the request.
 EntityData getEntity()
          Gets the entity associated with the request.
 boolean isList()
          returns whether or not the event represents a list rather than a single entity.
 
Methods inherited from class java.util.EventObject
getSource, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

DataRequestEvent

public DataRequestEvent(java.lang.Object source)
Constructs a DataRequestEvent.

Parameters:
source - source of the event. Usually a DataSource.

DataRequestEvent

public DataRequestEvent(java.lang.Object source,
                        java.util.List<EntityData> entities)
Constructs a DataRequestEvent.

Parameters:
source - source of the event. Usually a DataSource.
entities - any entities associated with the request.

DataRequestEvent

public DataRequestEvent(java.lang.Object source,
                        EntityData entity,
                        SDataDiagnosisList diagnoses)
Constructs a DataRequestEvent.

Parameters:
source - source of the event. Usually a DataSource.

DataRequestEvent

public DataRequestEvent(java.lang.Object source,
                        SDataDiagnosisList diagnoses)
Constructs a DataRequestEvent.

Parameters:
source - source of the event. Usually a DataSource.
diagnoses - errors or warnings.

DataRequestEvent

public DataRequestEvent(java.lang.Object source,
                        java.util.List<EntityData> entities,
                        SDataDiagnosisList diagnoses)
Constructs a DataRequestEvent.

Parameters:
source - source of the event. Usually a DataSource.
entities - any entities associated with the request.
diagnoses - errors or warnings.
Method Detail

getEntities

public java.util.List<EntityData> getEntities()
Gets the entities associated with the request.

Returns:
the entities associated with the request. For example, the entities gotten from a call to DataSource.getEntities(DataRequestCallback) are returned with this method.

getEntity

public EntityData getEntity()
Gets the entity associated with the request.

Returns:
the entity associated with the request.

isList

public boolean isList()
returns whether or not the event represents a list rather than a single entity.

If this returns true then calling getEntities() is valid and calling getEntity() is wrong.

Returns:
true if the event represents a list and false otherwise

getDiagnoses

public java.util.List<SDataDiagnosis> getDiagnoses()
Gets the errors, warnings and other informational messages associated with the request.

Returns:
the errors, warnings and other informational messages associated with the request.


Copyright © 2011 Sage Software, Inc. All rights reserved.