com.projectdarkstar.tools.dtc.data
Class ClientAppConfigDTO

java.lang.Object
  extended by com.projectdarkstar.tools.dtc.data.AbstractDTO
      extended by com.projectdarkstar.tools.dtc.data.ClientAppConfigDTO
All Implemented Interfaces:
Serializable

public class ClientAppConfigDTO
extends AbstractDTO

Represents a runtime configuration for a ClientAppDTO.

See Also:
Serialized Form

Constructor Summary
ClientAppConfigDTO(Long id, Long versionNumber, String name, String path, ClientAppConfigTypeDTO propertyMethod)
           
 
Method Summary
 boolean equals(Object o)
           
 ClientAppDTO getClientApp()
          Returns the parent ClientAppDTO which this configuration is associated with.
 Long getId()
          Returns the id of the entity in persistent storage
 String getName()
           
 String getPath()
          Returns the system path required to initiate execution of this client simulator.
 List<PropertyDTO> getProperties()
          Returns a list of arguments in the form of PropertyDTO objects to be passed to the client during run time.
 ClientAppConfigTypeDTO getPropertyMethod()
          Returns the mechanism required to pass arguments to the client executable.
 Long getVersionNumber()
          Returns the version number in the data store that this entity represents.
 int hashCode()
           
protected  void setClientApp(ClientAppDTO clientApp)
           
 void setId(Long id)
           
protected  void setName(String name)
           
protected  void setPath(String path)
           
protected  void setProperties(List<PropertyDTO> properties)
           
protected  void setPropertyMethod(ClientAppConfigTypeDTO propertyMethod)
           
 void updateClientApp(ClientAppDTO clientApp)
           
 void updateName(String name)
           
 void updatePath(String path)
           
 void updateProperties(List<PropertyDTO> properties)
           
 void updatePropertyMethod(ClientAppConfigTypeDTO propertyMethod)
           
 void validate()
          Validates that each attribute and pending updated attribute (from the updatedAttributes Map) has a valid value in the context of the particular object.
 
Methods inherited from class com.projectdarkstar.tools.dtc.data.AbstractDTO
checkBlank, checkNull, getFullyPopulated, getUpdatedAttributes, updateAttribute, valueToValidate
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ClientAppConfigDTO

public ClientAppConfigDTO(Long id,
                          Long versionNumber,
                          String name,
                          String path,
                          ClientAppConfigTypeDTO propertyMethod)
Method Detail

getId

public Long getId()
Returns the id of the entity in persistent storage

Specified by:
getId in class AbstractDTO
Returns:
id of the entity

setId

public void setId(Long id)

getVersionNumber

public Long getVersionNumber()
Returns the version number in the data store that this entity represents. Whenever an update to an object is pushed to the persistent data store, the version number is incremented.

Returns:
version number of the entity

getName

public String getName()

setName

protected void setName(String name)

updateName

public void updateName(String name)
                throws DTCInvalidDataException
Throws:
DTCInvalidDataException

getPath

public String getPath()
Returns the system path required to initiate execution of this client simulator. The path could be a java executable or some other executable type since the client is not required to be a java application.

Returns:
path of the client application executable

setPath

protected void setPath(String path)

updatePath

public void updatePath(String path)
                throws DTCInvalidDataException
Throws:
DTCInvalidDataException

getPropertyMethod

public ClientAppConfigTypeDTO getPropertyMethod()
Returns the mechanism required to pass arguments to the client executable.

Returns:
mechanism required to pass arguments to the client

setPropertyMethod

protected void setPropertyMethod(ClientAppConfigTypeDTO propertyMethod)

updatePropertyMethod

public void updatePropertyMethod(ClientAppConfigTypeDTO propertyMethod)
                          throws DTCInvalidDataException
Throws:
DTCInvalidDataException

getClientApp

public ClientAppDTO getClientApp()
Returns the parent ClientAppDTO which this configuration is associated with.

Returns:
parent ClientAppDTO for this configuration

setClientApp

protected void setClientApp(ClientAppDTO clientApp)

updateClientApp

public void updateClientApp(ClientAppDTO clientApp)
                     throws DTCInvalidDataException
Throws:
DTCInvalidDataException

getProperties

public List<PropertyDTO> getProperties()
Returns a list of arguments in the form of PropertyDTO objects to be passed to the client during run time.

Returns:
list of arguments

setProperties

protected void setProperties(List<PropertyDTO> properties)

updateProperties

public void updateProperties(List<PropertyDTO> properties)
                      throws DTCInvalidDataException
Throws:
DTCInvalidDataException

validate

public void validate()
              throws DTCInvalidDataException
Description copied from class: AbstractDTO
Validates that each attribute and pending updated attribute (from the updatedAttributes Map) has a valid value in the context of the particular object.

Specified by:
validate in class AbstractDTO
Throws:
DTCInvalidDataException

equals

public boolean equals(Object o)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object


Copyright © 2013. All Rights Reserved.