io.continual.client.model

Interface ModelReference

public interface ModelReference

Method Summary

Modifier and Type	Method and Description
String	getData() Get the JSON data for an object
Set<ModelRelation>	getInboundRelations() Get relations for an object
Set<ModelRelation>	getInboundRelations(String named) Get relations for an object
Set<ModelRelation>	getOutboundRelations() Get relations for an object
Set<ModelRelation>	getOutboundRelations(String named) Get relations for an object
Set<ModelRelation>	getRelations() Get relations for an object
ModelReference	patchData(String jsonData) Patch (merge) the data stored with the object
ModelReference	putData(String jsonData) Overwrite the data stored with the object
ModelReference	relateFrom(String name, ModelObjectLocator from) Relate this object from the given source object with the given name
ModelReference	relateTo(String name, ModelObjectLocator to) Relate this object to the given target object with the given name

Method Detail

getData

String getData()
        throws ModelClient.ModelServiceException,
               IOException

Get the JSON data for an object

Returns:

JSON data

Throws:

IOException

ModelClient.ModelServiceException

putData

ModelReference putData(String jsonData)
                throws ModelClient.ModelServiceException,
                       IOException

Overwrite the data stored with the object

Parameters:

jsonData -

Returns:

this object

Throws:

IOException

ModelClient.ModelServiceException

patchData

ModelReference patchData(String jsonData)

Patch (merge) the data stored with the object

Parameters:

jsonData -

Returns:

this object

getRelations

Set<ModelRelation> getRelations()

Get relations for an object

Returns:

a set of relations

getInboundRelations

Set<ModelRelation> getInboundRelations()

Get relations for an object

Returns:

a set of relations

getInboundRelations

Set<ModelRelation> getInboundRelations(String named)

Get relations for an object

Parameters:

named -

Returns:

a set of relations

getOutboundRelations

Set<ModelRelation> getOutboundRelations()

Get relations for an object

Returns:

a set of relations

getOutboundRelations

Set<ModelRelation> getOutboundRelations(String named)

Get relations for an object

Parameters:

named -

Returns:

a set of relations

relateTo

ModelReference relateTo(String name,
                        ModelObjectLocator to)

Relate this object to the given target object with the given name

Parameters:

name -

to -

Returns:

this object reference

relateFrom

ModelReference relateFrom(String name,
                          ModelObjectLocator from)

Relate this object from the given source object with the given name

Parameters:

name -

from -

Returns:

this object reference