PropositionWrapper (Eureka! Client 5.0 API)

java.lang.Object
- org.eurekaclinical.eureka.client.comm.PropositionWrapper

All Implemented Interfaces:

Serializable
```
public class PropositionWrapper
extends Object
implements Serializable
```
Represents messages containing phenotype definitions.

Author:

hrathod

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class PropositionWrapper.Type

Nested Classes
Modifier and Type	Class and Description
`static class`	`PropositionWrapper.Type`

Constructor Summary

Constructors
Constructor and Description

PropositionWrapper()
Creates the message object.

Constructors
Constructor and Description
`PropositionWrapper()` Creates the message object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAbbrevDisplayName()` Gets the phenotype definition's abbreviated display name.
`List<PropositionWrapper>`	`getChildren()` Gets this phenotype definition's children, if any.
`Date`	`getCreated()` Gets the creation date of this phenotype definition.
`String`	`getDisplayName()` Gets the phenotype definition's display name.
`Long`	`getId()` Returns a user phenotype definition's id.
`String`	`getKey()` Returns a system phenotype definition's id string.
`Date`	`getLastModified()` Gets the last modified date of this phenotype definition.
`List<String>`	`getProperties()` Gets this phenotype definition's properties, if any.
`PropositionWrapper.Type`	`getType()` Gets the type of a user phenotype definition.
`Long`	`getUserId()` Returns a user phenotype definition's user id.
`boolean`	`isInSystem()` Gets whether this phenotype definition is a system or user data element definition.
`boolean`	`isParent()` Returns whether this phenotype definition has children.
`boolean`	`isSummarized()` Gets whether or not the children of this proposition are included in the message.
`void`	`setAbbrevDisplayName(String abbrevDisplayName)` Sets the phenotype definition's abbreviated display name.
`void`	`setChildren(List<PropositionWrapper> inChildren)` Sets this phenotype definition's children.
`void`	`setCreated(Date inCreated)` Sets the creation date of this phenotype definition.
`void`	`setDisplayName(String displayName)` Sets the phenotype definition's display name.
`void`	`setId(Long id)` Sets a user phenotype definition's id.
`void`	`setInSystem(boolean inSystem)` Sets whether this phenotype definition is a aystem or user data element definition.
`void`	`setKey(String inKey)` Sets a system phenotype definition's id string.
`void`	`setLastModified(Date inLastModified)` Sets the last modified date of this phenotype definition.
`void`	`setParent(boolean inParent)` Sets whether this phenotype definition has children.
`void`	`setProperties(List<String> inProperties)` Sets this phenotype definition's properties.
`void`	`setSummarized(boolean inSummarized)` Sets whether or not the children of this proposition are included in the message.
`void`	`setType(PropositionWrapper.Type type)` Sets the type of a user phenotype definition.
`void`	`setUserId(Long userId)` Sets a user phenotype definition's user id.
`String`	`toString()` Represents field values for debugging purposes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - PropositionWrapper
```
public PropositionWrapper()
```
    Creates the message object.
- Method Detail
  - getId
```
public Long getId()
```
    Returns a user phenotype definition's id.
    
    Returns:
    
    a Long. Will be null for a system data element definition.
  - setId
```
public void setId(Long id)
```
    Sets a user phenotype definition's id.
    
    Parameters:
    
    id - a Long.
  - getKey
```
public String getKey()
```
    Returns a system phenotype definition's id string.
    
    Returns:
    
    a String. Will be null for a user data element definition.
  - setKey
```
public void setKey(String inKey)
```
    Sets a system phenotype definition's id string.
    
    Parameters:
    
    inKey - a String.
  - getUserId
```
public Long getUserId()
```
    Returns a user phenotype definition's user id.
    
    Returns:
    
    a Long.
  - setUserId
```
public void setUserId(Long userId)
```
    Sets a user phenotype definition's user id.
    
    Parameters:
    
    userId - a Long.
  - getAbbrevDisplayName
```
public String getAbbrevDisplayName()
```
    Gets the phenotype definition's abbreviated display name.
    
    Returns:
    
    a String. May be null if no abbreviated display name is specified.
  - setAbbrevDisplayName
```
public void setAbbrevDisplayName(String abbrevDisplayName)
```
    Sets the phenotype definition's abbreviated display name.
    
    Parameters:
    
    abbrevDisplayName - a String. Passing in null will set the abbreviated display name as unspecified.
  - getDisplayName
```
public String getDisplayName()
```
    Gets the phenotype definition's display name.
    
    Returns:
    
    a String. A value of null means that no display name is specified.
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Sets the phenotype definition's display name.
    
    Parameters:
    
    displayName - a String. Passing in null will set the abbreviated display name as unspecified.
  - getType
```
public PropositionWrapper.Type getType()
```
    Gets the type of a user phenotype definition.
    
    Returns:
    
    a PropositionWrapper.Type. Will be null if a system data element definition.
  - setType
```
public void setType(PropositionWrapper.Type type)
```
    Sets the type of a user phenotype definition.
    
    Parameters:
    
    type - a PropositionWrapper.Type. Should be null for a system data element definition.
  - isInSystem
```
public boolean isInSystem()
```
    Gets whether this phenotype definition is a system or user data element definition.
    
    Returns:
    
    true if a system phenotype definition, false if a user phenotype definition.
  - setInSystem
```
public void setInSystem(boolean inSystem)
```
    Sets whether this phenotype definition is a aystem or user data element definition.
    
    Parameters:
    
    inSystem - true if a system phenotype definition, false if a user phenotype definition.
  - getCreated
```
public Date getCreated()
```
    Gets the creation date of this phenotype definition.
    
    Returns:
    
    the creation Date, or null if the creation date is unspecified.
  - setCreated
```
public void setCreated(Date inCreated)
```
    Sets the creation date of this phenotype definition.
    
    Parameters:
    
    inCreated - the creation Date, or null if the creation date is unspecified.
  - getLastModified
```
public Date getLastModified()
```
    Gets the last modified date of this phenotype definition.
    
    Returns:
    
    the last modified Date, or null if the last modified date is unspecified.
  - setLastModified
```
public void setLastModified(Date inLastModified)
```
    Sets the last modified date of this phenotype definition.
    
    Parameters:
    
    inLastModified - the last modified Date, or null if the last modified date is unspecified.
  - isSummarized
```
public boolean isSummarized()
```
    Gets whether or not the children of this proposition are included in the message.
    
    Returns:
    
    true if the children of this proposition are included, false otherwise.
  - setSummarized
```
public void setSummarized(boolean inSummarized)
```
    Sets whether or not the children of this proposition are included in the message.
    
    Parameters:
    
    inSummarized - true if the children of this proposition are included, false otherwise.
  - getChildren
```
public List<PropositionWrapper> getChildren()
```
    Gets this phenotype definition's children, if any.
    
    Returns:
    
    a List of this phenotype definition's children, if any.
  - setChildren
```
public void setChildren(List<PropositionWrapper> inChildren)
```
    Sets this phenotype definition's children.
    
    Parameters:
    
    inChildren - a List of this phenotype definition's children.
  - getProperties
```
public List<String> getProperties()
```
    Gets this phenotype definition's properties, if any.
    
    Returns:
    
    a List of this phenotype definition's properties, if any
  - setProperties
```
public void setProperties(List<String> inProperties)
```
    Sets this phenotype definition's properties.
    
    Parameters:
    
    inProperties - a List of this phenotype definition's properties.
  - isParent
```
public boolean isParent()
```
    Returns whether this phenotype definition has children.
    
    Returns:
    
    true if this phenotype definition has children, false otherwise.
  - setParent
```
public void setParent(boolean inParent)
```
    Sets whether this phenotype definition has children.
    
    Parameters:
    
    inParent - true if this phenotype definition has children, false otherwise.
  - toString
```
public String toString()
```
    Represents field values for debugging purposes.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representing the state of the object.

Class PropositionWrapper

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

PropositionWrapper

Method Detail

getId

setId

getKey

setKey

getUserId

setUserId

getAbbrevDisplayName

setAbbrevDisplayName

getDisplayName

setDisplayName

getType

setType

isInSystem

setInSystem

getCreated

setCreated

getLastModified

setLastModified

isSummarized

setSummarized

getChildren

setChildren

getProperties

setProperties

isParent

setParent

toString