net.spreadsheetspace.sdk.model

Class ViewDescriptor

java.lang.Object

net.spreadsheetspace.sdk.model.ViewDescriptor

public class ViewDescriptor
extends Object

Response object for create/update/publish View

Composed by

• viewId: This string represents the identifier of the View.
• viewServer: This string represents the server address where the View is stored.
• statusCode: This integer represents the response code for the action that was performed on the current View.
• message: This string represents a message associated to the StatusCode.
• nextAvailableSequenceNumber: This long represents a sequence number that must be send to the next update of the current View.
• excelType: This enum represents the type of current Object.

Constructor Summary

Constructors

Constructor and Description
ViewDescriptor(LinkedList<String> messages, StatusCode statusCode)
ViewDescriptor(String viewId, String viewServer)
ViewDescriptor(String viewId, String viewServer, ExcelType excelType)
ViewDescriptor(String viewId, String viewServer, Long nextAvailableSequenceNumber)
ViewDescriptor(String viewId, String viewServer, Long nextAvailableSequenceNumber, ExcelType excelType)
ViewDescriptor(String viewId, String viewServer, StatusCode statusCode, String message, Long nextAvailableSequenceNumber)
ViewDescriptor(String viewId, String viewServer, StatusCode statusCode, String message, Long nextAvailableSequenceNumber, ExcelType excelType)
ViewDescriptor(String viewId, String viewServer, StatusCode statusCode, String message, Long nextAvailableSequenceNumber, ExcelType excelType, String marketId)
ViewDescriptor(String viewId, String viewServer, String marketId)

Method Summary

Modifier and Type	Method and Description
ExcelType	getExcelType() Get the Excel type on the current Object.
String	getMarketId() Get the identifier of the View.
String	getMessage() Get a message associated to the StatusCode.
LinkedList<String>	getMessages()
Long	getNextAvailableSequenceNumber() Get a sequence number that must be send to the next update of the current View.
StatusCode	getStatusCode() Get the response code for the action that was performed on the current View.
String	getViewId() Get the identifier of the View.
String	getViewServer() Get the server address where the View is stored.
void	setExcelType(ExcelType excelType)
void	setMarketId(String marketId)
void	setMessage(String message)
void	setMessages(LinkedList<String> messages)
void	setNextAvailableSequenceNumber(Long sequenceNumber)
void	setStatusCode(StatusCode statusCode)
void	setViewId(String viewId)
void	setViewServer(String viewServer)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      String marketId)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      Long nextAvailableSequenceNumber)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      StatusCode statusCode,
                      String message,
                      Long nextAvailableSequenceNumber)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      ExcelType excelType)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      Long nextAvailableSequenceNumber,
                      ExcelType excelType)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      StatusCode statusCode,
                      String message,
                      Long nextAvailableSequenceNumber,
                      ExcelType excelType)

ViewDescriptor

public ViewDescriptor(String viewId,
                      String viewServer,
                      StatusCode statusCode,
                      String message,
                      Long nextAvailableSequenceNumber,
                      ExcelType excelType,
                      String marketId)

ViewDescriptor

public ViewDescriptor(LinkedList<String> messages,
                      StatusCode statusCode)

Method Detail

getViewId

public String getViewId()

Get the identifier of the View.

setViewId

public void setViewId(String viewId)

getViewServer

public String getViewServer()

Get the server address where the View is stored.

setViewServer

public void setViewServer(String viewServer)

getMessage

public String getMessage()

Get a message associated to the StatusCode.

setMessage

public void setMessage(String message)

getNextAvailableSequenceNumber

public Long getNextAvailableSequenceNumber()

Get a sequence number that must be send to the next update of the current View.

setNextAvailableSequenceNumber

public void setNextAvailableSequenceNumber(Long sequenceNumber)

getMessages

public LinkedList<String> getMessages()

setMessages

public void setMessages(LinkedList<String> messages)

getStatusCode

public StatusCode getStatusCode()

Get the response code for the action that was performed on the current View.

setStatusCode

public void setStatusCode(StatusCode statusCode)

getExcelType

public ExcelType getExcelType()

Get the Excel type on the current Object.

setExcelType

public void setExcelType(ExcelType excelType)

getMarketId

public String getMarketId()

Get the identifier of the View.

setMarketId

public void setMarketId(String marketId)

toString

public String toString()

Overrides:

toString in class Object