Log (Olog Directory Service 2.2.7-SNAPSHOT API)

java.lang.Object
- edu.msu.nscl.olog.Log

All Implemented Interfaces:

Serializable, Comparable<Log>
```
@Entity
public class Log
extends Object
implements Serializable, Comparable<Log>
```
Log object that can be represented as XML/JSON in payload data.

Author:

Eric Berryman taken from Ralph Lange

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`Log()` Creates a new instance of Log
`Log(Long logId)` Creates a new instance of Log.
`Log(Long logId, String owner)` Creates a new instance of Log.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addLogbook(Logbook logbook)` Adds an Logbook to the log.
`void`	`addTag(Tag tag)` Adds an Tag to the collection.
`void`	`addXmlAttachment(XmlAttachment attachment)` Adds an XmlAttachment to the collection.
`void`	`addXmlProperty(XmlProperty property)` Adds an Property to the log.
`int`	`compareTo(Log num)`
`boolean`	`equals(Object o)`
`Set<LogAttribute>`	`getAttributes()`
`Date`	`getCreatedDate()` Getter for log created date.
`String`	`getDescription()` Getter for log description.
`Entry`	`getEntry()`
`Long`	`getEntryId()`
`Long`	`getId()` Getter for log id.
`Level`	`getLevel()` Getter for log level.
`Set<Logbook>`	`getLogbooks()` Getter for log's Logbooks.
`Date`	`getModifiedDate()` Getter for log modified date.
`String`	`getOwner()` Getter for log owner.
`String`	`getSource()` Getter for log source IP.
`State`	`getState()`
`Set<Tag>`	`getTags()` Getter for the log's Tags.
`String`	`getVersion()` Getter for log version id.
`Collection<XmlAttachment>`	`getXmlAttachments()` Getter for the log's XmlAttachments.
`Collection<XmlProperty>`	`getXmlProperties()` Getter for log's XmlProperties.
`int`	`hashCode()`
`void`	`removeLogbook(Logbook logbook)`
`void`	`removeTag(Tag tag)`
`void`	`removeXmlAttachment(XmlAttachment attachment)`
`void`	`removeXmlProperty(XmlProperty property)`
`void`	`setAttributes(Set<LogAttribute> attributes)`
`void`	`setDescription(String description)` Setter for log description.
`void`	`setEntry(Entry entry)`
`void`	`setEntryId(Long id)`
`void`	`setId(Long logId)` Setter for log id.
`void`	`setLevel(Level level)` Setter for log owner.
`void`	`setLogbooks(Set<Logbook> logbooks)` Setter for log's Logbooks.
`void`	`setModifiedDate(Date modifiedDate)` Setter for log modified date.
`void`	`setOwner(String owner)` Setter for log owner.
`void`	`setSource(String source)` Setter for log source IP.
`void`	`setState(State state)`
`void`	`setTags(Set<Tag> tags)` Setter for the log's Tags.
`void`	`setUpdated()`
`void`	`setVersion(String version)` Setter for log version id.
`void`	`setXmlAttachments(Collection<XmlAttachment> attachments)` Setter for the log's XmlAttachments.
`void`	`setXmlProperties(Collection<XmlProperty> properties)` Setter for log's XmlProperties.
`static String`	`toLogger(Log data)` Creates a compact string representation for the log.

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

- Constructor Detail
  - Log
```
public Log()
```
    Creates a new instance of Log
  - Log
```
public Log(Long logId)
```
    Creates a new instance of Log.
    
    Parameters:
    logId - log id
  - Log
```
public Log(Long logId,
   String owner)
```
    Creates a new instance of Log.
    
    Parameters:
    logId - log id
    owner - log owner
- Method Detail
  - setUpdated
```
public void setUpdated()
```
  - getId
```
public Long getId()
```
    Getter for log id.
    
    Returns:
    id
  - setId
```
public void setId(Long logId)
```
    Setter for log id.
    
    Parameters:
    logId -
  - getEntryId
```
public Long getEntryId()
```
  - setEntryId
```
public void setEntryId(Long id)
```
  - getState
```
public State getState()
```
    Returns:
    the status
  - setState
```
public void setState(State state)
```
  - getVersion
```
public String getVersion()
```
    Getter for log version id.
    
    Returns:
    versionId
  - setVersion
```
public void setVersion(String version)
```
    Setter for log version id.
    
    Parameters:
    version -
  - getOwner
```
public String getOwner()
```
    Getter for log owner.
    
    Returns:
    owner
  - setOwner
```
public void setOwner(String owner)
```
    Setter for log owner.
    
    Parameters:
    owner -
  - getLevel
```
public Level getLevel()
```
    Getter for log level.
    
    Returns:
    level
  - setLevel
```
public void setLevel(Level level)
```
    Setter for log owner.
    
    Parameters:
    level -
  - getModifiedDate
```
public Date getModifiedDate()
```
    Getter for log modified date.
    
    Returns:
    modifiedDate
  - setModifiedDate
```
public void setModifiedDate(Date modifiedDate)
```
    Setter for log modified date.
    
    Parameters:
    modifiedDate -
  - getCreatedDate
```
public Date getCreatedDate()
```
    Getter for log created date.
    
    Returns:
    createdDate
  - getSource
```
public String getSource()
```
    Getter for log source IP.
    
    Returns:
    source IP
  - setSource
```
public void setSource(String source)
```
    Setter for log source IP.
    
    Parameters:
    source - IP
  - getDescription
```
public String getDescription()
```
    Getter for log description.
    
    Returns:
    description
  - setDescription
```
public void setDescription(String description)
```
    Setter for log description.
    
    Parameters:
    description - the value to set
  - getXmlProperties
```
public Collection<XmlProperty> getXmlProperties()
```
    Getter for log's XmlProperties.
    
    Returns:
    properties XmlProperties
  - setXmlProperties
```
public void setXmlProperties(Collection<XmlProperty> properties)
```
    Setter for log's XmlProperties.
    
    Parameters:
    properties - XmlProperties
  - addXmlProperty
```
public void addXmlProperty(XmlProperty property)
```
    Adds an Property to the log.
    
    Parameters:
    property - single Property
  - removeXmlProperty
```
public void removeXmlProperty(XmlProperty property)
```
  - getLogbooks
```
public Set<Logbook> getLogbooks()
```
    Getter for log's Logbooks.
    
    Returns:
    Logbooks
  - setLogbooks
```
public void setLogbooks(Set<Logbook> logbooks)
```
    Setter for log's Logbooks.
    
    Parameters:
    logbooks - Logbooks
  - addLogbook
```
public void addLogbook(Logbook logbook)
```
    Adds an Logbook to the log.
    
    Parameters:
    logbook - single Logbook
  - removeLogbook
```
public void removeLogbook(Logbook logbook)
```
  - getTags
```
public Set<Tag> getTags()
```
    Getter for the log's Tags.
    
    Returns:
    Tags for this log
  - setTags
```
public void setTags(Set<Tag> tags)
```
    Setter for the log's Tags.
    
    Parameters:
    tags - Tags
  - addTag
```
public void addTag(Tag tag)
```
    Adds an Tag to the collection.
    
    Parameters:
    tag -
  - removeTag
```
public void removeTag(Tag tag)
```
  - getXmlAttachments
```
public Collection<XmlAttachment> getXmlAttachments()
```
    Getter for the log's XmlAttachments.
    
    Returns:
    XmlAttachments for this log
  - setXmlAttachments
```
public void setXmlAttachments(Collection<XmlAttachment> attachments)
```
    Setter for the log's XmlAttachments.
    
    Parameters:
    attachments - XmlAttachments
  - addXmlAttachment
```
public void addXmlAttachment(XmlAttachment attachment)
```
    Adds an XmlAttachment to the collection.
    
    Parameters:
    attachment -
  - removeXmlAttachment
```
public void removeXmlAttachment(XmlAttachment attachment)
```
  - getEntry
```
public Entry getEntry()
```
    Returns:
    the entry
  - setEntry
```
public void setEntry(Entry entry)
```
    Parameters:
    entry - the entry to set
  - getAttributes
```
public Set<LogAttribute> getAttributes()
```
  - setAttributes
```
public void setAttributes(Set<LogAttribute> attributes)
```
  - compareTo
```
public int compareTo(Log num)
```
    Specified by:
    
    compareTo in interface Comparable<Log>
  - toLogger
```
public static String toLogger(Log data)
```
    Creates a compact string representation for the log.
    
    Parameters:
    data - Log to create the string representation for
    
    Returns:
    string representation
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class Log

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Log

Log

Log

Method Detail

setUpdated

getId

setId

getEntryId

setEntryId

getState

setState

getVersion

setVersion

getOwner

setOwner

getLevel

setLevel

getModifiedDate

setModifiedDate

getCreatedDate

getSource

setSource

getDescription

setDescription

getXmlProperties

setXmlProperties

addXmlProperty

removeXmlProperty

getLogbooks

setLogbooks

addLogbook

removeLogbook

getTags

setTags

addTag

removeTag

getXmlAttachments

setXmlAttachments

addXmlAttachment

removeXmlAttachment

getEntry

setEntry

getAttributes

setAttributes

compareTo

toLogger

equals

hashCode