Venue (stumps 1.0-SNAPSHOT API)

java.lang.Object
- com.neurosys.domain.ModelObject
- - com.neurosys.domain.DomainObject
  - - com.neurosys.multiorg.domain.Venue

All Implemented Interfaces:

Attributes<Venue,String>, Displayable, Serializable
```
@Entity
public class Venue
extends DomainObject
implements Attributes<Venue,String>, Displayable
```
Represent Venues.

Author:

Arjun Dhar

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,VenueAttribute>`	`attributes` Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
`protected String`	`displayName`
`protected Long`	`id`
`protected String`	`name` Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.

Constructor Summary

Constructors
Constructor and Description
`Venue()`
`Venue(PlaceRef location, Organization ownerOrganization)`
`Venue(String json)`
`Venue(String name, Organization ownerOrganization)`
`Venue(Venue venue)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`VenueAttribute`	`getAttribute(String name)` Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
`Map<String,VenueAttribute>`	`getAttributes()`
`String`	`getAttributeValue(String name)` Accessor to get the value and encapsulate how the value comes from the `Attributes`.`Attribute`
`String`	`getDisplayName()`
`GeoLocation`	`getGeoLocation()` `location` was intended to be `PointRef` type.
`Long`	`getId()`
`<P extends PlaceRef> P`	`getLocation()` The `PlaceRef` of the Venue itself This also serves as the default location for the venue itself
`String`	`getName()`
`Organization`	`getOwnerOrganization()`
`List<? extends PlaceRef>`	`getPlaces()` The `PlaceRef`s within a venue with multiple entry points.
`int`	`hashCode()`
`boolean`	`liberalEquals(Venue obj)` Id or name matches
`Venue`	`setAttribute(String name, String value)` This method encapsulates the responsibility of ensuring the @link Attribute} can be set into the entity, including null checks, initializations, any relations between `Attributes` and `Attribute`.
`void`	`setAttributes(Map<String,VenueAttribute> attributes)`
`void`	`setDisplayName(String displayName)`
`void`	`setGeoLocation(GeoLocation geoLocation)` `location` was intended to be `PointRef` type.
`void`	`setId(Long id)`
`void`	`setLocation(PlaceRef location)` The `PlaceRef` of the Venue itself This also serves as the default location for the venue itself
`void`	`setName(String name)`
`void`	`setOwnerOrganization(Organization ownerOrganization)`
`void`	`setPlaces(List<? extends PlaceRef> places)` The `PlaceRef`s within a venue with multiple entry points.
`String`	`toString()`

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

- Field Detail
  - id
```
@Type(value="HIDDEN")
protected Long id
```
  - name
```
@Type(value="HIDDEN")
protected String name
```
    Unique Name to refer to the record Id is an Auto generated number used by the system, but is difficult for the outside world to get a handle on it.
  - displayName
```
@Type(value="INPUT")
protected String displayName
```
  - attributes
```
protected Map<String,VenueAttribute> attributes
```
    Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
    Attributes usually represent fluid variations within Products and product Types that are loosely defined for some products.
- Constructor Detail
  - Venue
```
public Venue()
```
  - Venue
```
public Venue(String json)
```
  - Venue
```
public Venue(Venue venue)
```
  - Venue
```
public Venue(String name,
             Organization ownerOrganization)
```
  - Venue
```
public Venue(PlaceRef location,
             Organization ownerOrganization)
```
- Method Detail
  - getLocation
```
public <P extends PlaceRef> P getLocation()
```
    The PlaceRef of the Venue itself
    
    This also serves as the default location for the venue itself
    
    See Also:
    
    geoLocation, places
    
    Can be null:
    
    false
  - setLocation
```
public void setLocation(PlaceRef location)
```
    The PlaceRef of the Venue itself
    
    This also serves as the default location for the venue itself
    
    See Also:
    
    geoLocation, places
    
    Can be null:
    
    false
  - getPlaces
```
public List<? extends PlaceRef> getPlaces()
```
    The PlaceRefs within a venue with multiple entry points. This may include location or may not.
    
    Can be null:
    
    true
  - setPlaces
```
public void setPlaces(List<? extends PlaceRef> places)
```
    The PlaceRefs within a venue with multiple entry points. This may include location or may not.
    
    Can be null:
    
    true
  - getId
```
public Long getId()
```
    Returns:
    
    the id
  - setId
```
public void setId(Long id)
```
    Parameters:
    
    id - the id to set
  - getName
```
public String getName()
```
    Returns:
    
    the name
  - setName
```
public void setName(String name)
```
    Parameters:
    
    name - the name to set
  - getDisplayName
```
public String getDisplayName()
```
    Specified by:
    
    getDisplayName in interface Displayable
    
    Returns:
    
    the displayName
  - setDisplayName
```
public void setDisplayName(String displayName)
```
    Parameters:
    
    displayName - the displayName to set
  - getGeoLocation
```
public GeoLocation getGeoLocation()
```
    location was intended to be PointRef type. However some complications (Location has to be relation, but PlaceRef type does not guarantee a GeoLocation hence the relation was not possible) prevented it.
    So Venue location = location + its geoLocation.
    
    See Also:
    
    location
  - setGeoLocation
```
public void setGeoLocation(GeoLocation geoLocation)
```
    location was intended to be PointRef type. However some complications (Location has to be relation, but PlaceRef type does not guarantee a GeoLocation hence the relation was not possible) prevented it.
    So Venue location = location + its geoLocation.
    
    See Also:
    
    location
  - getOwnerOrganization
```
public Organization getOwnerOrganization()
```
    Returns:
    
    the ownerOrganization as Organization
  - setOwnerOrganization
```
public void setOwnerOrganization(Organization ownerOrganization)
```
    Parameters:
    
    ownerOrganization - as Organization
  - getAttributes
```
public Map<String,VenueAttribute> getAttributes()
```
  - setAttributes
```
public void setAttributes(Map<String,VenueAttribute> attributes)
```
  - getAttribute
```
public VenueAttribute getAttribute(String name)
```
    Any attribute that is not common for most of the entities belongs to be an Attribute rather than a field.
    Attributes usually represent fluid variations within Entity that are loosely defined for some products.
  - getAttributeValue
```
public String getAttributeValue(String name)
```
    Description copied from interface: Attributes
    
    Accessor to get the value and encapsulate how the value comes from the Attributes.Attribute
    
    Specified by:
    
    getAttributeValue in interface Attributes<Venue,String>
    
    Parameters:
    
    name - as String
    
    Returns:
    
    null or the value of the Attribute
  - setAttribute
```
public Venue setAttribute(String name,
                          String value)
```
    Description copied from interface: Attributes
    
    This method encapsulates the responsibility of ensuring the @link Attribute} can be set into the entity, including null checks, initializations, any relations between Attributes and Attribute.
    
    Specified by:
    
    setAttribute in interface Attributes<Venue,String>
    
    Parameters:
    
    name - as String
    
    value - as value type
    
    Returns:
    
    this object
  - liberalEquals
```
public boolean liberalEquals(Venue obj)
```
    Id or name matches
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Venue

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

id

name

displayName

attributes

Constructor Detail

Venue

Venue

Venue

Venue

Venue

Method Detail

getLocation

setLocation

getPlaces

setPlaces

getId

setId

getName

setName

getDisplayName

setDisplayName

getGeoLocation

setGeoLocation

getOwnerOrganization

setOwnerOrganization

getAttributes

setAttributes

getAttribute

getAttributeValue

setAttribute

liberalEquals

equals

hashCode

toString