ptserver.control

Class Ticket

java.lang.Object

ptserver.control.Ticket

All Implemented Interfaces:

java.io.Serializable

public class Ticket
extends java.lang.Object
implements java.io.Serializable

Define the response to a simulation execution request. Once the simulation has been launched at the request of the user, the ticket will be used to reference and administer control commands to the simulation (ex. start, pause, resume, stop, etc).

Since:

Ptolemy II 10.0

Version:

$Id: Ticket.java 69607 2014-07-30 17:07:26Z cxh $

Author:

Justin Killian

See Also:

Serialized Form

Accepted Rating:

Red (jkillian)

Proposed Rating:

Red (jkillian)

Constructor Summary

Constructors

Constructor and Description
Ticket()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object object) Compare tickets by the ticketID property.
static Ticket	generateTicket(java.lang.String modelUrl, java.lang.String layoutUrl) Generate a new ticket for the provided model and layout URL.
java.util.Date	getDateRequested() Get the date and time of the original request.
java.lang.String	getLayoutUrl() Get the URL of the layout file.
java.lang.String	getModelUrl() Get the URL of the model file.
java.lang.String	getTicketID() Get the unique ticket identifier.
int	hashCode() Return a hash code value for this ticket.
java.lang.String	toString() Return the ticket id.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Ticket

public Ticket()

Method Detail

equals

public boolean equals(java.lang.Object object)

Compare tickets by the ticketID property.

Overrides:

equals in class java.lang.Object

Parameters:

object - Object to compare this ticket with.

Returns:

True if the two objects are equal, false otherwise.

generateTicket

public static Ticket generateTicket(java.lang.String modelUrl,
                                    java.lang.String layoutUrl)

Generate a new ticket for the provided model and layout URL.

Parameters:

modelUrl - The path to the model file.

layoutUrl - The path to the layout file.

Returns:

Ticket corresponding to simulation request.

getDateRequested

public java.util.Date getDateRequested()

Get the date and time of the original request.

Returns:

Date and time that the simulation request was submitted.

getLayoutUrl

public java.lang.String getLayoutUrl()

Get the URL of the layout file.

Returns:

Path to the layout file.

getModelUrl

public java.lang.String getModelUrl()

Get the URL of the model file.

Returns:

Path to the model file.

getTicketID

public java.lang.String getTicketID()

Get the unique ticket identifier.

Returns:

Identifier used to reference the request.

hashCode

public int hashCode()

Return a hash code value for this ticket. This method uses the hashcode() of the ticketID string to compute the hash code for this ticket.

Overrides:

hashCode in class java.lang.Object

Returns:

A hash code value for this ticket.

toString

public java.lang.String toString()

Return the ticket id.

Overrides:

toString in class java.lang.Object

Returns:

the ticket id.

See Also:

Object.toString()