org.brapi.v2.model

Class BrAPIMetadata

java.lang.Object

org.brapi.v2.model.BrAPIMetadata

public class BrAPIMetadata
extends Object

Metadata

Constructor Summary

Constructors

Constructor and Description
BrAPIMetadata()

Method Summary

Modifier and Type	Method and Description
BrAPIMetadata	addDatafilesItem(BrAPIDataFile datafilesItem)
BrAPIMetadata	addStatusItem(BrAPIStatus statusItem)
BrAPIMetadata	datafiles(List<BrAPIDataFile> datafiles)
boolean	equals(Object o)
@Valid List<BrAPIDataFile>	getDatafiles() The datafiles contains a list of file URLs and metadata.
@Valid BrAPIPagination	getPagination() Get pagination
@Valid List<BrAPIStatus>	getStatus() The status field contains a list of informational status messages from the server.
int	hashCode()
BrAPIMetadata	pagination(BrAPIPagination pagination)
void	setDatafiles(List<BrAPIDataFile> datafiles)
void	setPagination(BrAPIPagination pagination)
void	setStatus(List<BrAPIStatus> status)
BrAPIMetadata	status(List<BrAPIStatus> status)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

BrAPIMetadata

public BrAPIMetadata()

Method Detail

pagination

public BrAPIMetadata pagination(BrAPIPagination pagination)

getPagination

@Valid
public @Valid BrAPIPagination getPagination()

Get pagination

Returns:

pagination

setPagination

public void setPagination(BrAPIPagination pagination)

datafiles

public BrAPIMetadata datafiles(List<BrAPIDataFile> datafiles)

addDatafilesItem

public BrAPIMetadata addDatafilesItem(BrAPIDataFile datafilesItem)

getDatafiles

@Valid
public @Valid List<BrAPIDataFile> getDatafiles()

The datafiles contains a list of file URLs and metadata. These files contain additional information related to the returned object and can be retrieved by a subsequent call. This could be a supplementary data file, an informational file, the uploaded file where the data originated from, a generated file representing the whole dataset in a particular format, or any other related file.

Returns:

datafiles

setDatafiles

public void setDatafiles(List<BrAPIDataFile> datafiles)

status

public BrAPIMetadata status(List<BrAPIStatus> status)

addStatusItem

public BrAPIMetadata addStatusItem(BrAPIStatus statusItem)

getStatus

@Valid
public @Valid List<BrAPIStatus> getStatus()

The status field contains a list of informational status messages from the server. If no status is reported, an empty list should be returned. See Error Reporting for more information.

Returns:

status

setStatus

public void setStatus(List<BrAPIStatus> status)

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object