Package com.onshape.api.types

Class OnshapeDocument

java.lang.Object

com.onshape.api.types.OnshapeDocument

public class OnshapeDocument
extends Object

Represents a document in the Onshape web application, enabling documents to be selected in the API client by copying URL.

Author:

Peter Harman peter.harman@cae.tech

Constructor Summary

Constructors

Constructor	Description
OnshapeDocument()	Create a null instance, for deserialization purposes
OnshapeDocument(String url)	Parse the given URL to determine document id, workspace id, and element id.
OnshapeDocument(String documentId, String workspaceId, String elementId)	Create a new instance from a document id, workspace id, and element id.
OnshapeDocument(String documentId, String workspaceId, String versionId, String microversionId, String elementId)	Create a new instance using all possible options, used internally by response objects.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getBaseURL()	Get the base URL, typically https://cad.onshape.com
String	getDocumentId()	Get the document id.
String	getElementId()	Get the element id.
String	getMicroversionId()	Get the microversion id.
String	getVersionId()	Get the version id.
VM	getVM()	Gets the choice of VM (Version, Microversion)
String	getVMId()	Gets either Version or Microversion, depending on VM variable
WM	getWM()	Gets the choice of WM (Workspace, Microversion)
String	getWMId()	Gets either Workspace or Microversion, depending on WM variable
String	getWorkspaceId()	Get the workspace id.
WV	getWV()	Gets the choice of WV (Workspace, Version)
String	getWVId()	Gets either Workspace or Version, depending on WV variable
WVM	getWVM()	Gets the choice of WVM (Workspace, Version, Microversion)
String	getWVMId()	Gets either Workspace, Version or Microversion, depending on WVM variable
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OnshapeDocument

public OnshapeDocument()

Create a null instance, for deserialization purposes

OnshapeDocument

public OnshapeDocument(String url)
                throws OnshapeException

Parse the given URL to determine document id, workspace id, and element id.

Parameters:

url - A URL from the Onshape web application.

Throws:

OnshapeException - If the URL cannot be parsed.

OnshapeDocument

public OnshapeDocument(String documentId,
                       String workspaceId,
                       String elementId)

Create a new instance from a document id, workspace id, and element id.

Parameters:

documentId - Document id.

workspaceId - Workspace id.

elementId - Element id.

OnshapeDocument

public OnshapeDocument(String documentId,
                       String workspaceId,
                       String versionId,
                       String microversionId,
                       String elementId)

Create a new instance using all possible options, used internally by response objects.

Parameters:

documentId - Document id.

workspaceId - Workspace id.

versionId - Version id.

microversionId - Microversion id.

elementId - Element id.

Method Detail

getBaseURL

public String getBaseURL()

Get the base URL, typically https://cad.onshape.com

Returns:

Base URL as a String

getDocumentId

public String getDocumentId()

Get the document id.

Returns:

Document id.

getWorkspaceId

public String getWorkspaceId()

Get the workspace id.

Returns:

Workspace id.

getWVM

public WVM getWVM()

Gets the choice of WVM (Workspace, Version, Microversion)

Returns:

wvm or null if no workspace, version, or microversion

getWV

public WV getWV()

Gets the choice of WV (Workspace, Version)

Returns:

wv or null if no workspace or version

getWM

public WM getWM()

Gets the choice of WM (Workspace, Microversion)

Returns:

wm or null if no workspace or microversion

getVM

public VM getVM()

Gets the choice of VM (Version, Microversion)

Returns:

vm or null if no version or microversion

getWVMId

public String getWVMId()

Gets either Workspace, Version or Microversion, depending on WVM variable

Returns:

An id, or null if none available

getWVId

public String getWVId()

Gets either Workspace or Version, depending on WV variable

Returns:

An id, or null if none available

getWMId

public String getWMId()

Gets either Workspace or Microversion, depending on WM variable

Returns:

An id, or null if none available

getVMId

public String getVMId()

Gets either Version or Microversion, depending on VM variable

Returns:

An id, or null if none available

getVersionId

public String getVersionId()

Get the version id.

Returns:

Version id.

getMicroversionId

public String getMicroversionId()

Get the microversion id.

Returns:

Microversion id.

getElementId

public String getElementId()

Get the element id.

Returns:

Element id.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object