edu.msu.nscl.olog.api

Class XmlLogbook

java.lang.Object

edu.msu.nscl.olog.api.XmlLogbook

public class XmlLogbook
extends Object

Logbook object that can be represented as XML/JSON in payload data.

Author:

Eric Berryman taken from Ralph Lange

Constructor Summary

Constructors

Constructor and Description
XmlLogbook() Creates a new instance of XmlLogbook.
XmlLogbook(String name, String owner) Creates a new instance of XmlLogbook.

Method Summary

Methods

Modifier and Type	Method and Description
Long	getId() Getter for logbook id.
String	getName() Getter for logbook name.
String	getOwner() Getter for logbook owner.
XmlLogs	getXmlLogs() Getter for logbook's XmlLogs.
void	setId(Long id) Setter for logbook id.
void	setName(String name) Setter for logbook name.
void	setOwner(String owner) Setter for logbook owner.
void	setXmlLogs(XmlLogs logs) Setter for logbook's XmlLogs.
static String	toLog(XmlLogbook data) Creates a compact string representation for the log.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

XmlLogbook

public XmlLogbook()

Creates a new instance of XmlLogbook.

XmlLogbook

public XmlLogbook(String name,
          String owner)

Creates a new instance of XmlLogbook.

Parameters:

name -

owner -

Method Detail

getId

public Long getId()

Getter for logbook id.

Returns:

id logbook id

setId

public void setId(Long id)

Setter for logbook id.

Parameters:

name - logbook id

getName

public String getName()

Getter for logbook name.

Returns:

name logbook name

setName

public void setName(String name)

Setter for logbook name.

Parameters:

name - logbook name

getOwner

public String getOwner()

Getter for logbook owner.

Returns:

owner logbook owner

setOwner

public void setOwner(String owner)

Setter for logbook owner.

Parameters:

owner - logbook owner

getXmlLogs

public XmlLogs getXmlLogs()

Getter for logbook's XmlLogs.

Returns:

logs XmlLogs object

setXmlLogs

public void setXmlLogs(XmlLogs logs)

Setter for logbook's XmlLogs.

Parameters:

logs - XmlLogs object

toLog

public static String toLog(XmlLogbook data)

Creates a compact string representation for the log.

Parameters:

data - the XmlLogbook to log

Returns:

string representation for log