Package com.onshape.api.requests

Class DocumentsFilterDocumentHistoryRequest.Builder

java.lang.Object

com.onshape.api.requests.DocumentsFilterDocumentHistoryRequest.Builder

Enclosing class:

DocumentsFilterDocumentHistoryRequest

public static final class DocumentsFilterDocumentHistoryRequest.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
DocumentsFilterDocumentHistoryResponse	call()	Calls filterDocumentHistory method, filter document history
String	documentId()	Get is current document id
DocumentsFilterDocumentHistoryRequest.Builder	documentId(String value)	Set is current document id
String	editDescription()	Get is edit description
DocumentsFilterDocumentHistoryRequest.Builder	editDescription(String value)	Set is edit description
String[]	elementIds()	Get is list of element ids included for target filtered history
DocumentsFilterDocumentHistoryRequest.Builder	elementIds(String[] value)	Set is list of element ids included for target filtered history
Number[]	elementTypes()	Get is list of element types included for target filtered history
DocumentsFilterDocumentHistoryRequest.Builder	elementTypes(Number[] value)	Set is list of element types included for target filtered history
Date	endDate()	Get is end date of the target date
DocumentsFilterDocumentHistoryRequest.Builder	endDate(Date value)	Set is end date of the target date
Number	sortingStrategy()	Get sorting option (by date is the default)
DocumentsFilterDocumentHistoryRequest.Builder	sortingStrategy(Number value)	Set sorting option (by date is the default)
Date	startDate()	Get is start date of the target date range
DocumentsFilterDocumentHistoryRequest.Builder	startDate(Date value)	Set is start date of the target date range
String	userId()	Get is target user id
DocumentsFilterDocumentHistoryRequest.Builder	userId(String value)	Set is target user id

Methods inherited from class java.lang.Object

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

Method Detail

documentId

public final String documentId()

Get is current document id

Returns:

is current document id

documentId

public final DocumentsFilterDocumentHistoryRequest.Builder documentId(String value)

Set is current document id

Parameters:

value - is current document id

Returns:

the Builder object.

userId

public final String userId()

Get is target user id

Returns:

is target user id

userId

public final DocumentsFilterDocumentHistoryRequest.Builder userId(String value)

Set is target user id

Parameters:

value - is target user id

Returns:

the Builder object.

startDate

public final Date startDate()

Get is start date of the target date range

Returns:

is start date of the target date range

startDate

public final DocumentsFilterDocumentHistoryRequest.Builder startDate(Date value)

Set is start date of the target date range

Parameters:

value - is start date of the target date range

Returns:

the Builder object.

endDate

public final Date endDate()

Get is end date of the target date

Returns:

is end date of the target date

endDate

public final DocumentsFilterDocumentHistoryRequest.Builder endDate(Date value)

Set is end date of the target date

Parameters:

value - is end date of the target date

Returns:

the Builder object.

elementIds

public final String[] elementIds()

Get is list of element ids included for target filtered history

Returns:

is list of element ids included for target filtered history

elementIds

public final DocumentsFilterDocumentHistoryRequest.Builder elementIds(String[] value)

Set is list of element ids included for target filtered history

Parameters:

value - is list of element ids included for target filtered history

Returns:

the Builder object.

elementTypes

public final Number[] elementTypes()

Get is list of element types included for target filtered history

Returns:

is list of element types included for target filtered history

elementTypes

public final DocumentsFilterDocumentHistoryRequest.Builder elementTypes(Number[] value)

Set is list of element types included for target filtered history

Parameters:

value - is list of element types included for target filtered history

Returns:

the Builder object.

sortingStrategy

public final Number sortingStrategy()

Get sorting option (by date is the default)

Returns:

sorting option (by date is the default)

sortingStrategy

public final DocumentsFilterDocumentHistoryRequest.Builder sortingStrategy(Number value)

Set sorting option (by date is the default)

Parameters:

value - sorting option (by date is the default)

Returns:

the Builder object.

editDescription

public final String editDescription()

Get is edit description

Returns:

is edit description

editDescription

public final DocumentsFilterDocumentHistoryRequest.Builder editDescription(String value)

Set is edit description

Parameters:

value - is edit description

Returns:

the Builder object.

call

public final DocumentsFilterDocumentHistoryResponse call()
                                                  throws OnshapeException

Calls filterDocumentHistory method, filter document history

Returns:

Response object

Throws:

OnshapeException - On HTTP or serialization error